io.netty.handler.codec.http2

Class DefaultHttp2GoAwayFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.http2.DefaultHttp2GoAwayFrame

All Implemented Interfaces:

ByteBufHolder, Http2Frame, Http2GoAwayFrame, ReferenceCounted

public final class DefaultHttp2GoAwayFrame
extends DefaultByteBufHolder
implements Http2GoAwayFrame

The default Http2GoAwayFrame implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultHttp2GoAwayFrame(Http2Error error) Equivalent to new DefaultHttp2GoAwayFrame(error.code()).
DefaultHttp2GoAwayFrame(Http2Error error, ByteBuf content) Equivalent to new DefaultHttp2GoAwayFrame(error.code(), content).
DefaultHttp2GoAwayFrame(long errorCode) Equivalent to new DefaultHttp2GoAwayFrame(content, Unpooled.EMPTY_BUFFER).
DefaultHttp2GoAwayFrame(long errorCode, ByteBuf content) Construct a new GOAWAY message.

Method Summary

Methods

Modifier and Type	Method and Description
DefaultHttp2GoAwayFrame	copy() Create a deep copy of this ByteBufHolder.
DefaultHttp2GoAwayFrame	duplicate() Duplicate the ByteBufHolder.
boolean	equals(Object o)
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	hashCode()
DefaultHttp2GoAwayFrame	retain() Increases the reference count by 1.
DefaultHttp2GoAwayFrame	retain(int increment) Increases the reference count by the specified increment.
DefaultHttp2GoAwayFrame	setExtraStreamIds(int extraStreamIds) Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.
String	toString()
DefaultHttp2GoAwayFrame	touch() Records the current access location of this object for debugging purposes.
DefaultHttp2GoAwayFrame	touch(Object hint) Records the current access location of this object with an additonal arbitrary information for debugging purposes.

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, contentToString, refCnt, release, release

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

content

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Constructor Detail

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(Http2Error error)

Equivalent to new DefaultHttp2GoAwayFrame(error.code()).

Parameters:

error - non-null reason for the go away

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(long errorCode)

Equivalent to new DefaultHttp2GoAwayFrame(content, Unpooled.EMPTY_BUFFER).

Parameters:

error - reason for the go away

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(Http2Error error,
                       ByteBuf content)

Equivalent to new DefaultHttp2GoAwayFrame(error.code(), content).

Parameters:

error - non-null reason for the go away

content - non-null debug data

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(long errorCode,
                       ByteBuf content)

Construct a new GOAWAY message.

Parameters:

error - reason for the go away

content - non-null debug data

Method Detail

errorCode

public long errorCode()

Description copied from interface: Http2GoAwayFrame

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

Specified by:

errorCode in interface Http2GoAwayFrame

extraStreamIds

public int extraStreamIds()

Description copied from interface: Http2GoAwayFrame

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.

Specified by:

extraStreamIds in interface Http2GoAwayFrame

setExtraStreamIds

public DefaultHttp2GoAwayFrame setExtraStreamIds(int extraStreamIds)

Description copied from interface: Http2GoAwayFrame

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

Specified by:

setExtraStreamIds in interface Http2GoAwayFrame

Returns:

this

See Also:

Http2GoAwayFrame.extraStreamIds()

copy

public DefaultHttp2GoAwayFrame copy()

Description copied from interface: ByteBufHolder

Create a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface Http2GoAwayFrame

Overrides:

copy in class DefaultByteBufHolder

duplicate

public DefaultHttp2GoAwayFrame duplicate()

Description copied from interface: ByteBufHolder

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

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface Http2GoAwayFrame

Overrides:

duplicate in class DefaultByteBufHolder

retain

public DefaultHttp2GoAwayFrame retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface Http2GoAwayFrame

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

retain

public DefaultHttp2GoAwayFrame 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 Http2GoAwayFrame

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

toString

public String toString()

Overrides:

toString in class DefaultByteBufHolder

touch

public DefaultHttp2GoAwayFrame 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 Http2GoAwayFrame

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

touch

public DefaultHttp2GoAwayFrame touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additonal 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 Http2GoAwayFrame

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object