io.atomix.group.messaging

Enum MessageProducer.Delivery

java.lang.Object

java.lang.Enum<MessageProducer.Delivery>

io.atomix.group.messaging.MessageProducer.Delivery

All Implemented Interfaces:

Serializable, Comparable<MessageProducer.Delivery>

Enclosing interface:

MessageProducer<T>

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

Delivery policy for defining how messages are delivered to consumers, particularly when producing messages to a group.

Delivery policies define how messages are delivered to consumers once persisted in the Atomix cluster. When sending messages directly to a specific member of a group, delivery policies typically do not apply. However, for producers created via the group-wide MessageClient, delivery policies allow producers to control how the cluster delivers messages to producers.

• DIRECT producers send messages directly to specific group members. This option applies only to producers constructed from GroupMember messaging clients.
• RANDOM producers send each message to a random member of the group. In the event that a message is not successfully acknowledged by a member and that member fails or leaves the group, random messages will be redelivered to remaining members of the group.
• BROADCAST producers send messages to all available members of a group. This option applies only to producers constructed from DistributedGroup messaging clients.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROADCAST Sends messages to all available members of a group.
DIRECT Sends messages directly to specific group members.
RANDOM Sends each message to a random member of the group.

Method Summary

Modifier and Type	Method and Description
static MessageProducer.Delivery	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageProducer.Delivery[]	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

DIRECT

public static final MessageProducer.Delivery DIRECT

Sends messages directly to specific group members. This option applies only to producers constructed from GroupMember messaging clients.

RANDOM

public static final MessageProducer.Delivery RANDOM

Sends each message to a random member of the group. In the event that a message is not successfully acknowledged by a member and that member fails or leaves the group, random messages will be redelivered to remaining members of the group.

BROADCAST

public static final MessageProducer.Delivery BROADCAST

Sends messages to all available members of a group. This option applies only to producers constructed from DistributedGroup messaging clients.

Method Detail

values

public static MessageProducer.Delivery[] 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.Delivery c : MessageProducer.Delivery.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.Delivery 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