io.atomix.group.messaging

Enum MessageProducer.Execution

java.lang.Object

java.lang.Enum<MessageProducer.Execution>

io.atomix.group.messaging.MessageProducer.Execution

All Implemented Interfaces:

Serializable, Comparable<MessageProducer.Execution>

Enclosing interface:

MessageProducer<T>

public static enum MessageProducer.Execution
extends Enum<MessageProducer.Execution>

Execution policy for defining the criteria for completion of a message produced by a producer.

Execution policies define how a producer interacts with the cluster and the type of feedback a producer expects from consumers. Producers send messages through the Atomix cluster, and send operations may be completed when committed to the cluster or when acknowledged by consumers depending on the configured execution policy.

• SYNC producers send messages to consumers and await acknowledgement from the consumer side of the queue. If a producer is producing to an entire group, synchronous producers will await acknowledgement from all members of the group.
• ASYNC producers await acknowledgement of persistence in the cluster but not acknowledgement that messages have been received and processed by consumers.
• REQUEST_REPLY producers await arbitrary responses from all consumers to which a message is sent. If a message is sent to a group of consumers, message reply futures will be completed with a list of reply values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASYNC Awaits acknowledgement of persistence in the cluster but not acknowledgement that messages have been received and processed by consumers.
REQUEST_REPLY Awaits arbitrary responses from all consumers to which a message is sent.
SYNC Sends messages to consumers and awaits acknowledgement from the consumer side of the queue.

Method Summary

Modifier and Type	Method and Description
static MessageProducer.Execution	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageProducer.Execution[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYNC

public static final MessageProducer.Execution SYNC

Sends messages to consumers and awaits acknowledgement from the consumer side of the queue. If a producer is producing to an entire group, synchronous producers will await acknowledgement from all members of the group.

ASYNC

public static final MessageProducer.Execution ASYNC

Awaits acknowledgement of persistence in the cluster but not acknowledgement that messages have been received and processed by consumers. Once a message is completed by a asynchronous producer, the message is guaranteed to be persisted on a majority of the cluster and will eventually be delivered to consumers.

REQUEST_REPLY

public static final MessageProducer.Execution REQUEST_REPLY

Awaits arbitrary responses from all consumers to which a message is sent. If a message is sent to a group of consumers, message reply futures will be completed with a list of reply values.

Method Detail

values

public static MessageProducer.Execution[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MessageProducer.Execution c : MessageProducer.Execution.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessageProducer.Execution valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null