org.jboss.remoting3

Class LocalChannel

java.lang.Object

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

org.jboss.remoting3.LocalChannel

All Implemented Interfaces:

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

final class LocalChannel
extends AbstractHandleableCloseable<Channel>
implements Channel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	LocalChannel.In
(package private) static class	LocalChannel.Out

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	bufferSize
private boolean	closed
private ConnectionHandlerContext	connectionHandlerContext
private java.lang.Object	lock
private Channel.Receiver	messageHandler
private java.util.Queue<LocalChannel.In>	messageQueue
private LocalChannel	otherSide
private int	queueLength

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
LocalChannel(java.util.concurrent.Executor executor, ConnectionHandlerContext connectionHandlerContext)
LocalChannel(java.util.concurrent.Executor executor, LocalChannel otherSide, ConnectionHandlerContext connectionHandlerContext)

Method Summary

Modifier and Type	Method and Description
protected void	closeAction() Called exactly once when the close() method is invoked; the actual close operation should take place here.
private void	executeEndTask(Channel.Receiver handler)
private void	executeMessageTask(Channel.Receiver handler, LocalChannel.In in)
Attachments	getAttachments() Get the attachments for this entity.
Connection	getConnection() Get the connection associated with this channel.
<T> T	getOption(org.xnio.Option<T> option) Get the value of a channel option.
(package private) LocalChannel	getOtherSide()
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.
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, toString, 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

attachments

private final Attachments attachments

otherSide

private final LocalChannel otherSide

connectionHandlerContext

private final ConnectionHandlerContext connectionHandlerContext

messageQueue

private final java.util.Queue<LocalChannel.In> messageQueue

lock

private final java.lang.Object lock

queueLength

private final int queueLength

bufferSize

private final int bufferSize

messageHandler

private Channel.Receiver messageHandler

closed

private boolean closed

Constructor Detail

LocalChannel

LocalChannel(java.util.concurrent.Executor executor,
             LocalChannel otherSide,
             ConnectionHandlerContext connectionHandlerContext)

LocalChannel

LocalChannel(java.util.concurrent.Executor executor,
             ConnectionHandlerContext connectionHandlerContext)

Method Detail

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

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

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

executeEndTask

private void executeEndTask(Channel.Receiver handler)

executeMessageTask

private void executeMessageTask(Channel.Receiver handler,
                                LocalChannel.In in)

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

getOtherSide

LocalChannel getOtherSide()