io.atomix.coordination

Interface MessageProducer<T>

public interface MessageProducer<T>

Message bus topic producer.

Message producers are responsible for producing messages to a DistributedMessageBus topic. Producers are created via DistributedMessageBus.producer(String). Messages produced by the producer are sent in round-robin order to listening MessageConsumers. If more than one consumer is listening on the topic, only one consumer will receive any given message.

Author:

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close() Closes the producer.
<U> CompletableFuture<U>	send(T message) Sends a message to a consumer for the topic.
String	topic() Returns the topic for which the producer produces messages.

Method Detail

topic

String topic()

Returns the topic for which the producer produces messages.

Returns:

The topic for which the producer produces messages.

send

<U> CompletableFuture<U> send(T message)

Sends a message to a consumer for the topic.

If no consumers are listening to the topic(), the returned CompletableFuture will be immediately completed. If multiple consumers are listening to the topic, the message will be sent to only one consumer. Consumers are rotated in round-robin order.

Type Parameters:

U - The message response type.

Parameters:

message - The message to send.

Returns:

A completable future to be completed once the message has been received.

close

CompletableFuture<Void> close()

Closes the producer.

Returns:

A completable future to be completed once the producer is closed.