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)
DefaultHttp2GoAwayFrame(long errorCode) Equivalent to new DefaultHttp2GoAwayFrame(content, Unpooled.EMPTY_BUFFER).
DefaultHttp2GoAwayFrame(long errorCode, ByteBuf content) Construct a new GOAWAY message.

Method Summary

Modifier and Type	Method and Description
Http2GoAwayFrame	copy() Creates a deep copy of this ByteBufHolder.
Http2GoAwayFrame	duplicate() Duplicates this ByteBufHolder.
boolean	equals(Object o) This implementation of the equals operation is restricted to work only with instances of the same class.
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.
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.
String	toString()
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 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:

errorCode - reason for the go away

DefaultHttp2GoAwayFrame

public DefaultHttp2GoAwayFrame(Http2Error error,
                               ByteBuf 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:

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

copy

public Http2GoAwayFrame copy()

Description copied from class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

This method calls replace(content().copy()) by default.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface Http2GoAwayFrame

Overrides:

copy in class DefaultByteBufHolder

duplicate

public Http2GoAwayFrame duplicate()

Description copied from class: DefaultByteBufHolder

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

This method calls replace(content().duplicate()) by default.

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface Http2GoAwayFrame

Overrides:

duplicate in class DefaultByteBufHolder

retainedDuplicate

public Http2GoAwayFrame retainedDuplicate()

Description copied from class: DefaultByteBufHolder

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

This method calls replace(content().retainedDuplicate()) by default.

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface Http2GoAwayFrame

Overrides:

retainedDuplicate in class DefaultByteBufHolder

See Also:

ByteBuf.retainedDuplicate()

replace

public Http2GoAwayFrame replace(ByteBuf content)

Description copied from class: DefaultByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Override this method to return a new instance of this object whose content is set to the specified content. The default implementation of DefaultByteBufHolder.copy(), DefaultByteBufHolder.duplicate() and DefaultByteBufHolder.retainedDuplicate() invokes this method to create a copy.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface Http2GoAwayFrame

Overrides:

replace in class DefaultByteBufHolder

retain

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

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

touch

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

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

touch

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

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

equals

public boolean equals(Object o)

Description copied from class: DefaultByteBufHolder

This implementation of the equals operation is restricted to work only with instances of the same class. The reason for that is that Netty library already has a number of classes that extend DefaultByteBufHolder and override equals method with an additional comparison logic and we need the symmetric property of the equals operation to be preserved.

Overrides:

equals in class DefaultByteBufHolder

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultByteBufHolder

toString

public String toString()

Overrides:

toString in class DefaultByteBufHolder