DefaultHttp2Connection (Netty API Reference (4.1.11.Final))

java.lang.Object
- io.netty.handler.codec.http2.DefaultHttp2Connection

All Implemented Interfaces:: Http2Connection

@UnstableApi
public class DefaultHttp2Connection
extends Object
implements Http2Connection

Simple implementation of Http2Connection.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.handler.codec.http2.Http2Connection
  Http2Connection.Endpoint<F extends Http2FlowController>, Http2Connection.Listener, Http2Connection.PropertyKey

Constructor Summary

Constructors
Constructor and Description
`DefaultHttp2Connection(boolean server)` Creates a new connection with the given settings.
`DefaultHttp2Connection(boolean server, int maxReservedStreams)` Creates a new connection with the given settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(Http2Connection.Listener listener)` Adds a listener of stream life-cycle events.
`Future<Void>`	`close(Promise<Void> promise)` Close this connection.
`Http2Stream`	`connectionStream()` Gets the stream object representing the connection, itself (i.e. stream zero).
`Http2Stream`	`forEachActiveStream(Http2StreamVisitor visitor)` Provide a means of iterating over the collection of active streams.
`boolean`	`goAwayReceived()` Indicates whether or not a `GOAWAY` was received from the remote endpoint.
`void`	`goAwayReceived(int lastKnownStream, long errorCode, ByteBuf debugData)` Indicates that a `GOAWAY` was received from the remote endpoint and sets the last known stream.
`boolean`	`goAwaySent()` Indicates whether or not a `GOAWAY` was sent to the remote endpoint.
`void`	`goAwaySent(int lastKnownStream, long errorCode, ByteBuf debugData)` Indicates that a `GOAWAY` was sent to the remote endpoint and sets the last known stream.
`boolean`	`isServer()` Indicates whether or not the local endpoint for this connection is the server.
`Http2Connection.Endpoint<Http2LocalFlowController>`	`local()` Gets a view of this connection from the local `Http2Connection.Endpoint`.
`Http2Connection.PropertyKey`	`newKey()` Creates a new key that is unique within this `Http2Connection`.
`int`	`numActiveStreams()` Gets the number of streams that are actively in use (i.e.
`Http2Connection.Endpoint<Http2RemoteFlowController>`	`remote()` Gets a view of this connection from the remote `Http2Connection.Endpoint`.
`void`	`removeListener(Http2Connection.Listener listener)` Removes a listener of stream life-cycle events.
`Http2Stream`	`stream(int streamId)` Gets the stream if it exists.
`boolean`	`streamMayHaveExisted(int streamId)` Indicates whether or not the given stream may have existed within this connection.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultHttp2Connection
```
public DefaultHttp2Connection(boolean server)
```
    Creates a new connection with the given settings.
    
    Parameters:
    
    server - whether or not this end-point is the server-side of the HTTP/2 connection.
  - DefaultHttp2Connection
```
public DefaultHttp2Connection(boolean server,
                              int maxReservedStreams)
```
    Creates a new connection with the given settings.
    
    Parameters:
    
    server - whether or not this end-point is the server-side of the HTTP/2 connection.
    
    maxReservedStreams - The maximum amount of streams which can exist in the reserved state for each endpoint.
- Method Detail
  - close
```
public Future<Void> close(Promise<Void> promise)
```
    Description copied from interface: Http2Connection
    
    Close this connection. No more new streams can be created after this point and all streams that exists (active or otherwise) will be closed and removed.
    Note if iterating active streams via Http2Connection.forEachActiveStream(Http2StreamVisitor) and an exception is thrown it is necessary to call this method again to ensure the close completes.
    
    Specified by:
    
    close in interface Http2Connection
    
    Parameters:
    
    promise - Will be completed when all streams have been removed, and listeners have been notified.
    
    Returns:
    
    A future that will be completed when all streams have been removed, and listeners have been notified.
  - addListener
```
public void addListener(Http2Connection.Listener listener)
```
    Description copied from interface: Http2Connection
    
    Adds a listener of stream life-cycle events.
    
    Specified by:
    
    addListener in interface Http2Connection
  - removeListener
```
public void removeListener(Http2Connection.Listener listener)
```
    Description copied from interface: Http2Connection
    
    Removes a listener of stream life-cycle events. If the same listener was added multiple times then only the first occurrence gets removed.
    
    Specified by:
    
    removeListener in interface Http2Connection
  - isServer
```
public boolean isServer()
```
    Description copied from interface: Http2Connection
    
    Indicates whether or not the local endpoint for this connection is the server.
    
    Specified by:
    
    isServer in interface Http2Connection
  - connectionStream
```
public Http2Stream connectionStream()
```
    Description copied from interface: Http2Connection
    
    Gets the stream object representing the connection, itself (i.e. stream zero). This object always exists.
    
    Specified by:
    
    connectionStream in interface Http2Connection
  - stream
```
public Http2Stream stream(int streamId)
```
    Description copied from interface: Http2Connection
    
    Gets the stream if it exists. If not, returns null.
    
    Specified by:
    
    stream in interface Http2Connection
  - streamMayHaveExisted
```
public boolean streamMayHaveExisted(int streamId)
```
    Description copied from interface: Http2Connection
    
    Indicates whether or not the given stream may have existed within this connection. This is a short form for calling Http2Connection.Endpoint.mayHaveCreatedStream(int) on both endpoints.
    
    Specified by:
    
    streamMayHaveExisted in interface Http2Connection
  - numActiveStreams
```
public int numActiveStreams()
```
    Description copied from interface: Http2Connection
    
    Gets the number of streams that are actively in use (i.e. OPEN or HALF CLOSED).
    
    Specified by:
    
    numActiveStreams in interface Http2Connection
  - forEachActiveStream
```
public Http2Stream forEachActiveStream(Http2StreamVisitor visitor)
                                throws Http2Exception
```
    Description copied from interface: Http2Connection
    
    Provide a means of iterating over the collection of active streams.
    
    Specified by:
    
    forEachActiveStream in interface Http2Connection
    
    Parameters:
    
    visitor - The visitor which will visit each active stream.
    
    Returns:
    
    The stream before iteration stopped or null if iteration went past the end.
    
    Throws:
    
    Http2Exception
  - local
```
public Http2Connection.Endpoint<Http2LocalFlowController> local()
```
    Description copied from interface: Http2Connection
    
    Gets a view of this connection from the local Http2Connection.Endpoint.
    
    Specified by:
    
    local in interface Http2Connection
  - remote
```
public Http2Connection.Endpoint<Http2RemoteFlowController> remote()
```
    Description copied from interface: Http2Connection
    
    Gets a view of this connection from the remote Http2Connection.Endpoint.
    
    Specified by:
    
    remote in interface Http2Connection
  - goAwayReceived
```
public boolean goAwayReceived()
```
    Description copied from interface: Http2Connection
    
    Indicates whether or not a GOAWAY was received from the remote endpoint.
    
    Specified by:
    
    goAwayReceived in interface Http2Connection
  - goAwayReceived
```
public void goAwayReceived(int lastKnownStream,
                           long errorCode,
                           ByteBuf debugData)
```
    Description copied from interface: Http2Connection
    
    Indicates that a GOAWAY was received from the remote endpoint and sets the last known stream.
    
    Specified by:
    
    goAwayReceived in interface Http2Connection
  - goAwaySent
```
public boolean goAwaySent()
```
    Description copied from interface: Http2Connection
    
    Indicates whether or not a GOAWAY was sent to the remote endpoint.
    
    Specified by:
    
    goAwaySent in interface Http2Connection
  - goAwaySent
```
public void goAwaySent(int lastKnownStream,
                       long errorCode,
                       ByteBuf debugData)
```
    Description copied from interface: Http2Connection
    
    Indicates that a GOAWAY was sent to the remote endpoint and sets the last known stream.
    
    Specified by:
    
    goAwaySent in interface Http2Connection
  - newKey
```
public Http2Connection.PropertyKey newKey()
```
    Description copied from interface: Http2Connection
    
    Creates a new key that is unique within this Http2Connection.
    
    Specified by:
    
    newKey in interface Http2Connection

Class DefaultHttp2Connection

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.handler.codec.http2.Http2Connection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultHttp2Connection

DefaultHttp2Connection

Method Detail

close

addListener

removeListener

isServer

connectionStream

stream

streamMayHaveExisted

numActiveStreams

forEachActiveStream

local

remote

goAwayReceived

goAwayReceived

goAwaySent

goAwaySent

newKey