Top Description Methods
io.netty.handler.codec.http2

public Interface Http2GoAwayFrame

extends Http2Frame, ByteBufHolder
Known Direct Implementers
io.netty.handler.codec.http2.DefaultHttp2GoAwayFrame
Annotations
@UnstableApi
Imports
io.netty.buffer.ByteBuf, .ByteBufHolder, io.netty.util.internal.UnstableApi
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 TypeMethod and Description
public ByteBuf
content()

Redeclares io.netty.buffer.ByteBufHolder.content.

Optional debugging information describing cause the GOAWAY.
public Http2GoAwayFrame
copy()

Redeclares io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.
public Http2GoAwayFrame
duplicate()

Redeclares io.netty.buffer.ByteBufHolder.duplicate.

Duplicates this ByteBufHolder.
public long
errorCode()

The reason for beginning closure of the connection.

public int
extraStreamIds()

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

public int
lastStreamId()

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

public Http2GoAwayFrame
replace(ByteBuf content)

Redeclares io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.
public Http2GoAwayFrame
retain()

Redeclares io.netty.buffer.ByteBufHolder.retain.

Increases the reference count by 1.
public Http2GoAwayFrame
retain(int increment)

Redeclares io.netty.buffer.ByteBufHolder.retain.

Increases the reference count by the specified increment.
public Http2GoAwayFrame
retainedDuplicate()

Redeclares io.netty.buffer.ByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder.
public Http2GoAwayFrame

Returns:

this
setExtraStreamIds(int extraStreamIds)

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

public Http2GoAwayFrame
touch()

Redeclares io.netty.buffer.ByteBufHolder.touch.

Records the current access location of this object for debugging purposes.
public Http2GoAwayFrame
touch(Object hint)

Redeclares io.netty.buffer.ByteBufHolder.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
Inherited from io.netty.handler.codec.http2.Http2Frame:
name

Method Detail

contentback to summary
public ByteBuf content()

Redeclares io.netty.buffer.ByteBufHolder.content.

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

Annotations
@Override
copyback to summary
public Http2GoAwayFrame copy()

Redeclares io.netty.buffer.ByteBufHolder.copy.

Doc from io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

Annotations
@Override
duplicateback to summary
public Http2GoAwayFrame duplicate()

Redeclares io.netty.buffer.ByteBufHolder.duplicate.

Doc from io.netty.buffer.ByteBufHolder.duplicate.

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

Annotations
@Override
errorCodeback to summary
public long errorCode()

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

extraStreamIdsback to summary
public 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.

lastStreamIdback to summary
public int lastStreamId()

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

replaceback to summary
public Http2GoAwayFrame replace(ByteBuf content)

Redeclares io.netty.buffer.ByteBufHolder.replace.

Doc from io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Annotations
@Override
retainback to summary
public Http2GoAwayFrame retain()

Redeclares io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations
@Override
retainback to summary
public Http2GoAwayFrame retain(int increment)

Redeclares io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations
@Override
retainedDuplicateback to summary
public Http2GoAwayFrame retainedDuplicate()

Redeclares io.netty.buffer.ByteBufHolder.retainedDuplicate.

Doc from io.netty.buffer.ByteBufHolder.retainedDuplicate.

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

Annotations
@Override
setExtraStreamIdsback to summary
public Http2GoAwayFrame setExtraStreamIds(int extraStreamIds)

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

Returns:Http2GoAwayFrame

this

See Also
extraStreamIds
touchback to summary
public Http2GoAwayFrame touch()

Redeclares io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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).

Annotations
@Override
touchback to summary
public Http2GoAwayFrame touch(Object hint)

Redeclares io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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.

Annotations
@Override