com.ning.http.client.providers.netty.channel.pool

Interface ChannelPool

All Known Implementing Classes:

DefaultChannelPool, NoopChannelPool

public interface ChannelPool

An interface used by an AsyncHttpProvider for caching http connections.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy all connections that has been cached by this instance.
void	flushPartition(Object partitionKey) Flush a partition
void	flushPartitions(ChannelPoolPartitionSelector selector) Flush partitions based on a selector
boolean	isOpen() Return true if a connection can be cached.
boolean	offer(org.jboss.netty.channel.Channel connection, Object partitionKey) Add a connection to the pool
org.jboss.netty.channel.Channel	poll(Object partitionKey) Get a connection from a partition
boolean	removeAll(org.jboss.netty.channel.Channel connection) Remove all connections from the cache.

Method Detail

offer

boolean offer(org.jboss.netty.channel.Channel connection,
              Object partitionKey)

Add a connection to the pool

Parameters:

partition - a key used to retrieve the cached connection

connection - an I/O connection

Returns:

true if added.

poll

org.jboss.netty.channel.Channel poll(Object partitionKey)

Get a connection from a partition

Parameters:

partition - the id of the partition used when invoking offer

Returns:

the connection associated with the partition

removeAll

boolean removeAll(org.jboss.netty.channel.Channel 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

isOpen

boolean isOpen()

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 ChannelPool#offer(Object, Object)

Returns:

true if a connection can be cached.

destroy

void destroy()

Destroy all connections that has been cached by this instance.

flushPartition

void flushPartition(Object partitionKey)

Flush a partition

Parameters:

partition -

flushPartitions

void flushPartitions(ChannelPoolPartitionSelector selector)

Flush partitions based on a selector

Parameters:

selector -