Enum Class SseConnection.TerminationReason

java.lang.Object

java.lang.Enum<SseConnection.TerminationReason>

com.soklet.SseConnection.TerminationReason

All Implemented Interfaces:

Serializable, Comparable<SseConnection.TerminationReason>, Constable

Enclosing interface:

SseConnection

public static enum SseConnection.TerminationReason
extends Enum<SseConnection.TerminationReason>

Categorizes why a Server-Sent Event connection terminated.

Author:

Mark Allen

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKPRESSURE	Connection was closed due to backpressure (write queue at capacity).
ERROR	Connection ended due to an error while processing or writing.
REMOTE_CLOSE	Connection ended because the remote peer closed the socket.
SERVER_STOP	Connection was closed during server shutdown.
UNKNOWN	Connection ended for an unspecified reason.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BACKPRESSURE

public static final SseConnection.TerminationReason BACKPRESSURE

Connection was closed due to backpressure (write queue at capacity).

SERVER_STOP

public static final SseConnection.TerminationReason SERVER_STOP

Connection was closed during server shutdown.

ERROR

public static final SseConnection.TerminationReason ERROR

Connection ended due to an error while processing or writing.

REMOTE_CLOSE

public static final SseConnection.TerminationReason REMOTE_CLOSE

Connection ended because the remote peer closed the socket.

UNKNOWN

public static final SseConnection.TerminationReason UNKNOWN

Connection ended for an unspecified reason.

Method Details

values

public static SseConnection.TerminationReason[] 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 SseConnection.TerminationReason 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