Package com.rabbitmq.client

Class RpcClientParams

java.lang.Object

com.rabbitmq.client.RpcClientParams

public class RpcClientParams
extends java.lang.Object

Holder class to configure a RpcClient.

Since:

5.6.0

See Also:

RpcClient(RpcClientParams)

Field Summary

Fields

Modifier and Type	Field	Description
private Channel	channel	Channel we are communicating on
private java.util.function.Supplier<java.lang.String>	correlationIdSupplier	Logic to generate correlation IDs.
private java.lang.String	exchange	Exchange to send requests to
private java.util.function.Function<java.lang.Object,RpcClient.Response>	replyHandler	Behavior to handle reply messages.
private java.lang.String	replyTo	Queue where the server should put the reply
private java.lang.String	routingKey	Routing key to use for requests
private int	timeout	Timeout in milliseconds to use on call responses
private boolean	useMandatory	Whether to publish RPC requests with the mandatory flag or not.

Constructor Summary

Constructors

Constructor	Description
RpcClientParams()

Method Summary

Modifier and Type	Method	Description
RpcClientParams	channel(Channel channel)
RpcClientParams	correlationIdSupplier(java.util.function.Supplier<java.lang.String> correlationIdGenerator)	Logic to generate correlation IDs.
RpcClientParams	exchange(java.lang.String exchange)
Channel	getChannel()	Set the channel to use for communication.
java.util.function.Supplier<java.lang.String>	getCorrelationIdSupplier()
java.lang.String	getExchange()	Set the exchange to send requests to.
java.util.function.Function<java.lang.Object,RpcClient.Response>	getReplyHandler()
java.lang.String	getReplyTo()
java.lang.String	getRoutingKey()
int	getTimeout()
RpcClientParams	replyHandler(java.util.function.Function<java.lang.Object,RpcClient.Response> replyHandler)	Set the behavior to use when receiving replies.
RpcClientParams	replyTo(java.lang.String replyTo)	Set the queue where the server should put replies on.
RpcClientParams	routingKey(java.lang.String routingKey)	Set the routing key to use for requests.
boolean	shouldUseMandatory()
RpcClientParams	timeout(int timeout)	Set the timeout in milliseconds to use on call responses.
RpcClientParams	useMandatory()	Instructs to use the mandatory flag when publishing RPC requests.
RpcClientParams	useMandatory(boolean useMandatory)	Whether to publish RPC requests with the mandatory flag or not.

Methods inherited from class java.lang.Object

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

Field Detail

channel

private Channel channel

Channel we are communicating on

exchange

private java.lang.String exchange

Exchange to send requests to

routingKey

private java.lang.String routingKey

Routing key to use for requests

replyTo

private java.lang.String replyTo

Queue where the server should put the reply

timeout

private int timeout

Timeout in milliseconds to use on call responses

useMandatory

private boolean useMandatory

Whether to publish RPC requests with the mandatory flag or not.

replyHandler

private java.util.function.Function<java.lang.Object,RpcClient.Response> replyHandler

Behavior to handle reply messages.

correlationIdSupplier

private java.util.function.Supplier<java.lang.String> correlationIdSupplier

Logic to generate correlation IDs.

Constructor Detail

RpcClientParams

public RpcClientParams()

Method Detail

getChannel

public Channel getChannel()

Set the channel to use for communication.

Returns:

channel

public RpcClientParams channel(Channel channel)

getExchange

public java.lang.String getExchange()

Set the exchange to send requests to.

Returns:

exchange

public RpcClientParams exchange(java.lang.String exchange)

getRoutingKey

public java.lang.String getRoutingKey()

routingKey

public RpcClientParams routingKey(java.lang.String routingKey)

Set the routing key to use for requests.

Parameters:

routingKey -

Returns:

getReplyTo

public java.lang.String getReplyTo()

replyTo

public RpcClientParams replyTo(java.lang.String replyTo)

Set the queue where the server should put replies on.

The default is to use Direct Reply-to. Using another value will cause the creation of a temporary private auto-delete queue.

The default shouldn't be changed for performance reasons.

Parameters:

replyTo -

Returns:

getTimeout

public int getTimeout()

timeout

public RpcClientParams timeout(int timeout)

Set the timeout in milliseconds to use on call responses.

Parameters:

timeout -

Returns:

useMandatory

public RpcClientParams useMandatory(boolean useMandatory)

Whether to publish RPC requests with the mandatory flag or not.

Default is to not publish requests with the mandatory flag set to true.

When set to true, unroutable requests will result in UnroutableRpcRequestException exceptions thrown. Use a custom reply handler to change this behavior.

Parameters:

useMandatory -

Returns:

See Also:

replyHandler(Function)

useMandatory

public RpcClientParams useMandatory()

Instructs to use the mandatory flag when publishing RPC requests.

Unroutable requests will result in UnroutableRpcRequestException exceptions thrown. Use a custom reply handler to change this behavior.

Returns:

See Also:

replyHandler(Function)

shouldUseMandatory

public boolean shouldUseMandatory()

correlationIdSupplier

public RpcClientParams correlationIdSupplier(java.util.function.Supplier<java.lang.String> correlationIdGenerator)

Logic to generate correlation IDs.

Parameters:

correlationIdGenerator -

Returns:

Since:

5.9.0

getCorrelationIdSupplier

public java.util.function.Supplier<java.lang.String> getCorrelationIdSupplier()

getReplyHandler

public java.util.function.Function<java.lang.Object,RpcClient.Response> getReplyHandler()

replyHandler

public RpcClientParams replyHandler(java.util.function.Function<java.lang.Object,RpcClient.Response> replyHandler)

Set the behavior to use when receiving replies.

The default is to wrap the reply into a RpcClient.Response instance. Unroutable requests will result in UnroutableRpcRequestException exceptions.

Parameters:

replyHandler -

Returns:

See Also:

useMandatory(), useMandatory(boolean)