org.jboss.remoting3.remote

Class RemoteConnectionChannel

java.lang.Object

org.jboss.remoting3.spi.AbstractHandleableCloseable<Channel>

org.jboss.remoting3.remote.RemoteConnectionChannel

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Attachable, Channel, HandleableCloseable<Channel>, org.xnio.channels.Configurable

final class RemoteConnectionChannel
extends AbstractHandleableCloseable<Channel>
implements Channel

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.remoting3.Channel

Channel.Receiver

Nested classes/interfaces inherited from interface org.jboss.remoting3.HandleableCloseable

HandleableCloseable.Key

Field Summary

Fields

Modifier and Type	Field and Description
private Attachments	attachments
private int	channelId
private int	channelState
private static java.util.concurrent.atomic.AtomicIntegerFieldUpdater<RemoteConnectionChannel>	channelStateUpdater
private RemoteConnection	connection
private RemoteConnectionHandler	connectionHandler
private ConnectionHandlerContext	connectionHandlerContext
private static int	INBOUND_MESSAGES_MASK
private java.util.Queue<InboundMessage>	inboundMessageQueue
private IntIndexMap<InboundMessage>	inboundMessages
private int	inboundWindow
(package private) static IntIndexer<RemoteConnectionChannel>	INDEXER
private int	maxInboundMessages
private long	maxInboundMessageSize
private int	maxOutboundMessages
private long	maxOutboundMessageSize
private Channel.Receiver	nextReceiver
private static int	ONE_INBOUND_MESSAGE
private static int	ONE_OUTBOUND_MESSAGE
private static int	OUTBOUND_MESSAGES_MASK
private IntIndexMap<OutboundMessage>	outboundMessages
private int	outboundWindow
private static int	READ_CLOSED
private static java.util.Set<org.xnio.Option<?>>	SUPPORTED_OPTIONS
private static int	WRITE_CLOSED

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
RemoteConnectionChannel(RemoteConnectionHandler connectionHandler, RemoteConnection connection, int channelId, int outboundWindow, int inboundWindow, int maxOutboundMessages, int maxInboundMessages, long maxOutboundMessageSize, long maxInboundMessageSize)

Method Summary

Modifier and Type	Method and Description
(package private) org.xnio.Pooled<java.nio.ByteBuffer>	allocate(byte protoId)
private void	asyncCloseMessage(int id)
private boolean	casState(int oldState, int newState)
protected void	closeAction() Called exactly once when the close() method is invoked; the actual close operation should take place here.
(package private) void	closeInboundMessage()
private void	closeMessages()
(package private) void	closeOutboundMessage()
(package private) void	closeReads()
(package private) boolean	closeReadsAndWrites()
(package private) boolean	closeWrites()
(package private) void	dumpState(java.lang.StringBuilder b)
(package private) void	free(OutboundMessage outboundMessage)
(package private) void	freeInboundMessage(short id)
Attachments	getAttachments() Get the attachments for this entity.
(package private) int	getChannelId()
Connection	getConnection() Get the connection associated with this channel.
(package private) RemoteConnectionHandler	getConnectionHandler()
<T> T	getOption(org.xnio.Option<T> option) Get the value of a channel option.
(package private) RemoteConnection	getRemoteConnection()
(package private) void	handleAsyncClose(org.xnio.Pooled<java.nio.ByteBuffer> pooled)
(package private) void	handleIncomingWriteShutdown()
(package private) void	handleMessageData(org.xnio.Pooled<java.nio.ByteBuffer> message)
(package private) void	handleRemoteClose()
(package private) void	handleWindowOpen(org.xnio.Pooled<java.nio.ByteBuffer> pooled)
private int	incrementState(int count)
private void	notifyEnd()
(package private) boolean	openInboundMessage()
(package private) void	openOutboundMessage()
void	receiveMessage(Channel.Receiver handler) Initiate processing of the next message, when it comes in.
<T> T	setOption(org.xnio.Option<T> option, T value) Set an option for this channel.
boolean	supportsOption(org.xnio.Option<?> option) Determine whether an option is supported on this channel.
java.lang.String	toString()
private void	unregister()
MessageOutputStream	writeMessage() Write a new message on to this channel, blocking if necessary.
void	writeShutdown() Send an end-of-messages signal to the remote side.

Methods inherited from class org.jboss.remoting3.spi.AbstractHandleableCloseable

addCloseHandler, awaitClosed, awaitClosedUninterruptibly, checkOpen, close, closeAsync, closeComplete, closeFailed, finalize, getExecutor, isOpen

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.remoting3.Channel

close

Methods inherited from interface org.jboss.remoting3.HandleableCloseable

addCloseHandler, awaitClosed, awaitClosedUninterruptibly, closeAsync

Field Detail

INDEXER

static final IntIndexer<RemoteConnectionChannel> INDEXER

connectionHandler

private final RemoteConnectionHandler connectionHandler

connectionHandlerContext

private final ConnectionHandlerContext connectionHandlerContext

connection

private final RemoteConnection connection

channelId

private final int channelId

outboundMessages

private final IntIndexMap<OutboundMessage> outboundMessages

inboundMessages

private final IntIndexMap<InboundMessage> inboundMessages

outboundWindow

private final int outboundWindow

inboundWindow

private final int inboundWindow

attachments

private final Attachments attachments

inboundMessageQueue

private final java.util.Queue<InboundMessage> inboundMessageQueue

maxOutboundMessages

private final int maxOutboundMessages

maxInboundMessages

private final int maxInboundMessages

maxOutboundMessageSize

private final long maxOutboundMessageSize

maxInboundMessageSize

private final long maxInboundMessageSize

channelState

private volatile int channelState

channelStateUpdater

private static final java.util.concurrent.atomic.AtomicIntegerFieldUpdater<RemoteConnectionChannel> channelStateUpdater

nextReceiver

private Channel.Receiver nextReceiver

WRITE_CLOSED

private static final int WRITE_CLOSED

See Also:

Constant Field Values

READ_CLOSED

private static final int READ_CLOSED

See Also:

Constant Field Values

OUTBOUND_MESSAGES_MASK

private static final int OUTBOUND_MESSAGES_MASK

See Also:

Constant Field Values

ONE_OUTBOUND_MESSAGE

private static final int ONE_OUTBOUND_MESSAGE

See Also:

Constant Field Values

INBOUND_MESSAGES_MASK

private static final int INBOUND_MESSAGES_MASK

See Also:

Constant Field Values

ONE_INBOUND_MESSAGE

private static final int ONE_INBOUND_MESSAGE

See Also:

Constant Field Values

SUPPORTED_OPTIONS

private static java.util.Set<org.xnio.Option<?>> SUPPORTED_OPTIONS

Constructor Detail

RemoteConnectionChannel

RemoteConnectionChannel(RemoteConnectionHandler connectionHandler,
                        RemoteConnection connection,
                        int channelId,
                        int outboundWindow,
                        int inboundWindow,
                        int maxOutboundMessages,
                        int maxInboundMessages,
                        long maxOutboundMessageSize,
                        long maxInboundMessageSize)

Method Detail

openOutboundMessage

void openOutboundMessage()
                  throws java.io.IOException

Throws:

java.io.IOException

incrementState

private int incrementState(int count)

casState

private boolean casState(int oldState,
                         int newState)

closeOutboundMessage

void closeOutboundMessage()

openInboundMessage

boolean openInboundMessage()

closeInboundMessage

void closeInboundMessage()

closeReads

void closeReads()

closeWrites

boolean closeWrites()

closeReadsAndWrites

boolean closeReadsAndWrites()

notifyEnd

private void notifyEnd()

unregister

private void unregister()

writeMessage

public MessageOutputStream writeMessage()
                                 throws java.io.IOException

Description copied from interface: Channel

Write a new message on to this channel, blocking if necessary.

Specified by:

writeMessage in interface Channel

Returns:

the outbound message to send

Throws:

java.io.IOException - if a new message cannot be written

free

void free(OutboundMessage outboundMessage)

writeShutdown

public void writeShutdown()
                   throws java.io.IOException

Description copied from interface: Channel

Send an end-of-messages signal to the remote side. No more messages may be written after this method is called; however, more incoming messages may be received.

Specified by:

writeShutdown in interface Channel

Throws:

java.io.IOException - if the message could not be written

handleRemoteClose

void handleRemoteClose()

handleIncomingWriteShutdown

void handleIncomingWriteShutdown()

receiveMessage

public void receiveMessage(Channel.Receiver handler)

Description copied from interface: Channel

Initiate processing of the next message, when it comes in. This method does not block; instead the handler is called asynchronously (possibly in another thread) if/when the next message arrives.

Specified by:

receiveMessage in interface Channel

Parameters:

handler - the handler for the next incoming message

supportsOption

public boolean supportsOption(org.xnio.Option<?> option)

Description copied from interface: Channel

Determine whether an option is supported on this channel.

Specified by:

supportsOption in interface Channel

Specified by:

supportsOption in interface org.xnio.channels.Configurable

Parameters:

option - the option

Returns:

true if it is supported

getOption

public <T> T getOption(org.xnio.Option<T> option)

Description copied from interface: Channel

Get the value of a channel option.

Specified by:

getOption in interface Channel

Specified by:

getOption in interface org.xnio.channels.Configurable

Type Parameters:

T - the type of the option value

Parameters:

option - the option to get

Returns:

the value of the option, or null if it is not set

setOption

public <T> T setOption(org.xnio.Option<T> option,
                       T value)
                throws java.lang.IllegalArgumentException

Description copied from interface: Channel

Set an option for this channel. Unsupported options are ignored.

Specified by:

setOption in interface Channel

Specified by:

setOption in interface org.xnio.channels.Configurable

Type Parameters:

T - the type of the option value

Parameters:

option - the option to set

value - the value of the option to set

Returns:

the previous option value, if any

Throws:

java.lang.IllegalArgumentException - if the value is not acceptable for this option

handleMessageData

void handleMessageData(org.xnio.Pooled<java.nio.ByteBuffer> message)

asyncCloseMessage

private void asyncCloseMessage(int id)

handleWindowOpen

void handleWindowOpen(org.xnio.Pooled<java.nio.ByteBuffer> pooled)

handleAsyncClose

void handleAsyncClose(org.xnio.Pooled<java.nio.ByteBuffer> pooled)

getAttachments

public Attachments getAttachments()

Description copied from interface: Attachable

Get the attachments for this entity.

Specified by:

getAttachments in interface Attachable

Returns:

the attachments

getConnection

public Connection getConnection()

Description copied from interface: Channel

Get the connection associated with this channel.

Specified by:

getConnection in interface Channel

Returns:

the connection

closeAction

protected void closeAction()
                    throws java.io.IOException

Description copied from class: AbstractHandleableCloseable

Called exactly once when the close() method is invoked; the actual close operation should take place here. This method must call AbstractHandleableCloseable.closeComplete(), directly or indirectly, for the close operation to finish (it may happen in another thread but it must happen). This method should not expect the AbstractHandleableCloseable.closeComplete() call to be made from another thread from the same thread pool that may cause AbstractHandleableCloseable.close(). As close will block, this can result in situations where all threads in the pool are blocked on AbstractHandleableCloseable.close() method calls, which means the AbstractHandleableCloseable.closeComplete() will never be run.

Overrides:

closeAction in class AbstractHandleableCloseable<Channel>

Throws:

RemotingException - if the close failed

java.io.IOException

closeMessages

private void closeMessages()

getRemoteConnection

RemoteConnection getRemoteConnection()

getConnectionHandler

RemoteConnectionHandler getConnectionHandler()

getChannelId

int getChannelId()

freeInboundMessage

void freeInboundMessage(short id)

allocate

org.xnio.Pooled<java.nio.ByteBuffer> allocate(byte protoId)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dumpState

void dumpState(java.lang.StringBuilder b)