com.rabbitmq.stream

Interface ProducerBuilder

public interface ProducerBuilder

API to create and configure a Producer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProducerBuilder.RoutingConfiguration Routing configuration for super streams (partitioned streams).

Method Summary

Modifier and Type	Method and Description
ProducerBuilder	batchPublishingDelay(Duration batchPublishingDelay) Period to send a batch of messages.
ProducerBuilder	batchSize(int batchSize) The maximum number of messages to accumulate before sending them to the broker.
Producer	build() Create the Producer instance.
ProducerBuilder	compression(Compression compression)
ProducerBuilder	confirmTimeout(Duration timeout) Time before the client calls the confirm callback to signal outstanding unconfirmed messages timed out.
ProducerBuilder	enqueueTimeout(Duration timeout) Time before enqueueing of a message fail when the maximum number of unconfirmed is reached.
ProducerBuilder	maxUnconfirmedMessages(int maxUnconfirmedMessages) The maximum number of unconfirmed outbound messages.
ProducerBuilder	name(String name) The logical name of the producer.
ProducerBuilder.RoutingConfiguration	routing(Function<Message,String> routingKeyExtractor) Configure the routing for super streams (partitioned streams).
ProducerBuilder	stream(String stream) The stream to send messages to.
ProducerBuilder	subEntrySize(int subEntrySize) The number of messages to put in a sub-entry of a publish frame.

Method Detail

name

ProducerBuilder name(String name)

The logical name of the producer.

Set a value to enable de-duplication.

Parameters:

name -

Returns:

this builder instance

stream

ProducerBuilder stream(String stream)

The stream to send messages to.

Parameters:

stream -

Returns:

this builder instance

subEntrySize

ProducerBuilder subEntrySize(int subEntrySize)

The number of messages to put in a sub-entry of a publish frame.

The default is 1 (no sub-entry batching).

Parameters:

subEntrySize -

Returns:

this builder instance

compression

ProducerBuilder compression(Compression compression)

batchSize

ProducerBuilder batchSize(int batchSize)

The maximum number of messages to accumulate before sending them to the broker.

Default is 100.

Parameters:

batchSize -

Returns:

this builder instance

batchPublishingDelay

ProducerBuilder batchPublishingDelay(Duration batchPublishingDelay)

Period to send a batch of messages.

Default is 100 ms.

Parameters:

batchPublishingDelay -

Returns:

this builder instance

maxUnconfirmedMessages

ProducerBuilder maxUnconfirmedMessages(int maxUnconfirmedMessages)

The maximum number of unconfirmed outbound messages.

Producer.send(Message, ConfirmationHandler) will start blocking when the limit is reached.

Default is 10,000.

Parameters:

maxUnconfirmedMessages -

Returns:

this builder instance

confirmTimeout

ProducerBuilder confirmTimeout(Duration timeout)

Time before the client calls the confirm callback to signal outstanding unconfirmed messages timed out.

Default is 30 seconds.

Parameters:

timeout -

Returns:

this builder instance

enqueueTimeout

ProducerBuilder enqueueTimeout(Duration timeout)

Time before enqueueing of a message fail when the maximum number of unconfirmed is reached.

Default is 10 seconds.

Set the value to Duration.ZERO if there should be no timeout.

Parameters:

timeout -

Returns:

this builder instance

build

Producer build()

Create the Producer instance.

Returns:

the configured producer

routing

ProducerBuilder.RoutingConfiguration routing(Function<Message,String> routingKeyExtractor)

Configure the routing for super streams (partitioned streams).

This is an experimental API, subject to change.

The to-be-created producer will be a composite producer when this method is called. It will use the routing configuration to find out where a message should be routed. The application developer must provide the logic to extract a "routing key" from a message, which will decide the destination(s) of the message.

The default routing strategy hashes the routing key to choose the stream (partition) to send the message to.

Note the routing key extraction logic is required only when the built-in routing strategies are used. It can set to null when a custom RoutingStrategy is set with routing(Function).

Parameters:

routingKeyExtractor - the logic to extract a routing key from a message

Returns:

the routing configuration instance

See Also:

ProducerBuilder.RoutingConfiguration