Package net.timewalker.ffmq4.transport.tcp.nio

Class NIOTcpPacketTransport

java.lang.Object

net.timewalker.ffmq4.transport.AbstractPacketTransport

net.timewalker.ffmq4.transport.tcp.AbstractTcpPacketTransport

net.timewalker.ffmq4.transport.tcp.nio.NIOTcpPacketTransport

All Implemented Interfaces:

PacketTransport, NIOClientSocketHandler

public final class NIOTcpPacketTransport
extends AbstractTcpPacketTransport
implements NIOClientSocketHandler

NIOTcpPacketTransport

Field Summary

Fields

Modifier and Type	Field	Description
protected long	lastRecvActivity
protected long	lastSendActivity
protected static org.apache.commons.logging.Log	log

Fields inherited from class net.timewalker.ffmq4.transport.tcp.AbstractTcpPacketTransport

initialPacketBufferSize, pingInterval, sendQueueMaxSize, socketRecvBufferSize, socketSendBufferSize, streamRecvBufferSize, streamSendBufferSize

Fields inherited from class net.timewalker.ffmq4.transport.AbstractPacketTransport

client, closed, closeLock, id, listener

Constructor Summary

Constructors

Constructor	Description
NIOTcpPacketTransport(String id, NIOTcpMultiplexer multiplexer, URI transportURI, Settings settings)	Constructor
NIOTcpPacketTransport(String id, NIOTcpMultiplexer multiplexer, SocketChannel socketChannel, Settings settings)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	appendOutgoingData()	Append some outgoing data to the output buffer
void	close()	Stop and close the transport layer
protected void	closeTransport(boolean linkFailed)
ByteBuffer	getInputBuffer()	Get this client's input buffer
ByteBuffer	getOutputBuffer()	Get this client's output buffer
SocketAddress	getRemotePeer()	Get the remote peer address
SocketChannel	getSocketChannel()	Get the associated socket channel
boolean	handleIncomingData()	Process incoming data available in the input buffer
boolean	hasWriteInterest()	Test if this client has things to sends
boolean	needsThrottling()	Test if send operation should be throttled down to avoid send queue overflow
void	onSocketChannelClosed()	Called if the multiplexer closes the socket channel after a network error
void	send(AbstractPacket packet)	Send a packet on this transport
void	start()	Start the transport layer

Methods inherited from class net.timewalker.ffmq4.transport.tcp.AbstractTcpPacketTransport

getRemotePeerID

Methods inherited from class net.timewalker.ffmq4.transport.AbstractPacketTransport

getId, isClosed, setListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.timewalker.ffmq4.transport.tcp.nio.NIOClientSocketHandler

getId

Field Detail

log

protected static final org.apache.commons.logging.Log log

lastSendActivity

protected long lastSendActivity

lastRecvActivity

protected long lastRecvActivity

Constructor Detail

NIOTcpPacketTransport

public NIOTcpPacketTransport(String id,
                             NIOTcpMultiplexer multiplexer,
                             URI transportURI,
                             Settings settings)
                      throws PacketTransportException

Constructor

Throws:

PacketTransportException

NIOTcpPacketTransport

public NIOTcpPacketTransport(String id,
                             NIOTcpMultiplexer multiplexer,
                             SocketChannel socketChannel,
                             Settings settings)

Constructor

Method Detail

getRemotePeer

public SocketAddress getRemotePeer()

Description copied from class: AbstractTcpPacketTransport

Get the remote peer address

Specified by:

getRemotePeer in class AbstractTcpPacketTransport

Returns:

the remote peer address (may return null if not available)

getInputBuffer

public ByteBuffer getInputBuffer()

Description copied from interface: NIOClientSocketHandler

Get this client's input buffer

Specified by:

getInputBuffer in interface NIOClientSocketHandler

Returns:

this client's input buffer

getOutputBuffer

public ByteBuffer getOutputBuffer()

Description copied from interface: NIOClientSocketHandler

Get this client's output buffer

Specified by:

getOutputBuffer in interface NIOClientSocketHandler

Returns:

this client's output buffer

getSocketChannel

public SocketChannel getSocketChannel()

Description copied from interface: NIOClientSocketHandler

Get the associated socket channel

Specified by:

getSocketChannel in interface NIOClientSocketHandler

Returns:

the associated socket channel

handleIncomingData

public boolean handleIncomingData()

Description copied from interface: NIOClientSocketHandler

Process incoming data available in the input buffer

Specified by:

handleIncomingData in interface NIOClientSocketHandler

Returns:

false on error causing the multiplexer to drop the client handler

appendOutgoingData

public boolean appendOutgoingData()

Description copied from interface: NIOClientSocketHandler

Append some outgoing data to the output buffer

Specified by:

appendOutgoingData in interface NIOClientSocketHandler

Returns:

false on error causing the multiplexer to drop the client handler

hasWriteInterest

public boolean hasWriteInterest()

Description copied from interface: NIOClientSocketHandler

Test if this client has things to sends

Specified by:

hasWriteInterest in interface NIOClientSocketHandler

Returns:

true if this client has things to sends

send

public void send(AbstractPacket packet)
          throws PacketTransportException

Description copied from interface: PacketTransport

Send a packet on this transport

Specified by:

send in interface PacketTransport

Throws:

PacketTransportException

needsThrottling

public boolean needsThrottling()

Description copied from interface: PacketTransport

Test if send operation should be throttled down to avoid send queue overflow

Specified by:

needsThrottling in interface PacketTransport

start

public void start()
           throws PacketTransportException

Description copied from interface: PacketTransport

Start the transport layer

Specified by:

start in interface PacketTransport

Throws:

PacketTransportException

closeTransport

protected void closeTransport(boolean linkFailed)

onSocketChannelClosed

public void onSocketChannelClosed()

Description copied from interface: NIOClientSocketHandler

Called if the multiplexer closes the socket channel after a network error

Specified by:

onSocketChannelClosed in interface NIOClientSocketHandler

close

public void close()

Description copied from interface: PacketTransport

Stop and close the transport layer

Specified by:

close in interface PacketTransport