org.hornetq.core.protocol.core.impl

Class RemotingConnectionImpl

java.lang.Object

org.hornetq.core.protocol.core.impl.RemotingConnectionImpl

All Implemented Interfaces:

CoreRemotingConnection, RemotingConnection, BufferHandler

public class RemotingConnectionImpl
extends Object
implements CoreRemotingConnection

Author:

Tim Fox, Jeff Mesnil

Constructor Summary

Constructors

Constructor and Description
RemotingConnectionImpl(PacketDecoder packetDecoder, Connection transportConnection, long blockingCallTimeout, long blockingCallFailoverTimeout, List<Interceptor> incomingInterceptors, List<Interceptor> outgoingInterceptors)

Method Summary

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	createTransportBuffer(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
void	fail(HornetQException me) called when the underlying connection fails.
void	flush() flush all outstanding data from the connection.
long	generateChannelID() generate a unique (within this connection) channel id
long	getBlockingCallFailoverTimeout() Returns the current timeout for blocking calls
long	getBlockingCallTimeout() Returns the current timeout for blocking calls
Channel	getChannel(long channelID, int confWindowSize) Returns the channel with the channel id specified.
String	getClientID()
int	getClientVersion() The client protocol used on the communication.
long	getCreationTime() Returns the creation time of the RemotingConnection.
HornetQPrincipal	getDefaultHornetQPrincipal() Returns the default security principal
List<FailureListener>	getFailureListeners() return all the failure listeners
Object	getID() Returns the unique id of the RemotingConnection.
long	getIDGeneratorSequence() Returns the next id to be chosen.
String	getRemoteAddress() returns a string representation of the remote address of this connection
Object	getTransferLock() Returns the transfer lock used when transferring connections.
Connection	getTransportConnection() return the underlying Connection.
boolean	isClient() Returns whether or not the RemotingConnection is a client
boolean	isDestroyed() Returns true if this RemotingConnection has been destroyed.
void	putChannel(long channelID, Channel channel) add the channel with the specified channel id
boolean	removeChannel(long channelID) remove the channel with the specified channel id
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 cID)
void	setClientVersion(int clientVersion) Sets the client protocol used on the communication.
void	setCloseListeners(List<CloseListener> listeners)
void	setFailureListeners(List<FailureListener> listeners) set the failure listeners.
void	syncIDGeneratorSequence(long id) Resets the id generator used to generate id's.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RemotingConnectionImpl

public RemotingConnectionImpl(PacketDecoder packetDecoder,
                              Connection transportConnection,
                              long blockingCallTimeout,
                              long blockingCallFailoverTimeout,
                              List<Interceptor> incomingInterceptors,
                              List<Interceptor> outgoingInterceptors)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getTransportConnection

public Connection getTransportConnection()

Description copied from interface: RemotingConnection

return the underlying Connection.

Specified by:

getTransportConnection in interface RemotingConnection

Returns:

the connection

getFailureListeners

public List<FailureListener> getFailureListeners()

Description copied from interface: RemotingConnection

return all the failure listeners

Specified by:

getFailureListeners in interface RemotingConnection

Returns:

the listeners

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.

getClientVersion

public int getClientVersion()

Description copied from interface: CoreRemotingConnection

The client protocol used on the communication. This will determine if the client has support for certain packet types

Specified by:

getClientVersion in interface CoreRemotingConnection

Returns:

the clientVersion

setClientVersion

public void setClientVersion(int clientVersion)

Description copied from interface: CoreRemotingConnection

Sets the client protocol used on the communication. This will determine if the client has support for certain packet types

Specified by:

setClientVersion in interface CoreRemotingConnection

Parameters:

clientVersion - the clientVersion to set

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

getCreationTime

public long getCreationTime()

Description copied from interface: RemotingConnection

Returns the creation time of the RemotingConnection.

Specified by:

getCreationTime in interface RemotingConnection

getChannel

public Channel getChannel(long channelID,
                          int confWindowSize)

Description copied from interface: CoreRemotingConnection

Returns the channel with the channel id specified.

If it does not exist create it with the confirmation window size.

Specified by:

getChannel in interface CoreRemotingConnection

Parameters:

channelID - the channel id

confWindowSize - the confirmation window size

Returns:

the channel

removeChannel

public boolean removeChannel(long channelID)

Description copied from interface: CoreRemotingConnection

remove the channel with the specified channel id

Specified by:

removeChannel in interface CoreRemotingConnection

Parameters:

channelID - the channel id

Returns:

true if removed

putChannel

public void putChannel(long channelID,
                       Channel channel)

Description copied from interface: CoreRemotingConnection

add the channel with the specified channel id

Specified by:

putChannel in interface CoreRemotingConnection

Parameters:

channelID - the channel id

channel - the channel

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

createTransportBuffer

public HornetQBuffer createTransportBuffer(int size)

Description copied from interface: RemotingConnection

creates a new HornetQBuffer of the specified size. For the purpose of transfering packets

Specified by:

createTransportBuffer in interface RemotingConnection

Parameters:

size - the size of buffer required

Returns:

the buffer

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

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

generateChannelID

public long generateChannelID()

Description copied from interface: CoreRemotingConnection

generate a unique (within this connection) channel id

Specified by:

generateChannelID in interface CoreRemotingConnection

Returns:

the id

syncIDGeneratorSequence

public void syncIDGeneratorSequence(long id)

Description copied from interface: CoreRemotingConnection

Resets the id generator used to generate id's.

Specified by:

syncIDGeneratorSequence in interface CoreRemotingConnection

Parameters:

id - the first id to set it to

getIDGeneratorSequence

public long getIDGeneratorSequence()

Description copied from interface: CoreRemotingConnection

Returns the next id to be chosen.

Specified by:

getIDGeneratorSequence in interface CoreRemotingConnection

Returns:

the id

getTransferLock

public Object getTransferLock()

Description copied from interface: CoreRemotingConnection

Returns the transfer lock used when transferring connections.

Specified by:

getTransferLock in interface CoreRemotingConnection

Returns:

the lock

isClient

public boolean isClient()

Description copied from interface: RemotingConnection

Returns whether or not the RemotingConnection 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 RemotingConnection has been destroyed.

Specified by:

isDestroyed in interface RemotingConnection

Returns:

true if destroyed, otherwise false

getBlockingCallTimeout

public long getBlockingCallTimeout()

Description copied from interface: CoreRemotingConnection

Returns the current timeout for blocking calls

Specified by:

getBlockingCallTimeout in interface CoreRemotingConnection

Returns:

the timeout in milliseconds

getBlockingCallFailoverTimeout

public long getBlockingCallFailoverTimeout()

Description copied from interface: CoreRemotingConnection

Returns the current timeout for blocking calls

Specified by:

getBlockingCallFailoverTimeout in interface CoreRemotingConnection

Returns:

the timeout in milliseconds

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.

flush

public void flush()

Description copied from interface: RemotingConnection

flush all outstanding data from the connection.

Specified by:

flush in interface RemotingConnection

getDefaultHornetQPrincipal

public HornetQPrincipal getDefaultHornetQPrincipal()

Description copied from interface: CoreRemotingConnection

Returns the default security principal

Specified by:

getDefaultHornetQPrincipal in interface CoreRemotingConnection

Returns:

the principal

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

setClientID

public void setClientID(String cID)

getClientID

public String getClientID()