Package com.linecorp.armeria.common.stream

Enum Class StreamTimeoutMode

java.lang.Object

java.lang.Enum<StreamTimeoutMode>

com.linecorp.armeria.common.stream.StreamTimeoutMode

All Implemented Interfaces:

Serializable, Comparable<StreamTimeoutMode>, Constable

@UnstableApi
public enum StreamTimeoutMode
extends Enum<StreamTimeoutMode>

Stream Timeout Mode consists of three modes.

• UNTIL_FIRST - Based on the first data chunk. If the first data chunk is not received within the specified time, a StreamTimeoutException is thrown.
• UNTIL_NEXT - Based on each data chunk. If each data chunk is not received within the specified time after the previous chunk, a StreamTimeoutException is thrown.
• UNTIL_EOS - Based on the entire stream. If all data chunks are not received within the specified time before the end of the stream, a StreamTimeoutException is thrown.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
UNTIL_EOS	Based on the entire stream.
UNTIL_FIRST	Based on the first data chunk.
UNTIL_NEXT	Based on each data chunk.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNTIL_FIRST

public static final StreamTimeoutMode UNTIL_FIRST

Based on the first data chunk. If the first data chunk is not received within the specified time, a StreamTimeoutException is thrown.

UNTIL_NEXT

public static final StreamTimeoutMode UNTIL_NEXT

Based on each data chunk. If each data chunk is not received within the specified time after the previous chunk, a StreamTimeoutException is thrown.

UNTIL_EOS

public static final StreamTimeoutMode UNTIL_EOS

Based on the entire stream. If all data chunks are not received within the specified time before the end of the stream, a StreamTimeoutException is thrown.

Method Details

values

public static StreamTimeoutMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StreamTimeoutMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null