org.asynchttpclient.netty.channel.pool

Interface ChannelPool

All Known Implementing Classes:

DefaultChannelPool, NoopChannelPool

public interface ChannelPool

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(io.netty.channel.Channel channel, Object partitionKey) Add a channel to the pool
io.netty.channel.Channel	poll(Object partitionKey) Remove the channel associated with the uri.
boolean	removeAll(io.netty.channel.Channel channel) Remove all channels from the cache.

Method Detail

offer

boolean offer(io.netty.channel.Channel channel,
              Object partitionKey)

Add a channel to the pool

Parameters:

partitionKey - a key used to retrieve the cached channel

channel - an I/O channel

Returns:

true if added.

poll

io.netty.channel.Channel poll(Object partitionKey)

Remove the channel associated with the uri.

Parameters:

partitionKey - the partition used when invoking offer

Returns:

the channel associated with the uri

removeAll

boolean removeAll(io.netty.channel.Channel channel)

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

Parameters:

channel - a channel

Returns:

the true if the channel has been removed

isOpen

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

Returns:

true if a channel can be cached.

destroy

void destroy()

Destroy all channels that has been cached by this instance.

flushPartition

void flushPartition(Object partitionKey)

Flush a partition

Parameters:

partitionKey -

flushPartitions

void flushPartitions(ChannelPoolPartitionSelector selector)

Flush partitions based on a selector

Parameters:

selector -