org.eclipse.jetty.websocket.api

Enum BatchMode

java.lang.Object

java.lang.Enum<BatchMode>

org.eclipse.jetty.websocket.api.BatchMode

All Implemented Interfaces:

Serializable, Comparable<BatchMode>

public enum BatchMode
extends Enum<BatchMode>

The possible batch modes when invoking OutgoingFrames#outgoingFrame(Frame, WriteCallback, BatchMode).

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Implementers are free to decide whether to send or not frames to the network layer.
OFF Implementers must send frames to the network layer.
ON Implementers must batch frames.

Method Summary

Methods

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

AUTO

public static final BatchMode AUTO

Implementers are free to decide whether to send or not frames to the network layer.

ON

public static final BatchMode ON

Implementers must batch frames.

OFF

public static final BatchMode OFF

Implementers must send frames to the network layer.

Method Detail

values

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

Returns:

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

valueOf

public static BatchMode 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

max

public static BatchMode max(BatchMode one,
            BatchMode two)