DefaultHttp2GoAwayFrame (Netty/Codec/HTTP2 4.1.128.Final API)

java.lang.Object
- io.netty.buffer.DefaultByteBufHolder
- - io.netty.handler.codec.http2.DefaultHttp2GoAwayFrame

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, Http2Frame, Http2GoAwayFrame, io.netty.util.ReferenceCounted
```
public final class DefaultHttp2GoAwayFrame
extends io.netty.buffer.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, io.netty.buffer.ByteBuf content)`
`DefaultHttp2GoAwayFrame(long errorCode)` Equivalent to `new DefaultHttp2GoAwayFrame(content, Unpooled.EMPTY_BUFFER)`.
`DefaultHttp2GoAwayFrame(long errorCode, io.netty.buffer.ByteBuf content)` Construct a new GOAWAY message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Http2GoAwayFrame`	`copy()`
`Http2GoAwayFrame`	`duplicate()`
`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.
`Http2GoAwayFrame`	`replace(io.netty.buffer.ByteBuf content)`
`Http2GoAwayFrame`	`retain()`
`Http2GoAwayFrame`	`retain(int increment)`
`Http2GoAwayFrame`	`retainedDuplicate()`
`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()`
`Http2GoAwayFrame`	`touch(Object hint)`

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,
                               io.netty.buffer.ByteBuf content)
```
    Parameters:
    
    error - non-null reason for the go away
    
    content - non-null debug data
  - DefaultHttp2GoAwayFrame
```
public DefaultHttp2GoAwayFrame(long errorCode,
                               io.netty.buffer.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()
```
    Specified by:
    
    copy in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    copy in interface Http2GoAwayFrame
    
    Overrides:
    
    copy in class io.netty.buffer.DefaultByteBufHolder
  - duplicate
```
public Http2GoAwayFrame duplicate()
```
    Specified by:
    
    duplicate in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    duplicate in interface Http2GoAwayFrame
    
    Overrides:
    
    duplicate in class io.netty.buffer.DefaultByteBufHolder
  - retainedDuplicate
```
public Http2GoAwayFrame retainedDuplicate()
```
    Specified by:
    
    retainedDuplicate in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    retainedDuplicate in interface Http2GoAwayFrame
    
    Overrides:
    
    retainedDuplicate in class io.netty.buffer.DefaultByteBufHolder
  - replace
```
public Http2GoAwayFrame replace(io.netty.buffer.ByteBuf content)
```
    Specified by:
    
    replace in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    replace in interface Http2GoAwayFrame
    
    Overrides:
    
    replace in class io.netty.buffer.DefaultByteBufHolder
  - retain
```
public Http2GoAwayFrame retain()
```
    Specified by:
    
    retain in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    retain in interface Http2GoAwayFrame
    
    Specified by:
    
    retain in interface io.netty.util.ReferenceCounted
    
    Overrides:
    
    retain in class io.netty.buffer.DefaultByteBufHolder
  - retain
```
public Http2GoAwayFrame retain(int increment)
```
    Specified by:
    
    retain in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    retain in interface Http2GoAwayFrame
    
    Specified by:
    
    retain in interface io.netty.util.ReferenceCounted
    
    Overrides:
    
    retain in class io.netty.buffer.DefaultByteBufHolder
  - touch
```
public Http2GoAwayFrame touch()
```
    Specified by:
    
    touch in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    touch in interface Http2GoAwayFrame
    
    Specified by:
    
    touch in interface io.netty.util.ReferenceCounted
    
    Overrides:
    
    touch in class io.netty.buffer.DefaultByteBufHolder
  - touch
```
public Http2GoAwayFrame touch(Object hint)
```
    Specified by:
    
    touch in interface io.netty.buffer.ByteBufHolder
    
    Specified by:
    
    touch in interface Http2GoAwayFrame
    
    Specified by:
    
    touch in interface io.netty.util.ReferenceCounted
    
    Overrides:
    
    touch in class io.netty.buffer.DefaultByteBufHolder
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class io.netty.buffer.DefaultByteBufHolder
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class io.netty.buffer.DefaultByteBufHolder
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class io.netty.buffer.DefaultByteBufHolder

Class DefaultHttp2GoAwayFrame

Constructor Summary

Method Summary

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.ReferenceCounted

Constructor Detail

DefaultHttp2GoAwayFrame

DefaultHttp2GoAwayFrame

DefaultHttp2GoAwayFrame

DefaultHttp2GoAwayFrame

Method Detail

name

errorCode

extraStreamIds

setExtraStreamIds

lastStreamId

copy

duplicate

retainedDuplicate

replace

retain

retain

touch

touch

equals

hashCode

toString