io.netty.handler.codec.http2

Enum Http2Exception.ShutdownHint

java.lang.Object

java.lang.Enum<Http2Exception.ShutdownHint>

io.netty.handler.codec.http2.Http2Exception.ShutdownHint

All Implemented Interfaces:

Serializable, Comparable<Http2Exception.ShutdownHint>

Enclosing class:

Http2Exception

public static enum Http2Exception.ShutdownHint
extends Enum<Http2Exception.ShutdownHint>

Provides a hint as to if shutdown is justified, what type of shutdown should be executed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GRACEFUL_SHUTDOWN Attempt to execute a "graceful" shutdown.
HARD_SHUTDOWN Close the channel immediately after a GOAWAY is sent.
NO_SHUTDOWN Do not shutdown the underlying channel.

Method Summary

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

NO_SHUTDOWN

public static final Http2Exception.ShutdownHint NO_SHUTDOWN

Do not shutdown the underlying channel.

GRACEFUL_SHUTDOWN

public static final Http2Exception.ShutdownHint GRACEFUL_SHUTDOWN

Attempt to execute a "graceful" shutdown. The definition of "graceful" is left to the implementation. An example of "graceful" would be wait for some amount of time until all active streams are closed.

HARD_SHUTDOWN

public static final Http2Exception.ShutdownHint HARD_SHUTDOWN

Close the channel immediately after a GOAWAY is sent.

Method Detail

values

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

Returns:

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

valueOf

public static Http2Exception.ShutdownHint 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