org.apache.http.nio.conn
Interface NHttpClientConnectionManager

All Known Implementing Classes:
PoolingNHttpClientConnectionManager

public interface NHttpClientConnectionManager

Represents a manager of persistent client connections.

The purpose of an HTTP connection manager is to serve as a factory for new HTTP connections, manage persistent connections and synchronize access to persistent connections making sure that only one thread of execution can have access to a connection at a time.

Implementations of this interface must be thread-safe. Access to shared data must be synchronized as methods of this interface may be executed from multiple threads.


Method Summary
 void closeExpiredConnections()
          Closes all expired connections in the pool.
 void closeIdleConnections(long idletime, TimeUnit tunit)
          Closes idle connections in the pool.
 void execute(org.apache.http.nio.reactor.IOEventDispatch eventDispatch)
           
 void initialize(org.apache.http.nio.NHttpClientConnection conn, HttpRoute route, HttpContext context)
           
 boolean isRouteComplete(org.apache.http.nio.NHttpClientConnection conn)
           
 void releaseConnection(org.apache.http.nio.NHttpClientConnection conn, Object newState, long validDuration, TimeUnit timeUnit)
          Releases a connection for use by others.
 Future<org.apache.http.nio.NHttpClientConnection> requestConnection(HttpRoute route, Object state, long connectTimeout, TimeUnit timeUnit, FutureCallback<org.apache.http.nio.NHttpClientConnection> callback)
          Returns a Future for a NHttpClientConnection.
 void routeComplete(org.apache.http.nio.NHttpClientConnection conn, HttpRoute route, HttpContext context)
           
 void shutdown()
          Shuts down this connection manager and releases allocated resources.
 void upgrade(org.apache.http.nio.NHttpClientConnection conn, HttpRoute route, HttpContext context)
           
 

Method Detail

requestConnection

Future<org.apache.http.nio.NHttpClientConnection> requestConnection(HttpRoute route,
                                                                    Object state,
                                                                    long connectTimeout,
                                                                    TimeUnit timeUnit,
                                                                    FutureCallback<org.apache.http.nio.NHttpClientConnection> callback)
Returns a Future for a NHttpClientConnection.


releaseConnection

void releaseConnection(org.apache.http.nio.NHttpClientConnection conn,
                       Object newState,
                       long validDuration,
                       TimeUnit timeUnit)
Releases a connection for use by others. You may optionally specify how long the connection is valid to be reused. Values <= 0 are considered to be valid forever. If the connection is not marked as reusable, the connection will not be reused regardless of the valid duration. If the connection has been released before, the call will be ignored.

Parameters:
conn - the connection to release
validDuration - the duration of time this connection is valid for reuse
timeUnit - the unit of time validDuration is measured in
See Also:
closeExpiredConnections()

initialize

void initialize(org.apache.http.nio.NHttpClientConnection conn,
                HttpRoute route,
                HttpContext context)
                throws IOException
Throws:
IOException

upgrade

void upgrade(org.apache.http.nio.NHttpClientConnection conn,
             HttpRoute route,
             HttpContext context)
             throws IOException
Throws:
IOException

routeComplete

void routeComplete(org.apache.http.nio.NHttpClientConnection conn,
                   HttpRoute route,
                   HttpContext context)

isRouteComplete

boolean isRouteComplete(org.apache.http.nio.NHttpClientConnection conn)

closeIdleConnections

void closeIdleConnections(long idletime,
                          TimeUnit tunit)
Closes idle connections in the pool. Open connections in the pool that have not been used for the timespan given by the argument will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision All expired connections will also be closed.

Parameters:
idletime - the idle time of connections to be closed
tunit - the unit for the idletime
See Also:
closeExpiredConnections()

closeExpiredConnections

void closeExpiredConnections()
Closes all expired connections in the pool. Open connections in the pool that have not been used for the timespan defined when the connection was released will be closed. Currently allocated connections are not subject to this method. Times will be checked with milliseconds precision.


execute

void execute(org.apache.http.nio.reactor.IOEventDispatch eventDispatch)
             throws IOException
Throws:
IOException

shutdown

void shutdown()
              throws IOException
Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.

Throws:
IOException


Copyright © 2010-2013 The Apache Software Foundation. All Rights Reserved.