• BlackBerry Dynamics
  • Runtime library for Android applications
  • 12.0.1.79
ThreadSafeClientConnManager Class Reference

Manages a pool of client connections . More...

Inheritance diagram for ThreadSafeClientConnManager:
ClientConnectionManager

Description

This class is derived from MultiThreadedHttpConnectionManager in HttpClient 3. See there for original authors.

Author
Roland Weber
Michael Becke
Version
Revision
673450
Date
2008-07-02 10:35:05 -0700 (Wed, 02 Jul 2008)
Since
4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions

 ThreadSafeClientConnManager (HttpParams params, SchemeRegistry schreg)
 Creates a new thread safe connection manager. More...
 
SchemeRegistry getSchemeRegistry ()
 Obtains the scheme registry used by this manager. More...
 
ClientConnectionRequest requestConnection (final HttpRoute route, final Object state)
 Returns a new com.good.gd.apache.http.conn.ClientConnectionRequest, from which a com.good.gd.apache.http.conn.ManagedClientConnection can be obtained or the request can be aborted.
 
void releaseConnection (ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)
 Releases a connection for use by others. More...
 
void shutdown ()
 Shuts down this connection manager and releases allocated resources. More...
 
int getConnectionsInPool (HttpRoute route)
 Gets the total number of pooled connections for the given route. More...
 
int getConnectionsInPool ()
 Gets the total number of pooled connections. More...
 
void closeIdleConnections (long idleTimeout, TimeUnit tunit)
 Closes idle connections in the pool. More...
 
void closeExpiredConnections ()
 Closes all expired connections in the pool. More...
 

Protected Member Functions

AbstractConnPool createConnectionPool (final HttpParams params)
 Hook for creating the connection pool. More...
 
ClientConnectionOperator createConnectionOperator (SchemeRegistry schreg)
 Hook for creating the connection operator. More...
 

Protected Attributes

SchemeRegistry schemeRegistry
 The schemes supported by this connection manager. More...
 
final AbstractConnPool connectionPool
 The pool of connections being managed. More...
 
ClientConnectionOperator connOperator
 The operator for opening and updating connections. More...
 

Constructor & Destructor Documentation

◆ ThreadSafeClientConnManager()

Parameters
paramsthe parameters for this manager
schregthe scheme registry

Member Function Documentation

◆ createConnectionPool()

AbstractConnPool createConnectionPool ( final HttpParams  params)
protected
Returns
the connection pool to use

◆ createConnectionOperator()

ClientConnectionOperator createConnectionOperator ( SchemeRegistry  schreg)
protected

It is called by the constructor. Derived classes can override this method to change the instantiation of the operator. The default implementation here instantiates DefaultClientConnectionOperator .

Parameters
schregthe scheme registry to use, or null
Returns
the connection operator to use

◆ getSchemeRegistry()

SchemeRegistry getSchemeRegistry ( )
Returns
the scheme registry, never null

Implements ClientConnectionManager.

◆ releaseConnection()

void releaseConnection ( ManagedClientConnection  conn,
long  validDuration,
TimeUnit  timeUnit 
)

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
connthe connection to release
validDurationthe duration of time this connection is valid for reuse
timeUnitthe unit of time validDuration is measured in
See also
closeExpiredConnections()

Implements ClientConnectionManager.

◆ shutdown()

void shutdown ( )

This includes closing all connections, whether they are currently used or not.

Implements ClientConnectionManager.

◆ getConnectionsInPool() [1/2]

int getConnectionsInPool ( HttpRoute  route)

This is the total number of connections that have been created and are still in use by this connection manager for the route. This value will not exceed the maximum number of connections per host.

Parameters
routethe route in question
Returns
the total number of pooled connections for that route

◆ getConnectionsInPool() [2/2]

int getConnectionsInPool ( )

This is the total number of connections that have been created and are still in use by this connection manager. This value will not exceed the maximum number of connections in total.

Returns
the total number of pooled connections

◆ closeIdleConnections()

void closeIdleConnections ( long  idletime,
TimeUnit  tunit 
)

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
idletimethe idle time of connections to be closed
tunitthe unit for the idletime
See also
closeExpiredConnections()

Implements ClientConnectionManager.

◆ closeExpiredConnections()

void closeExpiredConnections ( )

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.

Implements ClientConnectionManager.

Member Data Documentation

◆ schemeRegistry

SchemeRegistry schemeRegistry
protected

◆ connectionPool

final AbstractConnPool connectionPool
protected

◆ connOperator

ClientConnectionOperator connOperator
protected