BlockingConnectionPool (xSocket 2.8.14 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 BlockingConnectionPool

Package class diagram package BlockingConnectionPool

java.lang.Object
  org.xsocket.connection.BlockingConnectionPool

All Implemented Interfaces:: Closeable, IConnectionPool

public final class BlockingConnectionPool
extends Object
implements IConnectionPool
extends Object
implements IConnectionPool

A blocking connection pool implementation.

This class is thread safe

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


  IBlockingConnection con = null;

  try {
     // retrieve a connection (if no connection is in pool, a new one will be created)
     con = pool.getBlockingConnection(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

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_ACTIVE_PER_SERVER, DEFAULT_MAX_IDLE, DEFAULT_MAX_WAIT_MILLIS, DEFAULT_MAX_WAITING`

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

Method Summary
`void`	`addListener(ILifeCycle listener)` adds a listener
`void`	`close()`
`void`	`destroy(IBlockingConnection resource)`
`List<String>`	`getActiveConnectionInfos()` get a info list about the active connections
`IBlockingConnection`	`getBlockingConnection(InetAddress address, int port)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(InetAddress address, int port, boolean isSSL)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(InetAddress address, int port, int connectTimeoutMillis)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(InetAddress address, int port, int connectTimeoutMillis, boolean isSSL)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(String host, int port)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(String host, int port, boolean isSSL)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(String host, int port, int connectTimeoutMillis)` get a pool connection for the given address.
`IBlockingConnection`	`getBlockingConnection(String host, int port, int connectTimeoutMillis, boolean isSSL)` get a pool connection for the given address.
`List<String>`	`getIdleConnectionInfos()` get a info list about the idle connections
`int`	`getMaxActive()` return the number of max active resources
`int`	`getMaxActivePerServer()` return the number of max active resources per server
`int`	`getMaxIdle()` get the number of max idling resources
`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`	`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
`boolean`	`isOpen()` returns true, is pool is open
`boolean`	`removeListener(ILifeCycle listener)` removes a listener
`void`	`setMaxActive(int maxActive)` set the number of max active resources
`void`	`setMaxActivePerServer(int maxActivePerServer)` set the number of max active resources per server
`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

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

Constructor Detail

BlockingConnectionPool

public BlockingConnectionPool()

constructor

BlockingConnectionPool

public BlockingConnectionPool(SSLContext sslContext)

constructor

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

Method Detail

isOpen

public boolean isOpen()

returns true, is pool is open

Specified by:: isOpen in interface IConnectionPool

Returns:: true, is pool is open