Package io.grpc.internal

Enum Class GrpcUtil.Http2Error

java.lang.Object

java.lang.Enum<GrpcUtil.Http2Error>

io.grpc.internal.GrpcUtil.Http2Error

All Implemented Interfaces:

Serializable, Comparable<GrpcUtil.Http2Error>, Constable

Enclosing class:

GrpcUtil

public static enum GrpcUtil.Http2Error
extends Enum<GrpcUtil.Http2Error>

All error codes identified by the HTTP/2 spec. Used in GOAWAY and RST_STREAM frames.

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
CANCEL
COMPRESSION_ERROR
CONNECT_ERROR
ENHANCE_YOUR_CALM
FLOW_CONTROL_ERROR
FRAME_SIZE_ERROR
HTTP_1_1_REQUIRED
INADEQUATE_SECURITY
INTERNAL_ERROR
NO_ERROR	Servers implementing a graceful shutdown of the connection will send GOAWAY with NO_ERROR.
PROTOCOL_ERROR
REFUSED_STREAM
SETTINGS_TIMEOUT
STREAM_CLOSED

Method Summary

Modifier and Type	Method	Description
long	code()	Gets the code for this error used on the wire.
static GrpcUtil.Http2Error	forCode(long code)	Looks up the HTTP/2 error code enum value for the specified code.
Status	status()	Gets the Status associated with this HTTP/2 code.
static Status	statusForCode(long code)	Looks up the Status from the given HTTP/2 error code.
static GrpcUtil.Http2Error	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GrpcUtil.Http2Error[]	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

NO_ERROR

public static final GrpcUtil.Http2Error NO_ERROR

Servers implementing a graceful shutdown of the connection will send GOAWAY with NO_ERROR. In this case it is important to indicate to the application that the request should be retried (i.e. Status.UNAVAILABLE).

PROTOCOL_ERROR

public static final GrpcUtil.Http2Error PROTOCOL_ERROR

INTERNAL_ERROR

public static final GrpcUtil.Http2Error INTERNAL_ERROR

FLOW_CONTROL_ERROR

public static final GrpcUtil.Http2Error FLOW_CONTROL_ERROR

SETTINGS_TIMEOUT

public static final GrpcUtil.Http2Error SETTINGS_TIMEOUT

STREAM_CLOSED

public static final GrpcUtil.Http2Error STREAM_CLOSED

FRAME_SIZE_ERROR

public static final GrpcUtil.Http2Error FRAME_SIZE_ERROR

REFUSED_STREAM

public static final GrpcUtil.Http2Error REFUSED_STREAM

CANCEL

public static final GrpcUtil.Http2Error CANCEL

COMPRESSION_ERROR

public static final GrpcUtil.Http2Error COMPRESSION_ERROR

CONNECT_ERROR

public static final GrpcUtil.Http2Error CONNECT_ERROR

ENHANCE_YOUR_CALM

public static final GrpcUtil.Http2Error ENHANCE_YOUR_CALM

INADEQUATE_SECURITY

public static final GrpcUtil.Http2Error INADEQUATE_SECURITY

HTTP_1_1_REQUIRED

public static final GrpcUtil.Http2Error HTTP_1_1_REQUIRED

Method Details

values

public static GrpcUtil.Http2Error[] 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 GrpcUtil.Http2Error 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 long code()

Gets the code for this error used on the wire.

status

public Status status()

Gets the Status associated with this HTTP/2 code.

forCode

public static GrpcUtil.Http2Error forCode(long code)

Looks up the HTTP/2 error code enum value for the specified code.

Parameters:

code - an HTTP/2 error code value.

Returns:

the HTTP/2 error code enum or null if not found.

statusForCode

public static Status statusForCode(long code)

Looks up the Status from the given HTTP/2 error code. This is preferred over forCode(code).status(), to more easily conform to HTTP/2:

Unknown or unsupported error codes MUST NOT trigger any special behavior. These MAY be treated by an implementation as being equivalent to INTERNAL_ERROR.

Parameters:

code - the HTTP/2 error code.

Returns:

a Status representing the given error.