reactor.rabbitmq

Class SenderOptions

java.lang.Object

reactor.rabbitmq.SenderOptions

public class SenderOptions
extends Object

Options for Sender creation.

Constructor Summary

Constructors

Constructor and Description
SenderOptions()

Method Summary

Modifier and Type	Method and Description
SenderOptions	channelCloseHandler(BiConsumer<SignalType,com.rabbitmq.client.Channel> channelCloseHandler) Set the channel closing logic.
SenderOptions	channelMono(Mono<? extends com.rabbitmq.client.Channel> channelMono) Sets the channel mono to use in send methods.
SenderOptions	channelPool(ChannelPool channelPool) Set the channel pool to use to send messages.
SenderOptions	connectionClosingTimeout(Duration connectionClosingTimeout) Timeout for closing the Sender connection.
SenderOptions	connectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory)
SenderOptions	connectionMono(Mono<? extends com.rabbitmq.client.Connection> connectionMono) Set a Mono that the created Sender will use for its operations.
SenderOptions	connectionMonoConfigurator(Function<Mono<? extends com.rabbitmq.client.Connection>,Mono<? extends com.rabbitmq.client.Connection>> connectionMonoConfigurator) A Function to customize the connection Mono used in the created Sender instance.
SenderOptions	connectionSubscriptionScheduler(Scheduler connectionSubscriptionScheduler) Scheduler used on connection creation subscription.
SenderOptions	connectionSupplier(com.rabbitmq.client.ConnectionFactory connectionFactory, Utils.ExceptionFunction<com.rabbitmq.client.ConnectionFactory,? extends com.rabbitmq.client.Connection> function) Set a callback that will be passed in the given ConnectionFactory to create a Connection.
SenderOptions	connectionSupplier(Utils.ExceptionFunction<com.rabbitmq.client.ConnectionFactory,? extends com.rabbitmq.client.Connection> function) Set a callback that will be passed in the ConnectionFactory of this SenderOptions instance to create a Connection.
BiConsumer<SignalType,com.rabbitmq.client.Channel>	getChannelCloseHandler() Returns the channel closing logic.
Mono<? extends com.rabbitmq.client.Channel>	getChannelMono() Returns the channel mono to use in send methods.
Duration	getConnectionClosingTimeout()
com.rabbitmq.client.ConnectionFactory	getConnectionFactory()
Mono<? extends com.rabbitmq.client.Connection>	getConnectionMono()
Function<Mono<? extends com.rabbitmq.client.Connection>,Mono<? extends com.rabbitmq.client.Connection>>	getConnectionMonoConfigurator()
Scheduler	getConnectionSubscriptionScheduler()
Utils.ExceptionFunction<com.rabbitmq.client.ConnectionFactory,? extends com.rabbitmq.client.Connection>	getConnectionSupplier()
Mono<? extends com.rabbitmq.client.Channel>	getResourceManagementChannelMono()
Scheduler	getResourceManagementScheduler()
SenderOptions	resourceManagementChannelMono(Mono<? extends com.rabbitmq.client.Channel> resourceManagementChannelMono)
SenderOptions	resourceManagementScheduler(Scheduler resourceManagementScheduler) Resource management scheduler.

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderOptions

public SenderOptions()

Method Detail

getConnectionFactory

public com.rabbitmq.client.ConnectionFactory getConnectionFactory()

connectionFactory

public SenderOptions connectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory)

getResourceManagementScheduler

@Nullable
public Scheduler getResourceManagementScheduler()

resourceManagementScheduler

public SenderOptions resourceManagementScheduler(@Nullable
                                                 Scheduler resourceManagementScheduler)

Resource management scheduler. It is developer's responsibility to close it if set.

Parameters:

resourceManagementScheduler -

Returns:

the current SenderOptions instance

getConnectionSubscriptionScheduler

@Nullable
public Scheduler getConnectionSubscriptionScheduler()

connectionSubscriptionScheduler

public SenderOptions connectionSubscriptionScheduler(@Nullable
                                                     Scheduler connectionSubscriptionScheduler)

Scheduler used on connection creation subscription. It is developer's responsibility to close it if set.

Parameters:

connectionSubscriptionScheduler -

Returns:

the current SenderOptions instance

connectionSupplier

public SenderOptions connectionSupplier(Utils.ExceptionFunction<com.rabbitmq.client.ConnectionFactory,? extends com.rabbitmq.client.Connection> function)

Set a callback that will be passed in the ConnectionFactory of this SenderOptions instance to create a Connection.

Note the created connection will be used by a Sender instance, which will cache it for re-use in its operations and close it when Sender.close() is called.

Parameters:

function - callback to create a Connection

Returns:

this current SenderOptions instance

connectionSupplier

public SenderOptions connectionSupplier(com.rabbitmq.client.ConnectionFactory connectionFactory,
                                        Utils.ExceptionFunction<com.rabbitmq.client.ConnectionFactory,? extends com.rabbitmq.client.Connection> function)

Set a callback that will be passed in the given ConnectionFactory to create a Connection.

Note the created connection will be used by a Sender instance, which will cache it for re-use in its operations and close it when Sender.close() is called.

Parameters:

connectionFactory - the ConnectionFactory passed-in to the creation function

function - callback to create a Connection

Returns:

this current SenderOptions

connectionMono

public SenderOptions connectionMono(@Nullable
                                    Mono<? extends com.rabbitmq.client.Connection> connectionMono)

Set a Mono that the created Sender will use for its operations.

A Sender created from this SenderOptions instance will not cache for re-use, nor close on Sender.close() the underlying connection. It is recommended that the passed-in Mono handles caching of some sort to avoid a new connection to be created every time the Sender does an operation. It is the developer's responsibility to close the underlying Connection once the Sender is closed and no longer needs it.

Parameters:

connectionMono -

Returns:

this current SenderOptions

getConnectionMono

@Nullable
public Mono<? extends com.rabbitmq.client.Connection> getConnectionMono()

channelMono

public SenderOptions channelMono(@Nullable
                                 Mono<? extends com.rabbitmq.client.Channel> channelMono)

Sets the channel mono to use in send methods.

Parameters:

channelMono - the channel mono to use

Returns:

this SenderOptions instance

Since:

1.1.0

getChannelMono

@Nullable
public Mono<? extends com.rabbitmq.client.Channel> getChannelMono()

Returns the channel mono to use in send methods.

Returns:

the channel mono to use

Since:

1.1.0

getChannelCloseHandler

@Nullable
public BiConsumer<SignalType,com.rabbitmq.client.Channel> getChannelCloseHandler()

Returns the channel closing logic.

Returns:

the closing logic to use

Since:

1.1.0

channelCloseHandler

public SenderOptions channelCloseHandler(@Nullable
                                         BiConsumer<SignalType,com.rabbitmq.client.Channel> channelCloseHandler)

Set the channel closing logic.

Parameters:

channelCloseHandler - the closing logic

Returns:

this SenderOptions instance

Since:

1.1.0

channelPool

public SenderOptions channelPool(ChannelPool channelPool)

Set the channel pool to use to send messages.

Parameters:

channelPool -

Returns:

this SenderOptions instance

Since:

1.1.0

connectionMonoConfigurator

public SenderOptions connectionMonoConfigurator(Function<Mono<? extends com.rabbitmq.client.Connection>,Mono<? extends com.rabbitmq.client.Connection>> connectionMonoConfigurator)

A Function to customize the connection Mono used in the created Sender instance.

This function can be used to configure retry when obtaining the Connection. This function is not applied if a custom connectionMono is provided. It is applied when a connectionSupplier is provided though.

Parameters:

connectionMonoConfigurator - the function to configure the passed-in connection mono

Returns:

the configured connection mono

resourceManagementChannelMono

public SenderOptions resourceManagementChannelMono(@Nullable
                                                   Mono<? extends com.rabbitmq.client.Channel> resourceManagementChannelMono)

getResourceManagementChannelMono

@Nullable
public Mono<? extends com.rabbitmq.client.Channel> getResourceManagementChannelMono()

getConnectionSupplier

@Nullable
public Utils.ExceptionFunction<com.rabbitmq.client.ConnectionFactory,? extends com.rabbitmq.client.Connection> getConnectionSupplier()

getConnectionMonoConfigurator

public Function<Mono<? extends com.rabbitmq.client.Connection>,Mono<? extends com.rabbitmq.client.Connection>> getConnectionMonoConfigurator()

connectionClosingTimeout

public SenderOptions connectionClosingTimeout(@Nullable
                                              Duration connectionClosingTimeout)

Timeout for closing the Sender connection.

Default is 30 seconds. Use Duration.ZERO for no timeout.

Parameters:

connectionClosingTimeout - timeout for connection closing

Returns:

this SenderOptions instance

Since:

1.3.0

getConnectionClosingTimeout

@Nullable
public Duration getConnectionClosingTimeout()