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

Class DefaultChannelPool

java.lang.Object

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

All Implemented Interfaces:

ChannelPool

public final class DefaultChannelPool
extends Object
implements ChannelPool

A simple implementation of ChannelPool based on a ConcurrentHashMap

Constructor Summary

Constructors

Constructor and Description
DefaultChannelPool(AsyncHttpClientConfig config, org.jboss.netty.util.Timer hashedWheelTimer)
DefaultChannelPool(int maxConnectionPerHost, long maxIdleTime, int maxConnectionTTL, boolean sslConnectionPoolEnabled, org.jboss.netty.util.Timer nettyTimer)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroy all connections that has been cached by this instance.
boolean	isOpen() Return true if a connection can be cached.
boolean	offer(org.jboss.netty.channel.Channel channel, String poolKey) Add a connection to the pool
org.jboss.netty.channel.Channel	poll(String poolKey) Remove the connection associated with the uri.
boolean	removeAll(org.jboss.netty.channel.Channel channel) Remove all connections from the cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultChannelPool

public DefaultChannelPool(AsyncHttpClientConfig config,
                  org.jboss.netty.util.Timer hashedWheelTimer)

DefaultChannelPool

public DefaultChannelPool(int maxConnectionPerHost,
                  long maxIdleTime,
                  int maxConnectionTTL,
                  boolean sslConnectionPoolEnabled,
                  org.jboss.netty.util.Timer nettyTimer)

Method Detail

offer

public boolean offer(org.jboss.netty.channel.Channel channel,
            String poolKey)

Add a connection to the pool

Specified by:

offer in interface ChannelPool

Parameters:

channel - an I/O connection

poolKey - a key used to retrieve the cached connection

Returns:

true if added.

poll

public org.jboss.netty.channel.Channel poll(String poolKey)

Remove the connection associated with the uri.

Specified by:

poll in interface ChannelPool

Parameters:

poolKey - the uri used when invoking addConnection

Returns:

the connection associated with the uri

removeAll

public boolean removeAll(org.jboss.netty.channel.Channel channel)

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

Specified by:

removeAll in interface ChannelPool

Parameters:

channel - a connection

Returns:

the true if the connection has been removed

isOpen

public 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)

Specified by:

isOpen in interface ChannelPool

Returns:

true if a connection can be cached.

destroy

public void destroy()

Destroy all connections that has been cached by this instance.

Specified by:

destroy in interface ChannelPool