reactor.rabbitmq

Class ReceiverOptions

java.lang.Object

reactor.rabbitmq.ReceiverOptions

public class ReceiverOptions
extends Object

Options for Receiver creation.

Constructor Summary

Constructors

Constructor and Description
ReceiverOptions()

Method Summary

Modifier and Type	Method and Description
ReceiverOptions	connectionClosingTimeout(Duration connectionClosingTimeout) Timeout for closing the Receiver connection.
ReceiverOptions	connectionFactory(ConnectionFactory connectionFactory)
ReceiverOptions	connectionMono(Mono<? extends Connection> connectionMono) Set a Mono that the created Receiver will use for its operations.
ReceiverOptions	connectionMonoConfigurator(Function<Mono<? extends Connection>,Mono<? extends Connection>> connectionMonoConfigurator) A Function to customize the connection Mono used in the created Receiver instance.
ReceiverOptions	connectionSubscriptionScheduler(Scheduler connectionSubscriptionScheduler) Scheduler used on connection creation subscription.
ReceiverOptions	connectionSupplier(ConnectionFactory connectionFactory, Utils.ExceptionFunction<ConnectionFactory,? extends Connection> function) Set a callback that will be passed in the given ConnectionFactory to create a Connection.
ReceiverOptions	connectionSupplier(Utils.ExceptionFunction<ConnectionFactory,? extends Connection> function) Set a callback that will be passed in the ConnectionFactory of this ReceiverOptions instance to create a Connection.
Duration	getConnectionClosingTimeout()
ConnectionFactory	getConnectionFactory()
Mono<? extends Connection>	getConnectionMono()
Function<Mono<? extends Connection>,Mono<? extends Connection>>	getConnectionMonoConfigurator()
Scheduler	getConnectionSubscriptionScheduler()
Utils.ExceptionFunction<ConnectionFactory,? extends Connection>	getConnectionSupplier()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiverOptions

public ReceiverOptions()

Method Detail

getConnectionFactory

public ConnectionFactory getConnectionFactory()

connectionFactory

public ReceiverOptions connectionFactory(ConnectionFactory connectionFactory)

getConnectionSubscriptionScheduler

@Nullable
public Scheduler getConnectionSubscriptionScheduler()

connectionSubscriptionScheduler

public ReceiverOptions 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 ReceiverOptions instance

connectionSupplier

public ReceiverOptions connectionSupplier(Utils.ExceptionFunction<ConnectionFactory,? extends Connection> function)

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

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

Parameters:

function - callback to create a Connection

Returns:

this current ReceiverOptions instance

connectionSupplier

public ReceiverOptions connectionSupplier(ConnectionFactory connectionFactory,
                                          Utils.ExceptionFunction<ConnectionFactory,? extends 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 Receiver instance, which will cache it for re-use in its operations and close it when Receiver.close() is called.

Parameters:

connectionFactory - the ConnectionFactory passed-in to the creation function

function - callback to create a Connection

Returns:

this current ReceiverOptions

connectionMono

public ReceiverOptions connectionMono(@Nullable
                                      Mono<? extends Connection> connectionMono)

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

A Receiver created from this ReceiverOptions instance will not cache for re-use, nor close on Receiver.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 Receiver does an operation. It is the developer's responsibility to close the underlying Connection once the Receiver is closed and no longer needs it.

Parameters:

connectionMono -

Returns:

this current ReceiverOptions

connectionMonoConfigurator

public ReceiverOptions connectionMonoConfigurator(Function<Mono<? extends Connection>,Mono<? extends Connection>> connectionMonoConfigurator)

A Function to customize the connection Mono used in the created Receiver 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

getConnectionMono

@Nullable
public Mono<? extends Connection> getConnectionMono()

getConnectionSupplier

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

getConnectionMonoConfigurator

public Function<Mono<? extends Connection>,Mono<? extends Connection>> getConnectionMonoConfigurator()

connectionClosingTimeout

public ReceiverOptions connectionClosingTimeout(@Nullable
                                                Duration connectionClosingTimeout)

Timeout for closing the Receiver connection.

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

Parameters:

connectionClosingTimeout - timeout for connection closing

Returns:

this ReceiverOptions instance

Since:

1.3.0

getConnectionClosingTimeout

@Nullable
public Duration getConnectionClosingTimeout()