StompConnection (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.hornetq.core.protocol.stomp.StompConnection

All Implemented Interfaces:

RemotingConnection, BufferHandler
```
public class StompConnection
extends Object
implements RemotingConnection
```
A StompConnection

Author:

Jeff Mesnil

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCloseListener(CloseListener listener)` add a CloseListener.
`void`	`addFailureListener(FailureListener listener)` add a failure listener.
`void`	`bufferReceived(Object connectionID, HornetQBuffer buffer)` called by the remoting connection when a buffer is received.
`boolean`	`checkDataReceived()` returns true if any data has been received since the last time this method was called.
`HornetQBuffer`	`createBuffer(int size)` creates a new HornetQBuffer of the specified size.
`void`	`destroy()` destroys this connection.
`void`	`disconnect(boolean criticalError)` Disconnect the connection, closing all channels
`boolean`	`enableMessageID()`
`void`	`fail(HornetQException me)` called when the underlying connection fails.
`void`	`flush()` flush all outstanding data from the connection.
`String`	`getClientID()`
`long`	`getCreationTime()` Returns the creation time of the Remoting connection
`StompDecoder`	`getDecoder()`
`List<FailureListener>`	`getFailureListeners()` return all the failure listeners
`Object`	`getID()` returns the unique id of the Remoting Connection
`String`	`getLogin()`
`String`	`getPasscode()`
`String`	`getRemoteAddress()` returns a string representation of the remote address of this connection
`Connection`	`getTransportConnection()` return the underlying Connection.
`boolean`	`isClient()` returns whether or not the Remoting Connection is a client
`boolean`	`isDestroyed()` returns true if this Remoting Connection has been destroyed.
`boolean`	`isValid()`
`boolean`	`removeCloseListener(CloseListener listener)` remove a Close Listener
`List<CloseListener>`	`removeCloseListeners()`
`boolean`	`removeFailureListener(FailureListener listener)` remove the failure listener
`List<FailureListener>`	`removeFailureListeners()`
`void`	`setClientID(String clientID)`
`void`	`setCloseListeners(List<CloseListener> listeners)`
`void`	`setDataReceived()`
`void`	`setFailureListeners(List<FailureListener> listeners)` set the failure listeners.
`void`	`setLogin(String login)`
`void`	`setPasscode(String passcode)`
`void`	`setValid(boolean valid)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDecoder
```
public StompDecoder getDecoder()
```
  - addFailureListener
```
public void addFailureListener(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(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(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(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<CloseListener> removeCloseListeners()
```
    Specified by:
    
    removeCloseListeners in interface RemotingConnection
  - removeFailureListeners
```
public List<FailureListener> removeFailureListeners()
```
    Specified by:
    
    removeFailureListeners in interface RemotingConnection
  - setCloseListeners
```
public void setCloseListeners(List<CloseListener> listeners)
```
    Specified by:
    
    setCloseListeners in interface RemotingConnection
  - setFailureListeners
```
public void setFailureListeners(List<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.
  - setDataReceived
```
public void setDataReceived()
```
  - 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.
  - createBuffer
```
public HornetQBuffer createBuffer(int size)
```
    Description copied from interface: RemotingConnection
    
    creates a new HornetQBuffer of the specified size.
    
    Specified by:
    
    createBuffer in interface RemotingConnection
    
    Parameters:
    size - the size of buffer required
    
    Returns:
    the buffer
  - destroy
```
public void destroy()
```
    Description copied from interface: RemotingConnection
    
    destroys this connection.
    
    Specified by:
    
    destroy in interface RemotingConnection
  - disconnect
```
public void disconnect(boolean criticalError)
```
    Description copied from interface: RemotingConnection
    
    Disconnect the connection, closing all channels
    
    Specified by:
    
    disconnect in interface RemotingConnection
  - fail
```
public void fail(HornetQException 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
  - flush
```
public void flush()
```
    Description copied from interface: RemotingConnection
    
    flush all outstanding data from the connection.
    
    Specified by:
    
    flush in interface RemotingConnection
  - getFailureListeners
```
public List<FailureListener> getFailureListeners()
```
    Description copied from interface: RemotingConnection
    
    return all the failure listeners
    
    Specified by:
    
    getFailureListeners in interface RemotingConnection
    
    Returns:
    the listeners
  - getID
```
public Object getID()
```
    Description copied from interface: RemotingConnection
    
    returns the unique id of the Remoting Connection
    
    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
  - getCreationTime
```
public long getCreationTime()
```
    Description copied from interface: RemotingConnection
    
    Returns the creation time of the Remoting connection
    
    Specified by:
    
    getCreationTime in interface RemotingConnection
  - getTransportConnection
```
public Connection getTransportConnection()
```
    Description copied from interface: RemotingConnection
    
    return the underlying Connection.
    
    Specified by:
    
    getTransportConnection in interface RemotingConnection
    
    Returns:
    the connection
  - isClient
```
public boolean isClient()
```
    Description copied from interface: RemotingConnection
    
    returns whether or not the Remoting Connection is a client
    
    Specified by:
    
    isClient in interface RemotingConnection
    
    Returns:
    true if client, false if a server
  - isDestroyed
```
public boolean isDestroyed()
```
    Description copied from interface: RemotingConnection
    
    returns true if this Remoting Connection has been destroyed.
    
    Specified by:
    
    isDestroyed in interface RemotingConnection
    
    Returns:
    true if destroyed, otherwise false
  - bufferReceived
```
public void bufferReceived(Object connectionID,
                  HornetQBuffer 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
  - setLogin
```
public void setLogin(String login)
```
  - getLogin
```
public String getLogin()
```
  - setPasscode
```
public void setPasscode(String passcode)
```
  - getPasscode
```
public String getPasscode()
```
  - setClientID
```
public void setClientID(String clientID)
```
  - getClientID
```
public String getClientID()
```
  - isValid
```
public boolean isValid()
```
  - setValid
```
public void setValid(boolean valid)
```
  - enableMessageID
```
public boolean enableMessageID()
```

Class StompConnection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDecoder

addFailureListener

removeFailureListener

addCloseListener

removeCloseListener

removeCloseListeners

removeFailureListeners

setCloseListeners

setFailureListeners

setDataReceived

checkDataReceived

createBuffer

destroy

disconnect

fail

flush

getFailureListeners

getID

getRemoteAddress

getCreationTime

getTransportConnection

isClient

isDestroyed

bufferReceived

setLogin

getLogin

setPasscode

getPasscode

setClientID

getClientID

isValid

setValid

enableMessageID