io.netty.channel.pool

Interface ChannelHealthChecker

public interface ChannelHealthChecker

Called before a Channel will be returned via ChannelPool.acquire() or ChannelPool.acquire(Promise).

Field Summary

Fields

Modifier and Type	Field and Description
static ChannelHealthChecker	ACTIVE ChannelHealthChecker implementation that checks if Channel.isActive() returns true.

Method Summary

Modifier and Type	Method and Description
Future<Boolean>	isHealthy(Channel channel) Check if the given channel is healthy which means it can be used.

Field Detail

ACTIVE

static final ChannelHealthChecker ACTIVE

ChannelHealthChecker implementation that checks if Channel.isActive() returns true.

Method Detail

isHealthy

Future<Boolean> isHealthy(Channel channel)

Check if the given channel is healthy which means it can be used. The returned Future is notified once the check is complete. If notified with Boolean.TRUE it can be used Boolean.FALSE otherwise. This method will be called by the EventLoop of the Channel.