io.netty.handler.codec.http2

Interface Http2GoAwayFrame

All Superinterfaces:

ByteBufHolder, Http2Frame, ReferenceCounted

All Known Implementing Classes:

DefaultHttp2GoAwayFrame

@UnstableApi
public interface Http2GoAwayFrame
extends Http2Frame, ByteBufHolder

HTTP/2 GOAWAY frame.

The last stream identifier must not be set by the application, but instead the relative extraStreamIds() should be used. The lastStreamId() will only be set for incoming GOAWAY frames by the HTTP/2 codec.

Graceful shutdown as described in the HTTP/2 spec can be accomplished by calling #setExtraStreamIds(Integer.MAX_VALUE).

Method Summary

Modifier and Type	Method and Description
ByteBuf	content() Optional debugging information describing cause the GOAWAY.
Http2GoAwayFrame	copy() Creates a deep copy of this ByteBufHolder.
Http2GoAwayFrame	duplicate() Duplicates this ByteBufHolder.
long	errorCode() The reason for beginning closure of the connection.
int	extraStreamIds() The number of IDs to reserve for the receiver to use while GOAWAY is in transit.
int	lastStreamId() Returns the last stream identifier if set, or -1 else.
Http2GoAwayFrame	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
Http2GoAwayFrame	retain() Increases the reference count by 1.
Http2GoAwayFrame	retain(int increment) Increases the reference count by the specified increment.
Http2GoAwayFrame	retainedDuplicate() Duplicates this ByteBufHolder.
Http2GoAwayFrame	setExtraStreamIds(int extraStreamIds) Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.
Http2GoAwayFrame	touch() Records the current access location of this object for debugging purposes.
Http2GoAwayFrame	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from interface io.netty.handler.codec.http2.Http2Frame

name

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Method Detail

errorCode

long errorCode()

The reason for beginning closure of the connection. Represented as an HTTP/2 error code.

extraStreamIds

int extraStreamIds()

The number of IDs to reserve for the receiver to use while GOAWAY is in transit. This allows for new streams currently en route to still be created, up to a point, which allows for very graceful shutdown of both sides.

setExtraStreamIds

Http2GoAwayFrame setExtraStreamIds(int extraStreamIds)

Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.

Returns:

this

See Also:

extraStreamIds()

lastStreamId

int lastStreamId()

Returns the last stream identifier if set, or -1 else.

content

ByteBuf content()

Optional debugging information describing cause the GOAWAY. Will not be null, but may be empty.

Specified by:

content in interface ByteBufHolder

copy

Http2GoAwayFrame copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

duplicate

Http2GoAwayFrame duplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

Specified by:

duplicate in interface ByteBufHolder

retainedDuplicate

Http2GoAwayFrame retainedDuplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

Specified by:

retainedDuplicate in interface ByteBufHolder

See Also:

ByteBuf.retainedDuplicate()

replace

Http2GoAwayFrame replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface ByteBufHolder

retain

Http2GoAwayFrame retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

retain

Http2GoAwayFrame retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

touch

Http2GoAwayFrame touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

touch

Http2GoAwayFrame touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted