NonBlockingConnectionPool (xSocket 2.1.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.xsocket.connection
Class NonBlockingConnectionPool

Package class diagram package NonBlockingConnectionPool

java.lang.Object
  org.xsocket.connection.NonBlockingConnectionPool

All Implemented Interfaces:: Closeable, IConnectionPool

public final class NonBlockingConnectionPool
extends Object
implements IConnectionPool
extends Object
implements IConnectionPool

A connection pool implementation.

This class is thread safe

  // create a unbound connection pool
  NonBlockingConnectionPool pool = new NonBlockingConnectionPool();

  INonBlockingCinnection con = null;

  try {
     // retrieve a connection (if no connection is in pool, a new one will be created)
     con = pool.getNonBlockingConnection(host, port);
     con.write("Hello");
     ...

     // always close the connection! (the connection will be returned into the connection pool)
     con.close();

        } catch (IOException e) {
     if (con != null) {
        try {
          // if the connection is invalid -> destroy it (it will not return into the pool)
          pool.destroy(con);
        } catch (Exception ignore) { }
     }
  }

Author:: grro@xsocket.org

Field Summary
`protected static int`	`MAX_SIZE`
`protected static int`	`MAX_TIMEOUT`
`protected static long`	`MIN_CHECKPERIOD_MILLIS`

Fields inherited from interface org.xsocket.connection.IConnectionPool
`DEFAULT_CREATION_TIMEOUT_MILLIS, DEFAULT_IDLE_TIMEOUT_MILLIS, DEFAULT_LIFE_TIMEOUT_MILLIS, DEFAULT_MAX_ACTIVE, DEFAULT_MAX_IDLE, DEFAULT_MAX_WAIT_MILLIS`

Constructor Summary
`NonBlockingConnectionPool()` constructor
`NonBlockingConnectionPool(SSLContext sslContext)` constructor

Method Summary
`void`	`addListener(ILifeCycle listener)` adds a listener
`void`	`close()`
`static void`	`destroy(INonBlockingConnection connection)`
`List<String>`	`getActiveConnectionInfos()` get a info list about the active connections
`long`	`getCreationMaxWaitMillis()` get the max waiting by retrieving a resource
`List<String>`	`getIdleConnectionInfos()` get a info list about the idle connections
`int`	`getMaxActive()` return the number of max active resources
`int`	`getMaxIdle()` get the number of max idling resources
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, IHandler appHandler)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, IHandler appHandler, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, IHandler appHandler, Executor workerPool, int connectTimeoutMillis)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, IHandler appHandler, Executor workerPool, int connectTimeoutMillis, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, IHandler appHandler, int connectTimeoutMillis)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, IHandler appHandler, int connectTimeoutMillis, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, int connectTimeoutMillis)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(InetAddress address, int port, int connectTimeoutMillis, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(String host, int port)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(String host, int port, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(String host, int port, IHandler appHandler)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(String host, int port, IHandler appHandler, boolean isSSL)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(String host, int port, int connectTimeoutMillis)` get a pool connection for the given address.
`INonBlockingConnection`	`getNonBlockingConnection(String host, int port, int connectTimeoutMillis, boolean isSSL)` get a pool connection for the given address.
`int`	`getNumActive()` get the current number of the active resources
`int`	`getNumCreated()` get the number of the created resources
`int`	`getNumCreationError()` get the number of the creation errors
`int`	`getNumDestroyed()` get the number of the destroyed resources
`int`	`getNumIdle()` get the current number of idling resources
`int`	`getNumPendingGet()` get the current number of pending get operations to retrieve a resource
`int`	`getNumTimeoutConnectionIdle()`
`int`	`getNumTimeoutConnectionLifetime()`
`int`	`getNumTimeoutPooledMaxIdleTime()` get the number of timeouts caused by the pool idle timeout
`int`	`getNumTimeoutPooledMaxLifeTime()` get the number of timeouts caused by the pool life timeout
`int`	`getPooledMaxIdleTimeMillis()` get the idle time out
`int`	`getPooledMaxLifeTimeMillis()` get the life timeout of a resource
`Executor`	`getWorkerpool()` get the worker pool which will be assigned to the connections for call back handling
`boolean`	`isOpen()` returns true, is pool is open
`boolean`	`removeListener(ILifeCycle listener)` removes a listener
`void`	`setCreationMaxWaitMillis(long maxWaitMillis)` set the max waiting by retrieving a resource
`void`	`setMaxActive(int maxActive)` set the number of max active resources
`void`	`setMaxIdle(int maxIdle)` set the number of max idling resources
`void`	`setPooledMaxIdleTimeMillis(int idleTimeoutMillis)` set the idle time out of a resource within the pool
`void`	`setPooledMaxLifeTimeMillis(int lifeTimeoutMillis)` set the life timeout of a resource
`void`	`setWorkerpool(Executor workerpool)` set the worker pool which will be assigned to the connections for call back handling
`String`	`toString()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

MIN_CHECKPERIOD_MILLIS

protected static final long MIN_CHECKPERIOD_MILLIS

See Also:: Constant Field Values

MAX_SIZE

protected static final int MAX_SIZE

See Also:: Constant Field Values

MAX_TIMEOUT

protected static final int MAX_TIMEOUT

See Also:: Constant Field Values

Constructor Detail

NonBlockingConnectionPool

public NonBlockingConnectionPool()

constructor

NonBlockingConnectionPool

public NonBlockingConnectionPool(SSLContext sslContext)

constructor

Parameters:: sslContext - the ssl context or null if ssl should not be used

Method Detail