org.aredis.net

Class AsyncJavaSocketTransport

java.lang.Object

org.aredis.net.AbstractAsyncSocketTransport

org.aredis.net.AsyncJavaSocketTransport

All Implemented Interfaces:

AsyncSocketTransport, ServerInfo

public class AsyncJavaSocketTransport
extends AbstractAsyncSocketTransport

Java 7 NIO Channel API based default implementation of AsyncSocketTransport.

Author:

suresh

Field Summary

Fields

Modifier and Type	Field and Description
static AsynchronousChannelGroup	channelGroup Channel group used by the AsyncSocketChannels.

Fields inherited from class org.aredis.net.AbstractAsyncSocketTransport

config, connectionStatus, connectionString, host, lastConnectTime, lastUseTime, port, serverIndex, transportFactory

Constructor Summary

Constructors

Constructor and Description
AsyncJavaSocketTransport(String phost, int pport, AsyncSocketTransportFactory ptransportFactory) Creates an AsyncJavaSocketTransport.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the Socket connection.
void	connectInternal(AsyncHandler<Boolean> handler) Connect Method to be implemented by sub-class.
boolean	flush(AsyncHandler<Integer> handler) Flushes bytes in buffer to Socket Output.
static AsynchronousChannelGroup	getChannelGroup()
int	read(OutputStream dest, int maxBytes, AsyncHandler<Integer> handler) Reads atleast 1 byte and a max of upto maxBytes writing bytes read to specified Stream.
boolean	requiresFlush() Whether the Socket Output requires a flush to transfer bytes in buffer.
static void	setChannelGroup(AsynchronousChannelGroup pchannelGroup) Sets a custom channel group.
int	write(byte[] b, int ofs, int len, AsyncHandler<Integer> handler) Writes specified bytes to Output Stream.

Methods inherited from class org.aredis.net.AbstractAsyncSocketTransport

connect, getConfig, getConnectionString, getDownSince, getHost, getPort, getRetryInterval, getServerIndex, getStatus, getTransportFactory, isStale, setConfig, toString, updateConnectionStatus

Methods inherited from class java.lang.Object

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

Field Detail

channelGroup

public static AsynchronousChannelGroup channelGroup

Channel group used by the AsyncSocketChannels. This can be changed before the 1st AsyncJavaSocketTransport is created.

Constructor Detail

AsyncJavaSocketTransport

public AsyncJavaSocketTransport(String phost,
                        int pport,
                        AsyncSocketTransportFactory ptransportFactory)
                         throws IOException

Creates an AsyncJavaSocketTransport.

Parameters:

phost - Server Host

pport - Server Port

ptransportFactory - TransportFactory to be associated with this transport

Throws:

IOException

Method Detail

getChannelGroup

public static AsynchronousChannelGroup getChannelGroup()
                                                throws IOException

Throws:

IOException

setChannelGroup

public static void setChannelGroup(AsynchronousChannelGroup pchannelGroup)

Sets a custom channel group. This should be called before an AsyncJavaSocketTransport object is created.

Parameters:

pchannelGroup - Channel Group to use

connectInternal

public void connectInternal(AsyncHandler<Boolean> handler)

Description copied from class: AbstractAsyncSocketTransport

Connect Method to be implemented by sub-class. The connect implementation in this class calls this to establish the socket connection.

Specified by:

connectInternal in class AbstractAsyncSocketTransport

Parameters:

handler - handler to call when connection is completed

read

public int read(OutputStream dest,
       int maxBytes,
       AsyncHandler<Integer> handler)

Description copied from interface: AsyncSocketTransport

Reads atleast 1 byte and a max of upto maxBytes writing bytes read to specified Stream.

Parameters:

dest - OutputStream to write bytes Read

maxBytes - max Bytes to read

handler - handler to call in case of Async operation

Returns:

0 if Operation will be completed by callback to handler with bytes read or positive value indicating actual bytes read immediately in which case handler will not be called.

write

public int write(byte[] b,
        int ofs,
        int len,
        AsyncHandler<Integer> handler)

Description copied from interface: AsyncSocketTransport

Writes specified bytes to Output Stream.

Parameters:

b - Byte Array containing bytes to write

ofs - offset to write from

len - number of bytes to write

handler - handler to call in case of Async operation. The handler is called after all bytes have been written with the number of bytes actaully transferred to the Socket Output.

Returns:

len if all bytes can be transferred immediately to local buffer in in which case handler will not be called. 0 if it requires an Async operation in which case handler is called on completion with bytes actually transferred to socket Output (The remaining bytes will be in buffer).

requiresFlush

public boolean requiresFlush()

Description copied from interface: AsyncSocketTransport

Whether the Socket Output requires a flush to transfer bytes in buffer.

Returns:

true if flush is required

flush

public boolean flush(AsyncHandler<Integer> handler)

Description copied from interface: AsyncSocketTransport

Flushes bytes in buffer to Socket Output. May require repeated calls.

Parameters:

handler - Callback handler in case flush is required. The handler is called with bytes transferred if further flush call is required or a negative value of -bytes transferred if further flush call is not required.

Returns:

true if flush is required, false if not required in which case handler is not called.

close

public void close()
           throws IOException

Description copied from interface: AsyncSocketTransport

Closes the Socket connection. Can be opened again by calling connect.

Throws:

IOException