org.agrona.concurrent

Enum ControlledMessageHandler.Action

java.lang.Object

java.lang.Enum<ControlledMessageHandler.Action>

org.agrona.concurrent.ControlledMessageHandler.Action

All Implemented Interfaces:

Serializable, Comparable<ControlledMessageHandler.Action>

Enclosing interface:

ControlledMessageHandler

public static enum ControlledMessageHandler.Action
extends Enum<ControlledMessageHandler.Action>

Action to be taken on return from ControlledMessageHandler.onMessage(int, MutableDirectBuffer, int, int).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Abort the current read operation and do not advance the position for this message.
BREAK Break from the current read operation and commit the position as of the end of the current message being handled.
COMMIT Continue processing but commit the position as of the end of the current message so that flow control is applied to this point.
CONTINUE Continue processing until limit or no messages with position commit at end of read as the in ControlledMessageHandler.onMessage(int, MutableDirectBuffer, int, int).

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ABORT

public static final ControlledMessageHandler.Action ABORT

Abort the current read operation and do not advance the position for this message.

BREAK

public static final ControlledMessageHandler.Action BREAK

Break from the current read operation and commit the position as of the end of the current message being handled.

COMMIT

public static final ControlledMessageHandler.Action COMMIT

Continue processing but commit the position as of the end of the current message so that flow control is applied to this point.

CONTINUE

public static final ControlledMessageHandler.Action CONTINUE

Continue processing until limit or no messages with position commit at end of read as the in ControlledMessageHandler.onMessage(int, MutableDirectBuffer, int, int).

Method Detail

values

public static ControlledMessageHandler.Action[] 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 (ControlledMessageHandler.Action c : ControlledMessageHandler.Action.values())
    System.out.println(c);

Returns:

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

valueOf

public static ControlledMessageHandler.Action 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