org.xnio.channels

Class FramedMessageChannel

java.lang.Object

org.xnio.channels.TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

org.xnio.channels.FramedMessageChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, BoundChannel, CloseableChannel, Configurable, ConnectedChannel, ConnectedMessageChannel, MessageChannel, ReadableMessageChannel, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel, WrappedChannel<ConnectedStreamChannel>, WritableMessageChannel

public class FramedMessageChannel
extends TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>
implements ConnectedMessageChannel

A connected message channel providing a SASL-style framing layer over a stream channel where each message is prepended by a four-byte length field.

Author:

David M. Lloyd

Nested Class Summary

Nested classes/interfaces inherited from class org.xnio.channels.TranslatingSuspendableChannel

TranslatingSuspendableChannel.Readiness

Field Summary

Fields inherited from class org.xnio.channels.TranslatingSuspendableChannel

channel

Constructor Summary

Constructors

Constructor and Description
FramedMessageChannel(ConnectedStreamChannel channel, ByteBuffer receiveBuffer, ByteBuffer transmitBuffer) Construct a new instance.
FramedMessageChannel(ConnectedStreamChannel channel, Pooled<ByteBuffer> receiveBuffer, Pooled<ByteBuffer> transmitBuffer) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Base channel close implementation.
boolean	flush() Base implementation which delegates the flush request to the channel.
ConnectedStreamChannel	getChannel() Get the underlying channel.
SocketAddress	getLocalAddress() Get the local address that this channel is bound to.
<A extends SocketAddress> A	getLocalAddress(Class<A> type) Get the local address of a given type, or null if the address is not of that type.
SocketAddress	getPeerAddress() Get the peer address of this channel.
<A extends SocketAddress> A	getPeerAddress(Class<A> type) Get the peer address of a given type, or null if the address is not of that type.
protected Object	getReadLock() Get the object to use as a read lock.
protected Object	getWriteLock() Get the object to use as a write lock.
protected TranslatingSuspendableChannel.Readiness	isReadable() Determine whether this channel is known to be (or to not be) readable.
protected TranslatingSuspendableChannel.Readiness	isWritable() Determine whether this channel is known to be (or to not be) writable.
int	receive(ByteBuffer buffer) Receive a message.
long	receive(ByteBuffer[] buffers) Receive a message.
long	receive(ByteBuffer[] buffers, int offs, int len) Receive a message.
boolean	send(ByteBuffer buffer) Send a complete message.
boolean	send(ByteBuffer[] buffers) Send a complete message.
boolean	send(ByteBuffer[] buffers, int offs, int len) Send a complete message.
void	shutdownReads() Base implementation method which simply delegates the shutdown request to the delegate channel.
boolean	shutdownWrites() Base implementation method which simply delegates the shutdown request to the delegate channel.

Methods inherited from class org.xnio.channels.TranslatingSuspendableChannel

awaitReadable, awaitReadable, awaitWritable, awaitWritable, getCloseSetter, getOption, getReadSetter, getReadThread, getWorker, getWriteSetter, getWriteThread, handleReadable, handleWritable, isOpen, isReadResumed, isWriteResumed, resumeReads, resumeReadsIfRequested, resumeReadsIfRequestedAndSuspendWrites, resumeWrites, resumeWritesIfRequested, resumeWritesIfRequestedAndSuspendReads, setOption, supportsOption, suspendReads, suspendWrites, thisTyped, toString, wakeupReads, wakeupReadsIfRequested, wakeupWrites, wakeupWritesIfRequested

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xnio.channels.ConnectedMessageChannel

getCloseSetter, getReadSetter, getWriteSetter

Methods inherited from interface org.xnio.channels.SuspendableReadChannel

awaitReadable, awaitReadable, getReadThread, isReadResumed, resumeReads, suspendReads, wakeupReads

Methods inherited from interface org.xnio.channels.SuspendableWriteChannel

awaitWritable, awaitWritable, getWriteThread, isWriteResumed, resumeWrites, suspendWrites, wakeupWrites

Methods inherited from interface org.xnio.channels.CloseableChannel

getWorker

Methods inherited from interface java.nio.channels.Channel

isOpen

Methods inherited from interface org.xnio.channels.Configurable

getOption, setOption, supportsOption

Constructor Detail

FramedMessageChannel

public FramedMessageChannel(ConnectedStreamChannel channel,
                    ByteBuffer receiveBuffer,
                    ByteBuffer transmitBuffer)

Construct a new instance.

Parameters:

channel - the channel to wrap

receiveBuffer - the receive buffer (should be direct)

transmitBuffer - the send buffer (should be direct)

FramedMessageChannel

public FramedMessageChannel(ConnectedStreamChannel channel,
                    Pooled<ByteBuffer> receiveBuffer,
                    Pooled<ByteBuffer> transmitBuffer)

Construct a new instance.

Parameters:

channel - the channel to wrap

receiveBuffer - the receive buffer (should be direct)

transmitBuffer - the send buffer (should be direct)

Method Detail

isReadable

protected TranslatingSuspendableChannel.Readiness isReadable()

Determine whether this channel is known to be (or to not be) readable. Called under the read lock.

Specified by:

isReadable in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

the readiness of this channel

getReadLock

protected Object getReadLock()

Get the object to use as a read lock. Ensures that suspend/resume reads is atomic with respect to listener invocation.

Specified by:

getReadLock in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

the read lock

isWritable

protected TranslatingSuspendableChannel.Readiness isWritable()

Determine whether this channel is known to be (or to not be) writable. Called under the write lock.

Specified by:

isWritable in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

the readiness of this channel

getWriteLock

protected Object getWriteLock()

Get the object to use as a write lock. Ensures that suspend/resume writes is atomic with respect to listener invocation.

Specified by:

getWriteLock in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

the write lock

receive

public int receive(ByteBuffer buffer)
            throws IOException

Receive a message.

Specified by:

receive in interface ReadableMessageChannel

Parameters:

buffer - the buffer that will hold the message

Returns:

the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition

Throws:

IOException - if an I/O error occurs

receive

public long receive(ByteBuffer[] buffers)
             throws IOException

Receive a message.

Specified by:

receive in interface ReadableMessageChannel

Parameters:

buffers - the buffers that will hold the message

Returns:

the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition

Throws:

IOException - if an I/O error occurs

receive

public long receive(ByteBuffer[] buffers,
           int offs,
           int len)
             throws IOException

Receive a message.

Specified by:

receive in interface ReadableMessageChannel

Parameters:

buffers - the buffers that will hold the message

offs - the offset into the array of buffers of the first buffer to read into

len - the number of buffers to fill

Returns:

the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition

Throws:

IOException - if an I/O error occurs

shutdownReads

public void shutdownReads()
                   throws IOException

Base implementation method which simply delegates the shutdown request to the delegate channel. Subclasses may override this method and call up to this method as appropriate.

Specified by:

shutdownReads in interface SuspendableReadChannel

Overrides:

shutdownReads in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Throws:

IOException - if an I/O error occurs

send

public boolean send(ByteBuffer buffer)
             throws IOException

Send a complete message.

Specified by:

send in interface WritableMessageChannel

Parameters:

buffer - the message to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

send

public boolean send(ByteBuffer[] buffers)
             throws IOException

Send a complete message.

Specified by:

send in interface WritableMessageChannel

Parameters:

buffers - the buffers holding the message to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

send

public boolean send(ByteBuffer[] buffers,
           int offs,
           int len)
             throws IOException

Send a complete message.

Specified by:

send in interface WritableMessageChannel

Parameters:

buffers - the buffers holding the message to send

offs - the offset into the buffer array of the first buffer

len - the number of buffers that contain data to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

shutdownWrites

public boolean shutdownWrites()
                       throws IOException

Base implementation method which simply delegates the shutdown request to the delegate channel. Subclasses may override this method and call up to this method as appropriate.

Specified by:

shutdownWrites in interface SuspendableWriteChannel

Overrides:

shutdownWrites in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

true if the channel was shut down, or false if the operation would block

Throws:

IOException - if an I/O error occurs

flush

public boolean flush()
              throws IOException

Base implementation which delegates the flush request to the channel. Subclasses should override this method as appropriate.

Specified by:

flush in interface SuspendableWriteChannel

Overrides:

flush in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

true if the flush completed, or false if the operation would block

Throws:

IOException - if an error occurs

close

public void close()
           throws IOException

Base channel close implementation. Delegates to the delegate channel by default.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Overrides:

close in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Throws:

IOException - if an I/O error occurs

getPeerAddress

public SocketAddress getPeerAddress()

Get the peer address of this channel.

Specified by:

getPeerAddress in interface ConnectedChannel

Returns:

the peer address

getPeerAddress

public <A extends SocketAddress> A getPeerAddress(Class<A> type)

Get the peer address of a given type, or null if the address is not of that type.

Specified by:

getPeerAddress in interface ConnectedChannel

Parameters:

type - the address type class

Returns:

the peer address, or null if unknown

getLocalAddress

public SocketAddress getLocalAddress()

Get the local address that this channel is bound to.

Specified by:

getLocalAddress in interface BoundChannel

Returns:

the local address

getLocalAddress

public <A extends SocketAddress> A getLocalAddress(Class<A> type)

Get the local address of a given type, or null if the address is not of that type.

Specified by:

getLocalAddress in interface BoundChannel

Type Parameters:

A - the address type

Parameters:

type - the address type class

Returns:

the local address, or null if unknown

getChannel

public ConnectedStreamChannel getChannel()

Get the underlying channel.

Specified by:

getChannel in interface WrappedChannel<ConnectedStreamChannel>

Overrides:

getChannel in class TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>

Returns:

the underlying channel