org.asynchttpclient.netty.channel

Class DefaultChannelPool

java.lang.Object

org.asynchttpclient.netty.channel.DefaultChannelPool

All Implemented Interfaces:

ChannelPool

public final class DefaultChannelPool
extends Object
implements ChannelPool

A simple implementation of ChannelPool based on a ConcurrentHashMap

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultChannelPool.PoolLeaseStrategy

Constructor Summary

Constructors

Constructor and Description
DefaultChannelPool(AsyncHttpClientConfig config, Timer hashedWheelTimer)
DefaultChannelPool(int maxIdleTime, int connectionTtl, DefaultChannelPool.PoolLeaseStrategy poolLeaseStrategy, Timer nettyTimer, int cleanerPeriod)
DefaultChannelPool(int maxIdleTime, int connectionTtl, Timer nettyTimer, int cleanerPeriod)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy all channels 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 channel can be cached.
boolean	offer(Channel channel, Object partitionKey) Add a channel to the pool
Channel	poll(Object partitionKey) Remove the channel associated with the uri.
boolean	removeAll(Channel channel) Remove all channels 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,
                          Timer hashedWheelTimer)

DefaultChannelPool

public DefaultChannelPool(int maxIdleTime,
                          int connectionTtl,
                          Timer nettyTimer,
                          int cleanerPeriod)

DefaultChannelPool

public DefaultChannelPool(int maxIdleTime,
                          int connectionTtl,
                          DefaultChannelPool.PoolLeaseStrategy poolLeaseStrategy,
                          Timer nettyTimer,
                          int cleanerPeriod)

Method Detail

offer

public boolean offer(Channel channel,
                     Object partitionKey)

Add a channel to the pool

Specified by:

offer in interface ChannelPool

Parameters:

channel - an I/O channel

partitionKey - a key used to retrieve the cached channel

Returns:

true if added.

poll

public Channel poll(Object partitionKey)

Remove the channel associated with the uri.

Specified by:

poll in interface ChannelPool

Parameters:

partitionKey - the partition used when invoking offer

Returns:

the channel associated with the uri

removeAll

public boolean removeAll(Channel channel)

Remove all channels from the cache. A channel might have been associated with several uri.

Specified by:

removeAll in interface ChannelPool

Parameters:

channel - a channel

Returns:

the true if the channel has been removed

isOpen

public boolean isOpen()

Return true if a channel 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(Channel, Object)

Specified by:

isOpen in interface ChannelPool

Returns:

true if a channel can be cached.

destroy

public void destroy()

Destroy all channels that has been cached by this instance.

Specified by:

destroy in interface ChannelPool

flushPartition

public void flushPartition(Object partitionKey)

Description copied from interface: ChannelPool

Flush a partition

Specified by:

flushPartition in interface ChannelPool

Parameters:

partitionKey - the partition

flushPartitions

public void flushPartitions(ChannelPoolPartitionSelector selector)

Description copied from interface: ChannelPool

Flush partitions based on a selector

Specified by:

flushPartitions in interface ChannelPool

Parameters:

selector - the selector