org.shared.net.nio

Class NioConnection

java.lang.Object

org.shared.net.nio.NioConnection

All Implemented Interfaces:

Closeable, AutoCloseable, Future<NioConnection>, EnumStatus<NioConnection.NioConnectionStatus>, EnumType<SourceType>, Source<NioEvent<?>,SourceType>, SourceLocal<NioEvent<?>>, SourceRemote<NioEvent<?>>, Connection, SocketConnection

public class NioConnection
extends Object
implements SocketConnection, EnumStatus<NioConnection.NioConnectionStatus>, Source<NioEvent<?>,SourceType>, Future<NioConnection>

An abstract asynchronous sockets class internally managed by NioManager. Instantiating classes must implement callbacks for receipt of data, connecting, accepting, and error handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NioConnection.NioConnectionStatus An enumeration of connection states.
protected static interface	NioConnection.WriteHandler Defines a handler for outgoing data.

Nested classes/interfaces inherited from interface org.shared.net.Connection

Connection.OperationType

Field Summary

Fields

Modifier and Type	Field and Description
protected NioConnection.WriteHandler	bufferedHandler A NioConnection.WriteHandler used when writes are deferred.
protected Runnable	closingHandler An internal handler for connection closure.
protected Runnable	deferredHandler An internal handler for deferred writes.
protected static int	FLAG_BOUND A bit flag indicating that the connection has been bound.
protected static int	FLAG_CLOSED A bit flag indicating that the connection has been closed.
protected NioConnection.WriteHandler	nullHandler A NioConnection.WriteHandler that forgets all data offered to it.
protected NioConnection.WriteHandler	writeThroughHandler A NioConnection.WriteHandler used when bytes can be written through directly to the underlying transport.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NioConnection(ConnectionHandler<? super NioConnection> handler, int bufferSize, NioManagerThread thread) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning) Does nothing.
void	close() Closes this connection.
protected NioEvent<Integer>	createOpEvent(int mask, boolean enabled) Creates an operation interest change NioEvent that originates from this connection.
protected void	deregisterKey() NioManagerThread call -- Deregisters the underlying SelectionKey.
protected void	doBind() NioManagerThread call -- Finishes connecting/accepting.
protected void	doClose() NioManagerThread call -- Closes this connection.
protected void	doClosing(ConnectionHandler.ClosingType type) NioManagerThread call -- Initiates connection closure.
protected void	doError(Throwable exception) NioManagerThread call -- Sets the exception that occurred.
protected void	doOp(int mask, boolean enabled) NioManagerThread call -- Does an operation interest change.
protected void	doRead() NioManagerThread call -- Does a ready read.
protected void	doWrite() NioManagerThread call -- Does a ready write.
NioConnection	get() Waits until this connection has been initialized.
NioConnection	get(long timeout, TimeUnit unit) Waits until this connection has been initialized.
Throwable	getException() Gets the exception that occurred.
Handler<NioEvent<?>>	getHandler() Gets the Handler that will process incoming Events.
protected SelectionKey	getKey() Gets the SelectionKey.
InetSocketAddress	getLocalAddress() Gets the local address.
Object	getLock() Gets the monitor for enforcing mutual exclusion over operations on this connection.
InetSocketAddress	getRemoteAddress() Gets the remote address.
NioConnection.NioConnectionStatus	getStatus() Gets the status.
protected NioManagerThread	getThread() Gets the NioManagerThread currently servicing this connection.
SourceType	getType() Gets the type.
<V> Future<V>	invoke(Callable<V> c) Executes the given code snippet on this connection's ConnectionManager thread.
boolean	isCancelled() Does nothing.
boolean	isDone() Gets whether this connection has been initialized.
boolean	isManagerThread() Gets whether this connection's ConnectionManager thread is the current thread.
void	onLocal(NioEvent<?> evt) Delivers an Event to the local manifestation.
void	onRemote(NioEvent<?> evt) Delivers an Event to the remote manifestation.
protected void	registerKey(Selector selector, int initialOps) NioManagerThread call -- Registers the underlying SelectionKey.
int	send(ByteBuffer bb) Sends data to the remote host.
protected void	setBufferedHandler() Sets bufferedHandler.
void	setEnabled(Connection.OperationType type, boolean enabled) Enables/disables various managed operations: Connection.OperationType.READ -- The ConnectionHandler.onReceive(ByteBuffer) callback is enabled/disabled.
void	setException(Throwable exception) Sets the exception and triggers connection closure.
void	setHandler(Handler<NioEvent<?>> handler) Sets the Handler that will process incoming Events.
protected void	setNullHandler() Sets nullHandler.
void	setStatus(NioConnection.NioConnectionStatus status) Sets the status.
protected void	setThread(NioManagerThread thread) Sets the NioManagerThread currently servicing this connection.
protected void	setup(SocketChannel channel) NioManagerThread call -- Sets up the SocketChannel behind this connection.
protected void	setWriteThroughHandler() Sets writeThroughHandler.
String	toString() Creates a human-readable representation of this connection.

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_BOUND

protected static final int FLAG_BOUND

A bit flag indicating that the connection has been bound.

See Also:

Constant Field Values

FLAG_CLOSED

protected static final int FLAG_CLOSED

A bit flag indicating that the connection has been closed.

See Also:

Constant Field Values

bufferedHandler

protected final NioConnection.WriteHandler bufferedHandler

A NioConnection.WriteHandler used when writes are deferred. Enqueues data without further action.

writeThroughHandler

protected final NioConnection.WriteHandler writeThroughHandler

A NioConnection.WriteHandler used when bytes can be written through directly to the underlying transport.

nullHandler

protected final NioConnection.WriteHandler nullHandler

A NioConnection.WriteHandler that forgets all data offered to it.

deferredHandler

protected final Runnable deferredHandler

An internal handler for deferred writes.

closingHandler

protected final Runnable closingHandler

An internal handler for connection closure.

Constructor Detail

NioConnection

protected NioConnection(ConnectionHandler<? super NioConnection> handler,
             int bufferSize,
             NioManagerThread thread)

Default constructor.

Parameters:

handler - the ConnectionHandler for callbacks.

bufferSize - the network buffer size.

thread - the NioManagerThread with which this connection will be registered.

Method Detail

send

public int send(ByteBuffer bb)

Description copied from interface: Connection

Sends data to the remote host.

Specified by:

send in interface Connection

Parameters:

bb - the ByteBuffer containing data. It must be in ready-to-read mode.

Returns:

the number of bytes remaining in this connection's write buffer; is greater than 0 if and only if not all bytes could be written out to the network, and have to be stored locally for the time being.

setEnabled

public void setEnabled(Connection.OperationType type,
              boolean enabled)

Description copied from interface: Connection

Enables/disables various managed operations:

• Connection.OperationType.READ -- The ConnectionHandler.onReceive(ByteBuffer) callback is enabled/disabled. With argument true, this method shall guarantee that ConnectionHandler.onReceive(ByteBuffer) will subsequently be called at least once.
• Connection.OperationType.WRITE -- Managed writes of data buffered by the Connection.send(ByteBuffer) method are enabled/disabled.

Specified by:

setEnabled in interface Connection

Parameters:

type - the Connection.OperationType.

enabled - whether the given operation is enabled or disabled.

See Also:

Connection.OperationType

getException

public Throwable getException()

Description copied from interface: Connection

Gets the exception that occurred.

Specified by:

getException in interface Connection

setException

public void setException(Throwable exception)

Description copied from interface: Connection

Sets the exception and triggers connection closure.

Specified by:

setException in interface Connection

Parameters:

exception - the exception.

See Also:

ConnectionHandler.ClosingType.ERROR

getLock

public Object getLock()

Description copied from interface: Connection

Gets the monitor for enforcing mutual exclusion over operations on this connection.

Specified by:

getLock in interface Connection

isManagerThread

public boolean isManagerThread()

Description copied from interface: Connection

Gets whether this connection's ConnectionManager thread is the current thread.

Specified by:

isManagerThread in interface Connection

Returns:

true if and only if this connection's ConnectionManager thread is the current thread. Note: All code where this test returns true are thread-safe with respect to callbacks.

See Also:

Thread.currentThread()

invoke

public <V> Future<V> invoke(Callable<V> c)

Description copied from interface: Connection

Executes the given code snippet on this connection's ConnectionManager thread.

Specified by:

invoke in interface Connection

Type Parameters:

V - the result type.

Parameters:

c - the code snippet to execute.

Returns:

a Future for retrieving the Callable result.

getLocalAddress

public InetSocketAddress getLocalAddress()

Description copied from interface: SocketConnection

Gets the local address.

Specified by:

getLocalAddress in interface SocketConnection

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: SocketConnection

Gets the remote address.

Specified by:

getRemoteAddress in interface SocketConnection

getStatus

public NioConnection.NioConnectionStatus getStatus()

Description copied from interface: EnumStatus

Gets the status.

Specified by:

getStatus in interface EnumStatus<NioConnection.NioConnectionStatus>

setStatus

public void setStatus(NioConnection.NioConnectionStatus status)

Description copied from interface: EnumStatus

Sets the status.

Specified by:

setStatus in interface EnumStatus<NioConnection.NioConnectionStatus>

onLocal

public void onLocal(NioEvent<?> evt)

Description copied from interface: SourceLocal

Delivers an Event to the local manifestation.

Specified by:

onLocal in interface SourceLocal<NioEvent<?>>

get

public NioConnection get()
                  throws InterruptedException,
                         ExecutionException

Waits until this connection has been initialized.

Specified by:

get in interface Future<NioConnection>

Throws:

InterruptedException - when this operation is interrupted.

ExecutionException - when something goes awry.

get

public NioConnection get(long timeout,
                TimeUnit unit)
                  throws InterruptedException,
                         ExecutionException,
                         TimeoutException

Waits until this connection has been initialized.

Specified by:

get in interface Future<NioConnection>

Throws:

InterruptedException - when this operation is interrupted.

ExecutionException - when something goes awry.

TimeoutException - when this operation has timed out.

isDone

public boolean isDone()

Gets whether this connection has been initialized.

Specified by:

isDone in interface Future<NioConnection>

close

public void close()

Description copied from interface: Connection

Closes this connection.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Source<NioEvent<?>,SourceType>

Specified by:

close in interface Connection

toString

public String toString()

Description copied from interface: Connection

Creates a human-readable representation of this connection.

Specified by:

toString in interface Connection

Overrides:

toString in class Object

setNullHandler

protected void setNullHandler()

Sets nullHandler.

setBufferedHandler

protected void setBufferedHandler()

Sets bufferedHandler.

setWriteThroughHandler

protected void setWriteThroughHandler()

Sets writeThroughHandler.

getThread

protected NioManagerThread getThread()

Gets the NioManagerThread currently servicing this connection.

setThread

protected void setThread(NioManagerThread thread)

Sets the NioManagerThread currently servicing this connection.

createOpEvent

protected NioEvent<Integer> createOpEvent(int mask,
                              boolean enabled)

Creates an operation interest change NioEvent that originates from this connection.

getKey

protected SelectionKey getKey()

Gets the SelectionKey.

setup

protected void setup(SocketChannel channel)
              throws IOException

NioManagerThread call -- Sets up the SocketChannel behind this connection.

Throws:

IOException - when something goes awry.

registerKey

protected void registerKey(Selector selector,
               int initialOps)
                    throws IOException

NioManagerThread call -- Registers the underlying SelectionKey.

Throws:

IOException - when something goes awry.

deregisterKey

protected void deregisterKey()

NioManagerThread call -- Deregisters the underlying SelectionKey.

doBind

protected void doBind()

NioManagerThread call -- Finishes connecting/accepting. Does not do own exception handling.

doWrite

protected void doWrite()

NioManagerThread call -- Does a ready write. Does own exception handling.

doRead

protected void doRead()

NioManagerThread call -- Does a ready read. Does own exception handling.

doOp

protected void doOp(int mask,
        boolean enabled)

NioManagerThread call -- Does an operation interest change. Does not do own exception handling.

doClosing

protected void doClosing(ConnectionHandler.ClosingType type)

NioManagerThread call -- Initiates connection closure. Does not do own exception handling.

doError

protected void doError(Throwable exception)

NioManagerThread call -- Sets the exception that occurred. Does not do own exception handling.

doClose

protected void doClose()

NioManagerThread call -- Closes this connection. Does not do own exception handling.

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Does nothing.

Specified by:

cancel in interface Future<NioConnection>

Returns:

false, always.

isCancelled

public boolean isCancelled()

Does nothing.

Specified by:

isCancelled in interface Future<NioConnection>

Returns:

false, always.

getType

public SourceType getType()

Description copied from interface: EnumType

Gets the type.

Specified by:

getType in interface EnumType<SourceType>

getHandler

public Handler<NioEvent<?>> getHandler()

Description copied from interface: Source

Gets the Handler that will process incoming Events.

Specified by:

getHandler in interface Source<NioEvent<?>,SourceType>

setHandler

public void setHandler(Handler<NioEvent<?>> handler)

Description copied from interface: Source

Sets the Handler that will process incoming Events.

Specified by:

setHandler in interface Source<NioEvent<?>,SourceType>

onRemote

public void onRemote(NioEvent<?> evt)

Description copied from interface: SourceRemote

Delivers an Event to the remote manifestation.

Specified by:

onRemote in interface SourceRemote<NioEvent<?>>