Package com.vaadin.flow.server.communication

Enum Class SsePushConnection.State

java.lang.Object

java.lang.Enum<SsePushConnection.State>

com.vaadin.flow.server.communication.SsePushConnection.State

All Implemented Interfaces:

Serializable, Comparable<SsePushConnection.State>, Constable

Enclosing class:

SsePushConnection

protected static enum SsePushConnection.State
extends Enum<SsePushConnection.State>

Connection states for SSE push.

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
CONNECTED	Connected.
DISCONNECTED	Not connected.
PUSH_PENDING	Not connected.
RESPONSE_PENDING	Not connected.

Method Summary

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

DISCONNECTED

public static final SsePushConnection.State DISCONNECTED

Not connected. Trying to push will set the connection state to PUSH_PENDING or RESPONSE_PENDING and defer sending the message until a connection is established.

PUSH_PENDING

public static final SsePushConnection.State PUSH_PENDING

Not connected. An asynchronous push is pending the opening of the connection.

RESPONSE_PENDING

public static final SsePushConnection.State RESPONSE_PENDING

Not connected. A response to a client request is pending the opening of the connection.

CONNECTED

public static final SsePushConnection.State CONNECTED

Connected. Messages can be sent through the connection.

Method Details

values

public static SsePushConnection.State[] 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 SsePushConnection.State 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