com.ning.http.client.providers.grizzly

Interface ConnectionPool

All Known Implementing Classes:

GrizzlyConnectionPool

public interface ConnectionPool

An interface used by an AsyncHttpProvider for caching http connections.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCacheConnection() Return true if a connection can be cached.
void	destroy() Destroy all connections that has been cached by this instance.
boolean	offer(String uri, org.glassfish.grizzly.Connection connection) Add a connection tpo the pool
org.glassfish.grizzly.Connection	poll(String uri) Remove the connection associated with the uri.
boolean	removeAll(org.glassfish.grizzly.Connection connection) Remove all connections from the cache.

Method Detail

offer

boolean offer(String uri,
            org.glassfish.grizzly.Connection connection)

Add a connection tpo the pool

Parameters:

uri - a uri used to retrieve the cached connection

connection - an I/O connection

Returns:

true if added.

poll

org.glassfish.grizzly.Connection poll(String uri)

Remove the connection associated with the uri.

Parameters:

uri - the uri used when invoking addConnection

Returns:

the connection associated with the uri

removeAll

boolean removeAll(org.glassfish.grizzly.Connection connection)

Remove all connections from the cache. A connection might have been associated with several uri.

Parameters:

connection - a connection

Returns:

the true if the connection has been removed

canCacheConnection

boolean canCacheConnection()

Return true if a connection can be cached. A implementation can decide based on some rules to allow caching Calling this method is equivalent of checking the returned value of ConnectionPool#offer(Object, Object)

Returns:

true if a connection can be cached.

destroy

void destroy()

Destroy all connections that has been cached by this instance.