Package io.netty.handler.codec.http2
Interface Http2GoAwayFrame
- All Superinterfaces:
ByteBufHolder
,Http2Frame
,ReferenceCounted
- All Known Implementing Classes:
DefaultHttp2GoAwayFrame
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 TypeMethodDescriptioncontent()
Optional debugging information describing cause the GOAWAY.copy()
Creates a deep copy of thisByteBufHolder
.Duplicates thisByteBufHolder
.long
The reason for beginning closure of the connection.int
The number of IDs to reserve for the receiver to use while GOAWAY is in transit.int
Returns the last stream identifier if set, or-1
else.Returns a newByteBufHolder
which contains the specifiedcontent
.retain()
Increases the reference count by1
.retain
(int increment) Increases the reference count by the specifiedincrement
.Duplicates thisByteBufHolder
.setExtraStreamIds
(int extraStreamIds) Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.touch()
Records the current access location of this object for debugging purposes.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 Details
-
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
Sets the number of IDs to reserve for the receiver to use while GOAWAY is in transit.- Returns:
this
- See Also:
-
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 benull
, but may be empty.- Specified by:
content
in interfaceByteBufHolder
-
copy
Http2GoAwayFrame copy()Description copied from interface:ByteBufHolder
Creates a deep copy of thisByteBufHolder
.- Specified by:
copy
in interfaceByteBufHolder
-
duplicate
Http2GoAwayFrame duplicate()Description copied from interface:ByteBufHolder
Duplicates thisByteBufHolder
. Be aware that this will not automatically callByteBufHolder.retain()
.- Specified by:
duplicate
in interfaceByteBufHolder
-
retainedDuplicate
Http2GoAwayFrame retainedDuplicate()Description copied from interface:ByteBufHolder
Duplicates thisByteBufHolder
. This method returns a retained duplicate unlikeByteBufHolder.duplicate()
.- Specified by:
retainedDuplicate
in interfaceByteBufHolder
- See Also:
-
replace
Description copied from interface:ByteBufHolder
Returns a newByteBufHolder
which contains the specifiedcontent
.- Specified by:
replace
in interfaceByteBufHolder
-
retain
Http2GoAwayFrame retain()Description copied from interface:ReferenceCounted
Increases the reference count by1
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
-
retain
Description copied from interface:ReferenceCounted
Increases the reference count by the specifiedincrement
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
-
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 viaResourceLeakDetector
. This method is a shortcut totouch(null)
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
-
touch
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 viaResourceLeakDetector
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
-