com.go.trove.net
Class PlainSocketFactory

java.lang.Object
  |
  +--com.go.trove.net.PlainSocketFactory

All Implemented Interfaces:

SocketFactory

public class PlainSocketFactory

extends java.lang.Object

implements SocketFactory

Allows client socket connections to be established with a timeout. Calling getSocket will always return a new socket, and recycle will always close the socket. Sessions are ignored on all requests.

Version:

6 , 00/12/05

Author:

Brian S O'Neill

Constructor Summary

PlainSocketFactory(java.net.InetAddress addr, int port, long timeout)

Method Summary

void	clear() Closes all recycled connections, but does not prevent new connections from being created and recycled.
CheckedSocket	createSocket() Must always return a new socket connection.
CheckedSocket	createSocket(long timeout) Returns a new socket connection.
CheckedSocket	createSocket(java.lang.Object session) Returns a new socket connection.
CheckedSocket	createSocket(java.lang.Object session, long timeout) Returns a new socket connection.
int	getAvailableCount() Returns the number of recycled sockets currently available.
long	getDefaultTimeout() Returns the default timeout for creating or getting sockets or -1 if infinite.
InetAddressAndPort	getInetAddressAndPort() Returns the InetAddress and port that this factory will most likely connect to.
InetAddressAndPort	getInetAddressAndPort(java.lang.Object session) Returns the InetAddress and port that this factory will most likely connect to.
CheckedSocket	getSocket() Returns a new or recycled socket connection.
CheckedSocket	getSocket(long timeout) Returns a new or recycled socket connection.
CheckedSocket	getSocket(java.lang.Object session) Returns a new or recycled socket connection.
CheckedSocket	getSocket(java.lang.Object session, long timeout) Returns a new or recycled socket connection.
void	recycleSocket(CheckedSocket socket) Recycle a socket connection that was returned from the getSocket or createSocket methods.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainSocketFactory

public PlainSocketFactory(java.net.InetAddress addr,
                          int port,
                          long timeout)

Parameters:

addr - Address to connect new sockets to.

port - Port to connect new sockets to.

timeout - Maximum time to wait (in milliseconds) for new connections to be established before throwing an exception

Method Detail

getInetAddressAndPort

public InetAddressAndPort getInetAddressAndPort()

Description copied from interface: SocketFactory

Returns the InetAddress and port that this factory will most likely connect to. If the address isn't precisely known, its value is 0.0.0.0. If the port isn't known, its value is -1.

Specified by:

getInetAddressAndPort in interface SocketFactory

getInetAddressAndPort

public InetAddressAndPort getInetAddressAndPort(java.lang.Object session)

Description copied from interface: SocketFactory

Returns the InetAddress and port that this factory will most likely connect to. If the address isn't precisely known, its value is 0.0.0.0. If the port isn't known, its value is -1.

Specified by:

getInetAddressAndPort in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

session - Object whose hashcode might be used to select a specific connection if factory is distributed. If null, then no session is used.

getDefaultTimeout

public long getDefaultTimeout()

Description copied from interface: SocketFactory

Returns the default timeout for creating or getting sockets or -1 if infinite.

Specified by:

getDefaultTimeout in interface SocketFactory

createSocket

public CheckedSocket createSocket()
                           throws java.net.ConnectException,
                                  java.net.SocketException

Description copied from interface: SocketFactory

Must always return a new socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

createSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

createSocket

public CheckedSocket createSocket(java.lang.Object session)
                           throws java.net.ConnectException,
                                  java.net.SocketException

Description copied from interface: SocketFactory

Returns a new socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

createSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

session - Object whose hashcode might be used to select a specific connection if factory is distributed. If null, then no session is used.

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

createSocket

public CheckedSocket createSocket(long timeout)
                           throws java.net.ConnectException,
                                  java.net.SocketException

Description copied from interface: SocketFactory

Returns a new socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

createSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

timeout - Maximum time to wait (in milliseconds) for a connection to be created before throwing a ConnectException

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

createSocket

public CheckedSocket createSocket(java.lang.Object session,
                                  long timeout)
                           throws java.net.ConnectException,
                                  java.net.SocketException

Description copied from interface: SocketFactory

Returns a new socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

createSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

session - Object whose hashcode might be used to select a specific connection if factory is distributed. If null, then no session is used.

timeout - Maximum time to wait (in milliseconds) for a connection to become available before throwing an exception

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

getSocket

public CheckedSocket getSocket()
                        throws java.net.ConnectException,
                               java.net.SocketException

Description copied from interface: SocketFactory

Returns a new or recycled socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

getSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

getSocket

public CheckedSocket getSocket(java.lang.Object session)
                        throws java.net.ConnectException,
                               java.net.SocketException

Description copied from interface: SocketFactory

Returns a new or recycled socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

getSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

session - Object whose hashcode might be used to select a specific connection if factory is distributed. If null, then no session is used.

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

getSocket

public CheckedSocket getSocket(long timeout)
                        throws java.net.ConnectException,
                               java.net.SocketException

Description copied from interface: SocketFactory

Returns a new or recycled socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

getSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

timeout - Maximum time to wait (in milliseconds) for a connection to be returned before throwing a ConnectException

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

getSocket

public CheckedSocket getSocket(java.lang.Object session,
                               long timeout)
                        throws java.net.ConnectException,
                               java.net.SocketException

Description copied from interface: SocketFactory

Returns a new or recycled socket connection. When the socket is no longer needed, call recycleSocket so that it be used again.

Specified by:

getSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

session - Object whose hashcode might be used to select a specific connection if factory is distributed. If null, then no session is used.

timeout - Maximum time to wait (in milliseconds) for a connection to be returned before throwing a ConnectException

Throws:

java.net.ConnectException - if timeout has elapsed and no socket is available or factory is closed

recycleSocket

public void recycleSocket(CheckedSocket socket)
                   throws java.net.SocketException,
                          java.lang.IllegalArgumentException

Description copied from interface: SocketFactory

Recycle a socket connection that was returned from the getSocket or createSocket methods. Since SocketFactory has no knowledge of any protocol being used on the socket, it is the responsibility of the caller to ensure the socket is in a "clean" state. Depending on implementation, the recycled socket may simply be closed.

Specified by:

recycleSocket in interface SocketFactory

Following copied from interface: com.go.trove.net.SocketFactory

Parameters:

socket - Socket which must have come from this factory. Passing in null is ignored.

clear

public void clear()

Description copied from interface: SocketFactory

Closes all recycled connections, but does not prevent new connections from being created and recycled.

Specified by:

clear in interface SocketFactory

getAvailableCount

public int getAvailableCount()

Description copied from interface: SocketFactory

Returns the number of recycled sockets currently available.

Specified by:

getAvailableCount in interface SocketFactory