com.kheops.util

Class KSocketConnectionPool

java.lang.Object

com.kheops.util.KObjectPool<java.net.Socket>

com.kheops.util.KSocketConnectionPool

All Implemented Interfaces:

KSchedulerClient

public class KSocketConnectionPool
extends KObjectPool<java.net.Socket>

This class encapsulates a pool of socket connections

See Also:

KObjectPool, Socket

Field Summary

Fields inherited from class com.kheops.util.KObjectPool

cleanupPeriod, recyclePeriod, shrinkTime, TIMEOUT_UNDEFINED, TIMEOUT_UNLIMITED

Constructor Summary

Constructors

Constructor and Description
KSocketConnectionPool(java.lang.String host, int port, int initialSize) Constructs the KSocketConnectionPool instance with the specified parameters

Method Summary

Modifier and Type	Method and Description
java.net.Socket	borrowSocket() Gets a free socket from the connection pool
java.net.Socket	borrowSocket(long timeout, java.util.concurrent.TimeUnit unit) Gets a free socket from the connection pool
java.net.Socket	create() Creates an new socket with the appropriate port and host
void	expire(java.net.Socket socket) Closes the specified socket
void	returnSocket(java.net.Socket s) This method will free up the specified Socket instance to be used later
boolean	validate(java.net.Socket socket) This method checks if the object qualifies for connections

Methods inherited from class com.kheops.util.KObjectPool

apply, checkIn, checkOut, checkOut, close, createUnlockedInstance, getDefaultTimeout, getId, getMonitoringInfo, getPoolMaximumSize, getPoolSize, getPoolUsageCount, getPoolUsagePeak, getSystemDefaultTimeout, initialize, initialize, initialize, internalErrorOccurred, reset, resourceAdded, schCallback, setDefaultTimeout, setPoolMaximumSize, setPoolMinimumSize

Methods inherited from class java.lang.Object

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

Constructor Detail

KSocketConnectionPool

public KSocketConnectionPool(java.lang.String host,
                             int port,
                             int initialSize)
                      throws java.lang.Exception

Constructs the KSocketConnectionPool instance with the specified parameters

Parameters:

host - the corresponding host

port - the port used for connection

initialSize - the initial number of connections

Throws:

java.lang.Exception

Method Detail

create

public java.net.Socket create()
                       throws java.io.IOException

Creates an new socket with the appropriate port and host

Specified by:

create in class KObjectPool<java.net.Socket>

Returns:

the new Socket instance

Throws:

java.io.IOException

validate

public boolean validate(java.net.Socket socket)

This method checks if the object qualifies for connections

Specified by:

validate in class KObjectPool<java.net.Socket>

Parameters:

socket - the socket instance

Returns:

true if the object qualifies for connection false otherwise

expire

public void expire(java.net.Socket socket)

Closes the specified socket

Specified by:

expire in class KObjectPool<java.net.Socket>

Parameters:

socket - the socket instance

borrowSocket

public java.net.Socket borrowSocket()
                             throws java.io.IOException

Gets a free socket from the connection pool

Returns:

a free Socket instance from the connection pool

Throws:

java.io.IOException

borrowSocket

public java.net.Socket borrowSocket(long timeout,
                                    java.util.concurrent.TimeUnit unit)
                             throws java.io.IOException

Gets a free socket from the connection pool

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

a free Socket instance from the connection pool

Throws:

java.io.IOException

returnSocket

public void returnSocket(java.net.Socket s)

This method will free up the specified Socket instance to be used later

Parameters:

s - the corresponding Socket instance to be freed