org.shared.net

Interface Connection

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

SocketConnection

All Known Implementing Classes:

NioConnection

public interface Connection
extends Closeable

Defines a managed connection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Connection.OperationType An enumeration of the managed operations manipulable by the user.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this connection.
Throwable	getException() Gets the exception that occurred.
Object	getLock() Gets the monitor for enforcing mutual exclusion over operations on this connection.
<V> Future<V>	invoke(Callable<V> c) Executes the given code snippet on this connection's ConnectionManager thread.
boolean	isManagerThread() Gets whether this connection's ConnectionManager thread is the current thread.
int	send(ByteBuffer bb) Sends data to the remote host.
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.
String	toString() Creates a human-readable representation of this connection.

Method Detail

send

int send(ByteBuffer bb)

Sends data to the remote host.

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

void setEnabled(Connection.OperationType type,
              boolean enabled)

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 send(ByteBuffer) method are enabled/disabled.

Parameters:

type - the Connection.OperationType.

enabled - whether the given operation is enabled or disabled.

See Also:

Connection.OperationType

getException

Throwable getException()

Gets the exception that occurred.

setException

void setException(Throwable exception)

Sets the exception and triggers connection closure.

Parameters:

exception - the exception.

See Also:

ConnectionHandler.ClosingType.ERROR

getLock

Object getLock()

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

isManagerThread

boolean isManagerThread()

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

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

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

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

Type Parameters:

V - the result type.

Parameters:

c - the code snippet to execute.

Returns:

a Future for retrieving the Callable result.

close

void close()

Closes this connection.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

toString

String toString()

Creates a human-readable representation of this connection.

Overrides:

toString in class Object