Package io.netty5.handler.codec.http2

Class DefaultHttp2GoAwayFrame

java.lang.Object

io.netty5.buffer.BufferHolder<Http2GoAwayFrame>

io.netty5.handler.codec.http2.DefaultHttp2GoAwayFrame

All Implemented Interfaces:

Http2Frame, Http2GoAwayFrame, io.netty5.util.Resource<Http2GoAwayFrame>, AutoCloseable

@UnstableApi
public final class DefaultHttp2GoAwayFrame
extends io.netty5.buffer.BufferHolder<Http2GoAwayFrame>
implements Http2GoAwayFrame

The default Http2GoAwayFrame implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultHttp2GoAwayFrame(long errorCode)	Equivalent to new DefaultHttp2GoAwayFrame(content, Unpooled.EMPTY_BUFFER).
DefaultHttp2GoAwayFrame(long errorCode, io.netty5.util.Send<io.netty5.buffer.Buffer> content)	Construct a new GOAWAY message.
DefaultHttp2GoAwayFrame(Http2Error error)	Equivalent to new DefaultHttp2GoAwayFrame(error.code()).
DefaultHttp2GoAwayFrame(Http2Error error, io.netty5.util.Send<io.netty5.buffer.Buffer> content)

Method Summary

Modifier and Type	Method	Description
io.netty5.buffer.Buffer	content()	Optional debugging information describing cause the GOAWAY.
Http2GoAwayFrame	copy()	Produce a copy of this GOAWAY frame, which contain a copy of the frame contents.
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()
int	lastStreamId()	Returns the last stream identifier if set, or -1 else.
String	name()	Returns the name of the HTTP/2 frame e.g.
protected Http2GoAwayFrame	receive(io.netty5.buffer.Buffer buf)
Http2GoAwayFrame	setExtraStreamIds(int extraStreamIds)	Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.
String	toString()
Http2GoAwayFrame	touch(Object hint)

Methods inherited from class io.netty5.buffer.BufferHolder

close, getBuffer, getBufferVolatile, isAccessible, replaceBuffer, replaceBufferVolatile, send

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.util.Resource

close, isAccessible, send

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:

errorCode - reason for the go away

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(Http2Error error,
                               io.netty5.util.Send<io.netty5.buffer.Buffer> content)

Parameters:

error - non-null reason for the go away

content - non-null debug data

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(long errorCode,
                               io.netty5.util.Send<io.netty5.buffer.Buffer> content)

Construct a new GOAWAY message.

Parameters:

errorCode - reason for the go away

content - non-null debug data

Method Detail

name

public String name()

Description copied from interface: Http2Frame

Returns the name of the HTTP/2 frame e.g. DATA, GOAWAY, etc.

Specified by:

name in interface Http2Frame

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 Http2GoAwayFrame 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()

lastStreamId

public int lastStreamId()

Description copied from interface: Http2GoAwayFrame

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

Specified by:

lastStreamId in interface Http2GoAwayFrame

content

public io.netty5.buffer.Buffer content()

Description copied from interface: Http2GoAwayFrame

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

Specified by:

content in interface Http2GoAwayFrame

copy

public Http2GoAwayFrame copy()

Description copied from interface: Http2GoAwayFrame

Produce a copy of this GOAWAY frame, which contain a copy of the frame contents.

Specified by:

copy in interface Http2GoAwayFrame

Returns:

A copy of this GOAWAY frame.

receive

protected Http2GoAwayFrame receive(io.netty5.buffer.Buffer buf)

Specified by:

receive in class io.netty5.buffer.BufferHolder<Http2GoAwayFrame>

touch

public Http2GoAwayFrame touch(Object hint)

Specified by:

touch in interface io.netty5.util.Resource<Http2GoAwayFrame>

Overrides:

touch in class io.netty5.buffer.BufferHolder<Http2GoAwayFrame>

equals

public boolean equals(Object o)

Overrides:

equals in class io.netty5.buffer.BufferHolder<Http2GoAwayFrame>

hashCode

public int hashCode()

Overrides:

hashCode in class io.netty5.buffer.BufferHolder<Http2GoAwayFrame>

toString

public String toString()

Overrides:

toString in class Object