io.micronaut.configuration.rabbitmq.connect

Class DefaultChannelPool

java.lang.Object

io.micronaut.configuration.rabbitmq.connect.DefaultChannelPool

All Implemented Interfaces:

ChannelPool, AutoCloseable

@Singleton
public class DefaultChannelPool
extends Object
implements AutoCloseable, ChannelPool

Default implementation of ChannelPool. There is no limit to the number of channels that can be created. If the channel list is empty a new channel will be created and returned. The maximum number of channels should be the maximum number of concurrent operations.

Since:

1.1.0

Author:

James Kleeh

Constructor Summary

Constructors

Constructor and Description
DefaultChannelPool(com.rabbitmq.client.Connection connection, Integer maxIdleChannels) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
protected com.rabbitmq.client.Channel	createChannel() Creates a channel.
com.rabbitmq.client.Channel	getChannel() Retrieves a channel from the pool.
void	returnChannel(com.rabbitmq.client.Channel channel) Returns a channel to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultChannelPool

public DefaultChannelPool(com.rabbitmq.client.Connection connection,
                          @Nullable @Value(value="${rabbitmq.channel-pool.max-idle-channels}")
                          Integer maxIdleChannels)

Default constructor.

Parameters:

connection - The connection to create channels with

maxIdleChannels - How many idle channels should be kept open

Method Detail

getChannel

public com.rabbitmq.client.Channel getChannel()
                                       throws IOException

Description copied from interface: ChannelPool

Retrieves a channel from the pool. The channel must be returned to the pool after it is no longer being used.

Specified by:

getChannel in interface ChannelPool

Returns:

The channel

Throws:

IOException - If a channel needed to be created and encountered an error

returnChannel

public void returnChannel(com.rabbitmq.client.Channel channel)

Description copied from interface: ChannelPool

Returns a channel to the pool. No further use of the channel is allowed by the returner.

Specified by:

returnChannel in interface ChannelPool

Parameters:

channel - The channel

createChannel

protected com.rabbitmq.client.Channel createChannel()
                                             throws IOException

Creates a channel.

Returns:

The newly created channel

Throws:

IOException - If an error occurred creating the channel

close

@PreDestroy
public void close()

Specified by:

close in interface AutoCloseable