com.ibasco.agql.core.transport.pool

Interface NettyChannelPool

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

FixedNettyChannelPool, SimpleNettyChannelPool

public interface NettyChannelPool
extends Closeable

Enhanced version of netty's ChannelPool interface with CompletableFuture support.

Author:

Rafael Luis Ibasco

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NettyChannelPool.ReleaseStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<NettyChannelPool>	CHANNEL_POOL The default Channel attribute for NettyChannelPool
static NettyChannelPool.ReleaseStrategy	DISCONNECT_ON_RELEASE Constant DISCONNECT_ON_RELEASE
static NettyChannelPool.ReleaseStrategy	NONE Constant NONE

Method Summary

Modifier and Type	Method and Description
CompletableFuture<io.netty.channel.Channel>	acquire(InetSocketAddress remoteAddress) Acquire a Channel from this NettyChannelPool.
CompletableFuture<io.netty.channel.Channel>	acquire(InetSocketAddress remoteAddress, CompletableFuture<io.netty.channel.Channel> promise) Acquire a Channel from this NettyChannelPool.
void	close()
static NettyChannelPool	getPool(io.netty.channel.Channel channel) Retrieve the NettyChannelPool which was used to acquire the specified Channel
int	getSize() getSize.
static boolean	isPooled(io.netty.channel.Channel channel) Checks if the Channel is currectly pooled
CompletableFuture<Void>	release(io.netty.channel.Channel channel) Release a Channel back to this NettyChannelPool.
CompletableFuture<Void>	release(io.netty.channel.Channel channel, CompletableFuture<Void> promise) Release a Channel back to this NettyChannelPool.
static CompletableFuture<Boolean>	tryRelease(io.netty.channel.Channel channel) Attempts to release the Channel if it is pooleed.

Field Detail

NONE

static final NettyChannelPool.ReleaseStrategy NONE

Constant NONE

DISCONNECT_ON_RELEASE

static final NettyChannelPool.ReleaseStrategy DISCONNECT_ON_RELEASE

Constant DISCONNECT_ON_RELEASE

CHANNEL_POOL

static final io.netty.util.AttributeKey<NettyChannelPool> CHANNEL_POOL

The default Channel attribute for NettyChannelPool

Method Detail

tryRelease

static CompletableFuture<Boolean> tryRelease(io.netty.channel.Channel channel)

Attempts to release the Channel if it is pooleed.

Parameters:

channel - The Channel to release

Returns:

A CompletableFuture which is notified once the operation is marked as completed. A value of true will be returned if the Channel was released, otherwise false if the Channel is not pooled or if the release operation was unsuccessful. The returned future will never complete exceptionally.

getPool

static NettyChannelPool getPool(io.netty.channel.Channel channel)

Retrieve the NettyChannelPool which was used to acquire the specified Channel

Parameters:

channel - The Channel to be used as lookup

Returns:

The NettyChannelPool or null if the Channel was not acquired from a NettyChannelPool

release

CompletableFuture<Void> release(io.netty.channel.Channel channel)

Release a Channel back to this NettyChannelPool. The returned Future is notified once the release is successful and failed otherwise. When failed the Channel will automatically closed.

Parameters:

channel - a Channel object

Returns:

a CompletableFuture object

isPooled

static boolean isPooled(io.netty.channel.Channel channel)

Checks if the Channel is currectly pooled

Parameters:

channel - The Channel to be used as lookup

Returns:

true if the Channel has been acquired from a NettyChannelPool

acquire

CompletableFuture<io.netty.channel.Channel> acquire(InetSocketAddress remoteAddress)

Acquire a Channel from this NettyChannelPool. The returned CompletableFuture is notified once the acquire is successful and failed otherwise. Its important that an acquired is always released to the pool again, even if the Channel is explicitly closed..

Parameters:

remoteAddress - The remote address to connect to

Returns:

a CompletableFuture object

acquire

CompletableFuture<io.netty.channel.Channel> acquire(InetSocketAddress remoteAddress,
                                                    CompletableFuture<io.netty.channel.Channel> promise)

Acquire a Channel from this NettyChannelPool. The returned CompletableFuture is notified once the acquire is successful and failed otherwise. Its important that an acquired is always released to the pool again, even if the Channel is explicitly closed..

Parameters:

remoteAddress - The remote address to connect to

promise - The CompletableFuture that is notified once the acquire operation is complete.

Returns:

a CompletableFuture object

release

CompletableFuture<Void> release(io.netty.channel.Channel channel,
                                CompletableFuture<Void> promise)

Release a Channel back to this NettyChannelPool. The given Promise is notified once the release is successful and failed otherwise. When failed the Channel will automatically closed.

Parameters:

channel - a Channel object

promise - a CompletableFuture object

Returns:

a CompletableFuture object

getSize

int getSize()

getSize.

Returns:

a int

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable