org.apache.activemq.artemis.spi.core.protocol

## Class AbstractRemotingConnection

- java.lang.Object
- - org.apache.activemq.artemis.spi.core.protocol.AbstractRemotingConnection

- All Implemented Interfaces:
    RemotingConnection, BufferHandler

      public abstract class AbstractRemotingConnection
      extends Object
      implements RemotingConnection

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected List<org.apache.activemq.artemis.core.remoting.CloseListener>` | `closeListeners`
    `protected long` | `creationTime`
    `protected boolean` | `dataReceived`
    `protected Executor` | `executor`
    `protected List<org.apache.activemq.artemis.core.remoting.FailureListener>` | `failureListeners`
    `protected Connection` | `transportConnection`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AbstractRemotingConnection(Connection transportConnection, Executor executor)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addCloseListener(org.apache.activemq.artemis.core.remoting.CloseListener listener)` add a CloseListener.
    `void` | `addFailureListener(org.apache.activemq.artemis.core.remoting.FailureListener listener)` add a failure listener.
    `void` | `bufferReceived(Object connectionID, ActiveMQBuffer buffer)` called by the remoting connection when a buffer is received.
    `protected void` | `callClosingListeners()`
    `protected void` | `callFailureListeners(ActiveMQException me, String scaleDownTargetNodeID)`
    `boolean` | `checkDataReceived()` returns true if any data has been received since the last time this method was called.
    `ActiveMQBuffer` | `createTransportBuffer(int size)` creates a new ActiveMQBuffer of the specified size.
    `void` | `fail(ActiveMQException me)` called when the underlying connection fails.
    `long` | `getCreationTime()` Returns the creation time of the `RemotingConnection`.
    `List<org.apache.activemq.artemis.core.remoting.FailureListener>` | `getFailureListeners()` return all the failure listeners
    `Object` | `getID()` Returns the unique id of the `RemotingConnection`.
    `String` | `getRemoteAddress()` returns a string representation of the remote address of this connection
    `Connection` | `getTransportConnection()` return the underlying Connection.
    `boolean` | `removeCloseListener(org.apache.activemq.artemis.core.remoting.CloseListener listener)` remove a Close Listener
    `List<org.apache.activemq.artemis.core.remoting.CloseListener>` | `removeCloseListeners()`
    `boolean` | `removeFailureListener(org.apache.activemq.artemis.core.remoting.FailureListener listener)` remove the failure listener
    `List<org.apache.activemq.artemis.core.remoting.FailureListener>` | `removeFailureListeners()`
    `void` | `setCloseListeners(List<org.apache.activemq.artemis.core.remoting.CloseListener> listeners)`
    `void` | `setFailureListeners(List<org.apache.activemq.artemis.core.remoting.FailureListener> listeners)` set the failure listeners.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface org.apache.activemq.artemis.spi.core.protocol.RemotingConnection

      `destroy, disconnect, disconnect, fail, flush, isClient, isDestroyed`

- - ### Field Detail

    - #### failureListeners

          protected final List<org.apache.activemq.artemis.core.remoting.FailureListener> failureListeners

    - #### closeListeners

          protected final List<org.apache.activemq.artemis.core.remoting.CloseListener> closeListeners

    - #### transportConnection

          protected final Connection transportConnection

    - #### executor

          protected final Executor executor

    - #### creationTime

          protected final long creationTime

    - #### dataReceived

          protected volatile boolean dataReceived

  - ### Constructor Detail

    - #### AbstractRemotingConnection

          public AbstractRemotingConnection(Connection transportConnection,
                                            Executor executor)

  - ### Method Detail

    - #### getFailureListeners

          public List<org.apache.activemq.artemis.core.remoting.FailureListener> getFailureListeners()

      Description copied from interface: `RemotingConnection`
      return all the failure listeners
      Specified by:
        `getFailureListeners` in interface `RemotingConnection`
      Returns:
        the listeners

    - #### callFailureListeners

          protected void callFailureListeners(ActiveMQException me,
                                              String scaleDownTargetNodeID)

    - #### callClosingListeners

          protected void callClosingListeners()

    - #### setFailureListeners

          public void setFailureListeners(List<org.apache.activemq.artemis.core.remoting.FailureListener> listeners)

      Description copied from interface: `RemotingConnection`
      set the failure listeners.

      These will be called in the event of the connection being closed. Any previosuly added listeners will be removed.

      Specified by:
        `setFailureListeners` in interface `RemotingConnection`
      Parameters:
        `listeners` - the listeners to add.

    - #### getID

          public Object getID()

      Description copied from interface: `RemotingConnection`
      Returns the unique id of the `RemotingConnection`.
      Specified by:
        `getID` in interface `RemotingConnection`
      Returns:
        the id

    - #### getRemoteAddress

          public String getRemoteAddress()

      Description copied from interface: `RemotingConnection`
      returns a string representation of the remote address of this connection
      Specified by:
        `getRemoteAddress` in interface `RemotingConnection`
      Returns:
        the remote address

    - #### addFailureListener

          public void addFailureListener(org.apache.activemq.artemis.core.remoting.FailureListener listener)

      Description copied from interface: `RemotingConnection`
      add a failure listener.

      The listener will be called in the event of connection failure.

      Specified by:
        `addFailureListener` in interface `RemotingConnection`
      Parameters:
        `listener` - the listener

    - #### removeFailureListener

          public boolean removeFailureListener(org.apache.activemq.artemis.core.remoting.FailureListener listener)

      Description copied from interface: `RemotingConnection`
      remove the failure listener
      Specified by:
        `removeFailureListener` in interface `RemotingConnection`
      Parameters:
        `listener` - the lister to remove
      Returns:
        true if removed

    - #### addCloseListener

          public void addCloseListener(org.apache.activemq.artemis.core.remoting.CloseListener listener)

      Description copied from interface: `RemotingConnection`
      add a CloseListener.

      This will be called in the event of the connection being closed.

      Specified by:
        `addCloseListener` in interface `RemotingConnection`
      Parameters:
        `listener` - the listener to add

    - #### removeCloseListener

          public boolean removeCloseListener(org.apache.activemq.artemis.core.remoting.CloseListener listener)

      Description copied from interface: `RemotingConnection`
      remove a Close Listener
      Specified by:
        `removeCloseListener` in interface `RemotingConnection`
      Parameters:
        `listener` - the listener to remove
      Returns:
        true if removed

    - #### removeCloseListeners

          public List<org.apache.activemq.artemis.core.remoting.CloseListener> removeCloseListeners()

      Specified by:
        `removeCloseListeners` in interface `RemotingConnection`

    - #### removeFailureListeners

          public List<org.apache.activemq.artemis.core.remoting.FailureListener> removeFailureListeners()

      Specified by:
        `removeFailureListeners` in interface `RemotingConnection`

    - #### setCloseListeners

          public void setCloseListeners(List<org.apache.activemq.artemis.core.remoting.CloseListener> listeners)

      Specified by:
        `setCloseListeners` in interface `RemotingConnection`

    - #### createTransportBuffer

          public ActiveMQBuffer createTransportBuffer(int size)

      Description copied from interface: `RemotingConnection`
      creates a new ActiveMQBuffer of the specified size. For the purpose of i/o outgoing packets
      Specified by:
        `createTransportBuffer` in interface `RemotingConnection`
      Parameters:
        `size` - the size of buffer required
      Returns:
        the buffer

    - #### getTransportConnection

          public Connection getTransportConnection()

      Description copied from interface: `RemotingConnection`
      return the underlying Connection.
      Specified by:
        `getTransportConnection` in interface `RemotingConnection`
      Returns:
        the connection

    - #### getCreationTime

          public long getCreationTime()

      Description copied from interface: `RemotingConnection`
      Returns the creation time of the `RemotingConnection`.
      Specified by:
        `getCreationTime` in interface `RemotingConnection`

    - #### checkDataReceived

          public boolean checkDataReceived()

      Description copied from interface: `RemotingConnection`
      returns true if any data has been received since the last time this method was called.
      Specified by:
        `checkDataReceived` in interface `RemotingConnection`
      Returns:
        true if data has been received.

    - #### fail

          public void fail(ActiveMQException me)

      Description copied from interface: `RemotingConnection`
      called when the underlying connection fails.
      Specified by:
        `fail` in interface `RemotingConnection`
      Parameters:
        `me` - the exception that caused the failure

    - #### bufferReceived

          public void bufferReceived(Object connectionID,
                                     ActiveMQBuffer buffer)

      Description copied from interface: `BufferHandler`
      called by the remoting connection when a buffer is received.
      Specified by:
        `bufferReceived` in interface `BufferHandler`
      Parameters:
        `connectionID` - the connection the buffer was received on
        `buffer` - the buffer to decode

Copyright © 2015 The Apache Software Foundation. All rights reserved.