org.apache.qpid.jms.transports.netty

Class NettyTcpTransport

java.lang.Object

org.apache.qpid.jms.transports.netty.NettyTcpTransport

All Implemented Interfaces:

Transport

Direct Known Subclasses:

NettySslTransport

public class NettyTcpTransport
extends Object
implements Transport

TCP based transport that uses Netty as the underlying IO layer.

Field Summary

Fields

Modifier and Type	Field and Description
protected io.netty.bootstrap.Bootstrap	bootstrap
protected io.netty.channel.Channel	channel
protected io.netty.channel.EventLoopGroup	group
protected TransportListener	listener
protected TransportOptions	options
protected URI	remote

Constructor Summary

Constructors

Constructor and Description
NettyTcpTransport(TransportListener listener, URI remoteLocation, TransportOptions options) Create a new transport instance
NettyTcpTransport(URI remoteLocation, TransportOptions options) Create a new transport instance

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	allocateSendBuffer(int size) Request that the Transport provide an output buffer sized for the given value.
void	close() Close the Transport, no additional send operations are accepted.
protected void	configureChannel(io.netty.channel.Channel channel)
protected void	configureNetty(io.netty.bootstrap.Bootstrap bootstrap, TransportOptions options)
void	connect() Performs the protocol connect operation for the implemented Transport type such as a TCP socket connection etc.
protected void	connectionEstablished(io.netty.channel.Channel connectedChannel) Called when the transport has successfully connected and is ready for use.
protected void	connectionFailed(io.netty.channel.Channel failedChannel, IOException cause) Called when the transport connection failed and an error should be returned.
protected String	getRemoteHost()
URI	getRemoteLocation()
protected int	getRemotePort()
TransportListener	getTransportListener() Gets the currently set TransportListener instance
TransportOptions	getTransportOptions()
protected void	handleConnected(io.netty.channel.Channel channel)
boolean	isConnected()
void	send(io.netty.buffer.ByteBuf output) Sends a chunk of data over the Transport connection.
void	setTransportListener(TransportListener listener) Sets the Transport Listener instance that will be notified of incoming data or error events.

Methods inherited from class java.lang.Object

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

Field Detail

bootstrap

protected io.netty.bootstrap.Bootstrap bootstrap

group

protected io.netty.channel.EventLoopGroup group

channel

protected io.netty.channel.Channel channel

listener

protected TransportListener listener

options

protected TransportOptions options

remote

protected final URI remote

Constructor Detail

NettyTcpTransport

public NettyTcpTransport(URI remoteLocation,
                 TransportOptions options)

Create a new transport instance

Parameters:

remoteLocation - the URI that defines the remote resource to connect to.

options - the transport options used to configure the socket connection.

NettyTcpTransport

public NettyTcpTransport(TransportListener listener,
                 URI remoteLocation,
                 TransportOptions options)

Create a new transport instance

Parameters:

listener - the TransportListener that will receive events from this Transport.

remoteLocation - the URI that defines the remote resource to connect to.

options - the transport options used to configure the socket connection.

Method Detail

connect

public void connect()
             throws IOException

Description copied from interface: Transport

Performs the protocol connect operation for the implemented Transport type such as a TCP socket connection etc.

Specified by:

connect in interface Transport

Throws:

IOException - if an error occurs while attempting the connect.

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Transport

Returns:

true if transport is connected or false if the connection is down.

close

public void close()
           throws IOException

Description copied from interface: Transport

Close the Transport, no additional send operations are accepted.

Specified by:

close in interface Transport

Throws:

IOException - if an error occurs while closing the connection.

allocateSendBuffer

public io.netty.buffer.ByteBuf allocateSendBuffer(int size)
                                           throws IOException

Description copied from interface: Transport

Request that the Transport provide an output buffer sized for the given value.

Specified by:

allocateSendBuffer in interface Transport

Parameters:

size - the size necessary to hold the outgoing bytes.

Returns:

a new ByteBuf allocated for sends operations.

Throws:

IOException - if an error occurs while allocating the send buffer.

send

public void send(io.netty.buffer.ByteBuf output)
          throws IOException

Description copied from interface: Transport

Sends a chunk of data over the Transport connection.

Specified by:

send in interface Transport

Parameters:

output - The buffer of data that is to be transmitted.

Throws:

IOException - if an error occurs during the send operation.

getTransportListener

public TransportListener getTransportListener()

Description copied from interface: Transport

Gets the currently set TransportListener instance

Specified by:

getTransportListener in interface Transport

Returns:

the current TransportListener or null if none set.

setTransportListener

public void setTransportListener(TransportListener listener)

Description copied from interface: Transport

Sets the Transport Listener instance that will be notified of incoming data or error events.

Specified by:

setTransportListener in interface Transport

Parameters:

listener - The new TransportListener instance to use (cannot be null).

getTransportOptions

public TransportOptions getTransportOptions()

Specified by:

getTransportOptions in interface Transport

Returns:

the TransportOptions instance that holds the configuration for this Transport.

getRemoteLocation

public URI getRemoteLocation()

Specified by:

getRemoteLocation in interface Transport

Returns:

the URI of the remote peer that this Transport connects to.

getRemoteHost

protected String getRemoteHost()

getRemotePort

protected int getRemotePort()

configureNetty

protected void configureNetty(io.netty.bootstrap.Bootstrap bootstrap,
                  TransportOptions options)

configureChannel

protected void configureChannel(io.netty.channel.Channel channel)
                         throws Exception

Throws:

Exception

handleConnected

protected void handleConnected(io.netty.channel.Channel channel)
                        throws Exception

Throws:

Exception

connectionEstablished

protected void connectionEstablished(io.netty.channel.Channel connectedChannel)

Called when the transport has successfully connected and is ready for use.

connectionFailed

protected void connectionFailed(io.netty.channel.Channel failedChannel,
                    IOException cause)

Called when the transport connection failed and an error should be returned.

Parameters:

failedChannel - The Channel instance that failed.

cause - An IOException that describes the cause of the failed connection.