Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

SingleClientConnManager

extends Object
implements ClientConnectionManager
java.lang.Object
   ↳ org.apache.http.impl.conn.SingleClientConnManager

Class Overview

A connection "manager" for a single connection. This manager is good only for single-threaded use. Allocation always returns the connection immediately, even if it has not been released after the previous allocation. In that case, a warning is logged and the previously issued connection is revoked.

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

Summary

Nested Classes
class SingleClientConnManager.ConnAdapter The connection adapter used by this manager. 
class SingleClientConnManager.PoolEntry The pool entry for this connection manager. 
Constants
String MISUSE_MESSAGE The message to be logged on multiple allocation.
Fields
protected boolean alwaysShutDown Whether the connection should be shut down on release.
protected ClientConnectionOperator connOperator The operator for opening and updating connections.
protected long connectionExpiresTime The time the last released connection expires and shouldn't be reused.
protected boolean isShutDown Indicates whether this connection manager is shut down.
protected long lastReleaseTime The time of the last connection release, or -1.
protected SingleClientConnManager.ConnAdapter managedConn The currently issued managed connection, if any.
protected SchemeRegistry schemeRegistry The schemes supported by this connection manager.
protected SingleClientConnManager.PoolEntry uniquePoolEntry The one and only entry in this pool.
Public Constructors
SingleClientConnManager ( HttpParams params, SchemeRegistry schreg)
Creates a new simple connection manager.
Public Methods
void closeExpiredConnections ()
Closes all expired connections in the pool.
void closeIdleConnections (long idletime, TimeUnit tunit)
Closes idle connections in the pool.
ManagedClientConnection getConnection ( HttpRoute route, Object state)
Obtains a connection.
SchemeRegistry getSchemeRegistry ()
Obtains the scheme registry used by this manager.
void releaseConnection ( ManagedClientConnection conn, long validDuration, TimeUnit timeUnit)
Releases a connection for use by others.
final ClientConnectionRequest requestConnection ( HttpRoute route, Object state)
Returns a new ClientConnectionRequest , from which a ManagedClientConnection can be obtained or the request can be aborted.
void shutdown ()
Shuts down this connection manager and releases allocated resources.
Protected Methods
final void assertStillUp ()
Asserts that this manager is not shut down.
ClientConnectionOperator createConnectionOperator ( SchemeRegistry schreg)
Hook for creating the connection operator.
void finalize ()
Invoked when the garbage collector has detected that this instance is no longer reachable.
void revokeConnection ()
Revokes the currently issued connection.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.apache.http.conn.ClientConnectionManager

Constants

public static final String MISUSE_MESSAGE

Added in API level 1

The message to be logged on multiple allocation.

Constant Value: "Invalid use of SingleClientConnManager: connection still allocated. Make sure to release the connection before allocating another one."

Fields

protected boolean alwaysShutDown

Added in API level 1

Whether the connection should be shut down on release.

protected ClientConnectionOperator connOperator

Added in API level 1

The operator for opening and updating connections.

protected long connectionExpiresTime

Added in API level 1

The time the last released connection expires and shouldn't be reused.

protected boolean isShutDown

Added in API level 1

Indicates whether this connection manager is shut down.

protected long lastReleaseTime

Added in API level 1

The time of the last connection release, or -1.

protected SingleClientConnManager.ConnAdapter managedConn

Added in API level 1

The currently issued managed connection, if any.

protected SchemeRegistry schemeRegistry

Added in API level 1

The schemes supported by this connection manager.

protected SingleClientConnManager.PoolEntry uniquePoolEntry

Added in API level 1

The one and only entry in this pool.

Public Constructors

public SingleClientConnManager ( HttpParams params, SchemeRegistry schreg)

Added in API level 1

Creates a new simple connection manager.

Parameters
params the parameters for this manager
schreg the scheme registry

Public Methods

public void closeExpiredConnections ()

Added in API level 1

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.

public void closeIdleConnections (long idletime, TimeUnit tunit)

Added in API level 1

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

public ManagedClientConnection getConnection ( HttpRoute route, Object state)

Added in API level 1

Obtains a connection. This method does not block.

Parameters
route where the connection should point to
Returns
  • a connection that can be used to communicate along the given route

public SchemeRegistry getSchemeRegistry ()

Added in API level 1

Obtains the scheme registry used by this manager.

Returns
  • the scheme registry, never null

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

Added in API level 1

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

public final ClientConnectionRequest requestConnection ( HttpRoute route, Object state)

Added in API level 1

Returns a new ClientConnectionRequest , from which a ManagedClientConnection can be obtained or the request can be aborted.

public void shutdown ()

Added in API level 1

Shuts down this connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.

Protected Methods

protected final void assertStillUp ()

Added in API level 1

Asserts that this manager is not shut down.

Throws
IllegalStateException if this manager is shut down

protected ClientConnectionOperator createConnectionOperator ( SchemeRegistry schreg)

Added in API level 1

Hook for creating the connection operator. 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
schreg the scheme registry to use, or null
Returns
  • the connection operator to use

protected void finalize ()

Added in API level 1

Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.

Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable ), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.

If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.

Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.

Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.

Throws
Throwable

protected void revokeConnection ()

Added in API level 1

Revokes the currently issued connection. The adapter gets disconnected, the connection will be shut down.