com.schooner.MemCached

Class SchoonerSockIOPool.TCPSockIO

java.lang.Object

com.whalin.MemCached.SockIOPool.SockIO

com.schooner.MemCached.SchoonerSockIO

com.schooner.MemCached.SchoonerSockIOPool.TCPSockIO

All Implemented Interfaces:

LineInputStream

Enclosing class:

SchoonerSockIOPool

public static class SchoonerSockIOPool.TCPSockIO
extends SchoonerSockIO

MemCached Java client, utility class for Socket IO. This class is a wrapper around a Socket and its streams.

Version:

1.5

Author:

greg whalin , Richard 'toast' Russo

Field Summary

Fields

Modifier and Type	Field and Description
SocketChannel	sockChannel

Fields inherited from class com.schooner.MemCached.SchoonerSockIO

readBuf, sockets, writeBuf

Constructor Summary

Constructors

Constructor and Description
SchoonerSockIOPool.TCPSockIO(org.apache.commons.pool.impl.GenericObjectPool sockets, String host, int bufferSize, int timeout, int connectTimeout, boolean noDelay) creates a new SockIO object wrapping a socket connection to host:port, and its input and output streams

Method Summary

Methods

Modifier and Type	Method and Description
void	clearEOL() reads up to end of line and returns nothing
void	close() sets closed flag and checks in to connection pool but does not close connections
protected void	finalize() Hack to reap any leaking children.
void	flush() writes data stored in writeBuf to server
ByteChannel	getByteChannel() get byte channel from this socket.
SocketChannel	getChannel() Lets caller get access to underlying channel.
String	getHost() returns the host this socket is connected to
byte[]	getResponse(short rid)
protected static Socket	getSocket(String host, int port, int timeout) Method which gets a connection from SocketChannel.
int	hashCode() use the sockets hashcode for this object so we can key off of SockIOs
boolean	isConnected() checks if the connection is open
short	preWrite()
int	read(byte[] b) reads length bytes into the passed in byte array from dtream
void	readBytes(int length) read fix length data from server and store it in the readBuf
String	readLine() reads a line intentionally not using the deprecated readLine method from DataInputStream
String	toString() returns the string representation of this socket
void	trueClose() closes socket and all streams connected to it
void	trueClose(boolean addToDeadPool) closes socket and all streams connected to it
void	write(byte[] b) writes a byte array to the output stream

Methods inherited from class com.schooner.MemCached.SchoonerSockIO

getBufferSize, isAlive, setBufferSize

Methods inherited from class java.lang.Object

clone, equals, getClass, notify, notifyAll, wait, wait, wait

Field Detail

sockChannel

public SocketChannel sockChannel

Constructor Detail

SchoonerSockIOPool.TCPSockIO

public SchoonerSockIOPool.TCPSockIO(org.apache.commons.pool.impl.GenericObjectPool sockets,
                            String host,
                            int bufferSize,
                            int timeout,
                            int connectTimeout,
                            boolean noDelay)
                             throws IOException,
                                    UnknownHostException

creates a new SockIO object wrapping a socket connection to host:port, and its input and output streams

Parameters:

host - hostname:port

timeout - read timeout value for connected socket

connectTimeout - timeout for initial connections

noDelay - TCP NODELAY option?

Throws:

IOException - if an io error occurrs when creating socket

UnknownHostException - if hostname is invalid

Method Detail

getSocket

protected static final Socket getSocket(String host,
               int port,
               int timeout)
                                 throws IOException

Method which gets a connection from SocketChannel.

Parameters:

host - host to establish connection to

port - port on that host

timeout - connection timeout in ms

Returns:

connected socket

Throws:

IOException - if errors connecting or if connection times out

getChannel

public final SocketChannel getChannel()

Lets caller get access to underlying channel.

Overrides:

getChannel in class SockIOPool.SockIO

Returns:

the backing SocketChannel

getHost

public final String getHost()

returns the host this socket is connected to

Overrides:

getHost in class SockIOPool.SockIO

Returns:

String representation of host (hostname:port)

trueClose

public final void trueClose()
                     throws IOException

closes socket and all streams connected to it

Overrides:

trueClose in class SockIOPool.SockIO

Throws:

IOException - if fails to close streams or socket

close

public final void close()

sets closed flag and checks in to connection pool but does not close connections

Overrides:

close in class SockIOPool.SockIO

isConnected

public boolean isConnected()

checks if the connection is open

Overrides:

isConnected in class SockIOPool.SockIO

Returns:

true if connected

readBytes

public final void readBytes(int length)
                     throws IOException

read fix length data from server and store it in the readBuf

Parameters:

length - data length

Throws:

IOException - if an io error happens

write

public void write(byte[] b)
           throws IOException

writes a byte array to the output stream

Overrides:

write in class SockIOPool.SockIO

Parameters:

b - byte array to write

Throws:

IOException - if an io error happens

flush

public void flush()
           throws IOException

writes data stored in writeBuf to server

Overrides:

flush in class SockIOPool.SockIO

Throws:

IOException - if an io error happens

hashCode

public final int hashCode()

use the sockets hashcode for this object so we can key off of SockIOs

Overrides:

hashCode in class SockIOPool.SockIO

Returns:

int hashcode

toString

public final String toString()

returns the string representation of this socket

Overrides:

toString in class SockIOPool.SockIO

Returns:

string

finalize

protected final void finalize()
                       throws Throwable

Hack to reap any leaking children.

Overrides:

finalize in class SockIOPool.SockIO

Throws:

Throwable

preWrite

public short preWrite()

Specified by:

preWrite in class SchoonerSockIO

getResponse

public byte[] getResponse(short rid)
                   throws IOException

Specified by:

getResponse in class SchoonerSockIO

Throws:

IOException

clearEOL

public void clearEOL()
              throws IOException

Description copied from class: SockIOPool.SockIO

reads up to end of line and returns nothing

Specified by:

clearEOL in interface LineInputStream

Overrides:

clearEOL in class SockIOPool.SockIO

Throws:

IOException - if io problems during read

read

public int read(byte[] b)
         throws IOException

Description copied from class: SockIOPool.SockIO

reads length bytes into the passed in byte array from dtream

Specified by:

read in interface LineInputStream

Overrides:

read in class SockIOPool.SockIO

Parameters:

b - byte array

Returns:

The number of bytes actually read, or -1 if none could be read.

Throws:

IOException - if io problems during read

readLine

public String readLine()
                throws IOException

Description copied from class: SockIOPool.SockIO

reads a line intentionally not using the deprecated readLine method from DataInputStream

Specified by:

readLine in interface LineInputStream

Overrides:

readLine in class SockIOPool.SockIO

Returns:

String that was read in

Throws:

IOException - if io problems during read

trueClose

public void trueClose(boolean addToDeadPool)
               throws IOException

Description copied from class: SockIOPool.SockIO

closes socket and all streams connected to it

Overrides:

trueClose in class SockIOPool.SockIO

Throws:

IOException - if fails to close streams or socket

getByteChannel

public ByteChannel getByteChannel()

Description copied from class: SchoonerSockIO

get byte channel from this socket.

Specified by:

getByteChannel in class SchoonerSockIO

Returns:

the backing SocketChannel