com.sun.grizzly
Interface ConnectorHandler<E extends SelectorHandler,P extends CallbackHandler>

All Superinterfaces:

AsyncQueueReadable, AsyncQueueWritable, java.io.Closeable, Handler

All Known Implementing Classes:

AbstractConnectorHandler, CacheableConnectorHandler, SSLConnectorHandler, TCPConnectorHandler, UDPConnectorHandler

public interface ConnectorHandler<E extends SelectorHandler,P extends CallbackHandler>
extends Handler, java.io.Closeable, AsyncQueueWritable, AsyncQueueReadable

Client side interface used to implement non blocking client operation. Implementation of this class must make sure the following methods are invoked in that order: (1) connect() (2) read() or write().

Author:

Jeanfrancois Arcand

Method Summary

void	close() Close the underlying connection.
void	connect(java.net.SocketAddress remoteAddress) Connect to hostname:port.
void	connect(java.net.SocketAddress remoteAddress, P callbackHandler) Connect to hostname:port.
void	connect(java.net.SocketAddress remoteAddress, P callbackHandler, E e) Connect to hostname:port.
void	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress) Connect to hostname:port.
void	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, P callbackHandler) Connect to hostname:port.
void	connect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, P callbackHandler, E e) Connect to hostname:port.
void	finishConnect(java.nio.channels.SelectionKey key) Decide how the OP_CONNECT final steps are handled.
P	getCallbackHandler() Returns ConnectorHandler's callback handler instance, which is used to process occuring events
Controller	getController() Return the Controller
E	getSelectorHandler() Method returns SelectorHandler, which manages this ConnectorHandler
java.nio.channels.SelectableChannel	getUnderlyingChannel() Method returns ConnectorHandler's underlying channel
boolean	isConnected() Is the underlying channel connected.
Controller.Protocol	protocol() A token decribing the protocol supported by an implementation of this interface
long	read(java.nio.ByteBuffer byteBuffer, boolean blocking) Read bytes.
void	setCallbackHandler(P callbackHandler) Sets ConnectorHandler's callback handler instance, which is used to process occuring events
void	setController(Controller controller) Set the Controller associated with this instance.
long	write(java.nio.ByteBuffer byteBuffer, boolean blocking) Writes bytes.

Methods inherited from interface com.sun.grizzly.async.AsyncQueueWritable

writeToAsyncQueue, writeToAsyncQueue, writeToAsyncQueue, writeToAsyncQueue, writeToAsyncQueue, writeToAsyncQueue, writeToAsyncQueue, writeToAsyncQueue

Methods inherited from interface com.sun.grizzly.async.AsyncQueueReadable

readFromAsyncQueue, readFromAsyncQueue, readFromAsyncQueue

Method Detail

protocol

Controller.Protocol protocol()

A token decribing the protocol supported by an implementation of this interface

Returns:

Controller.Protocol

connect

void connect(java.net.SocketAddress remoteAddress,
             P callbackHandler,
             E e)
             throws java.io.IOException

Connect to hostname:port. When an aysnchronous event happens (e.g OP_READ or OP_WRITE), the Controller will invoke the CallBackHandler.

Parameters:

remoteAddress - remote address to connect

callbackHandler - the handler invoked by the Controller when an non blocking operation is ready to be handled.

e - SelectorHandler

Throws:

java.io.IOException

connect

void connect(java.net.SocketAddress remoteAddress,
             P callbackHandler)
             throws java.io.IOException

Connect to hostname:port. When an aysnchronous event happens (e.g OP_READ or OP_WRITE), the Controller will invoke the CallBackHandler.

Parameters:

remoteAddress - remote address to connect

callbackHandler - the handler invoked by the Controller when an non blocking operation is ready to be handled.

Throws:

java.io.IOException

connect

void connect(java.net.SocketAddress remoteAddress)
             throws java.io.IOException

Connect to hostname:port. Internally an instance of Controller and its default SelectorHandler will be created everytime this method is called. This method should be used only and only if no external Controller has been initialized.

Parameters:

remoteAddress - remote address to connect

Throws:

java.io.IOException

connect

void connect(java.net.SocketAddress remoteAddress,
             java.net.SocketAddress localAddress,
             P callbackHandler,
             E e)
             throws java.io.IOException

Connect to hostname:port. When an aysnchronous event happens (e.g OP_READ or OP_WRITE), the Controller will invoke the CallBackHandler.

Parameters:

remoteAddress - remote address to connect

localAddress - local address to bind

callbackHandler - the handler invoked by the Controller when an non blocking operation is ready to be handled.

e - SelectorHandler

Throws:

java.io.IOException

connect

void connect(java.net.SocketAddress remoteAddress,
             java.net.SocketAddress localAddress,
             P callbackHandler)
             throws java.io.IOException

Connect to hostname:port. When an aysnchronous event happens (e.g OP_READ or OP_WRITE), the Controller will invoke the CallBackHandler.

Parameters:

remoteAddress - remote address to connect

localAddress - local address to bind

callbackHandler - the handler invoked by the Controller when an non blocking operation is ready to be handled.

Throws:

java.io.IOException

connect

void connect(java.net.SocketAddress remoteAddress,
             java.net.SocketAddress localAddress)
             throws java.io.IOException

Connect to hostname:port. Internally an instance of Controller and its default SelectorHandler will be created everytime this method is called. This method should be used only and only if no external Controller has been initialized.

Parameters:

remoteAddress - remote address to connect

localAddress - local address to bind

Throws:

java.io.IOException

read

long read(java.nio.ByteBuffer byteBuffer,
          boolean blocking)
          throws java.io.IOException

Read bytes. If blocking is set to true, a pool of temporary Selector will be used to read bytes.

Parameters:

byteBuffer - The byteBuffer to store bytes.

blocking - true if a a pool of temporary Selector is required to handle a blocking read.

Returns:

number of bytes read

Throws:

java.io.IOException

write

long write(java.nio.ByteBuffer byteBuffer,
           boolean blocking)
           throws java.io.IOException

Writes bytes. If blocking is set to true, a pool of temporary Selector will be used to writes bytes.

Parameters:

byteBuffer - The byteBuffer to write.

blocking - true if a a pool of temporary Selector is required to handle a blocking write.

Returns:

number of bytes written

Throws:

java.io.IOException

close

void close()
           throws java.io.IOException

Close the underlying connection.

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

finishConnect

void finishConnect(java.nio.channels.SelectionKey key)
                   throws java.io.IOException

Decide how the OP_CONNECT final steps are handled.

Parameters:

key - SelectionKey

Throws:

java.io.IOException

setController

void setController(Controller controller)

Set the Controller associated with this instance.

Parameters:

controller - Controller

getController

Controller getController()

Return the Controller

Returns:

getSelectorHandler

E getSelectorHandler()

Method returns SelectorHandler, which manages this ConnectorHandler

Returns:

SelectorHandler

getUnderlyingChannel

java.nio.channels.SelectableChannel getUnderlyingChannel()

Method returns ConnectorHandler's underlying channel

Returns:

channel

getCallbackHandler

P getCallbackHandler()

Returns ConnectorHandler's callback handler instance, which is used to process occuring events

Returns:

callback handler

setCallbackHandler

void setCallbackHandler(P callbackHandler)

Sets ConnectorHandler's callback handler instance, which is used to process occuring events

Parameters:

callbackHandler - handler

isConnected

boolean isConnected()

Is the underlying channel connected.

Returns:

true if connected, otherwise false