Package org.microproxy

Enum Class ServerState

java.lang.Object

java.lang.Enum<ServerState>

org.microproxy.ServerState

All Implemented Interfaces:

Serializable, Comparable<ServerState>, Constable

public enum ServerState
extends Enum<ServerState>

Where a proxy is in its life (HttpProxyServer.state()), with the names Envoy's admin /ready answers and the numbers its server.state gauge shows. A proxy goes from INITIALIZING to LIVE as it starts, to DRAINING when it is drained or stops accepting, and to STOPPED once it has stopped.

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
DRAINING	Draining (HttpProxyServer.drain(java.time.Duration)), no longer accepting (HttpProxyServer.stopListeners()), or stopping: not ready for new traffic.
INITIALIZING	Starting: the admin listener may answer while the proxy's own listeners are being bound.
LIVE	Serving: accepting connections and requests.
PRE_INITIALIZING	Made, not started yet.
STOPPED	Stopped: every listener and connection closed.

Method Summary

Modifier and Type	Method	Description
int	code()	Returns the value of the server.state gauge in this state, Envoy's number for it.
static ServerState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServerState[]	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

LIVE

public static final ServerState LIVE

Serving: accepting connections and requests. server.state 0.

DRAINING

public static final ServerState DRAINING

Draining (HttpProxyServer.drain(java.time.Duration)), no longer accepting (HttpProxyServer.stopListeners()), or stopping: not ready for new traffic. server.state 1.

PRE_INITIALIZING

public static final ServerState PRE_INITIALIZING

Made, not started yet. server.state 2.

INITIALIZING

public static final ServerState INITIALIZING

Starting: the admin listener may answer while the proxy's own listeners are being bound. server.state 3.

STOPPED

public static final ServerState STOPPED

Stopped: every listener and connection closed. server.state 4, MicroProxy's own (Envoy has no such state).

Method Details

values

public static ServerState[] 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 ServerState 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

code

public int code()

Returns the value of the server.state gauge in this state, Envoy's number for it.

Returns:

the value of the server.state gauge in this state, Envoy's number for it