Package io.netty.handler.codec.http2
Class DefaultHttp2Connection
- java.lang.Object
-
- io.netty.handler.codec.http2.DefaultHttp2Connection
-
- All Implemented Interfaces:
Http2Connection
@UnstableApi public class DefaultHttp2Connection extends java.lang.Object implements Http2Connection
Simple implementation ofHttp2Connection.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private classDefaultHttp2Connection.ActiveStreamsManages the list of currently active streams.private classDefaultHttp2Connection.ConnectionStreamStream class representing the connection, itself.private classDefaultHttp2Connection.DefaultEndpoint<F extends Http2FlowController>Simple endpoint implementation.(package private) classDefaultHttp2Connection.DefaultPropertyKeyImplementation ofHttp2Connection.PropertyKeythat specifies the index position of the property.private classDefaultHttp2Connection.DefaultStreamSimple stream implementation.(package private) static interfaceDefaultHttp2Connection.EventAllows events which would modify the collection of active streams to be queued while iterating viaforEachActiveStream(Http2StreamVisitor).private classDefaultHttp2Connection.PropertyKeyRegistryA registry of all stream property keys known by this connection.-
Nested classes/interfaces inherited from interface io.netty.handler.codec.http2.Http2Connection
Http2Connection.Endpoint<F extends Http2FlowController>, Http2Connection.Listener, Http2Connection.PropertyKey
-
-
Field Summary
Fields Modifier and Type Field Description (package private) DefaultHttp2Connection.ActiveStreamsactiveStreams(package private) Promise<java.lang.Void>closePromise(package private) DefaultHttp2Connection.ConnectionStreamconnectionStream(package private) java.util.List<Http2Connection.Listener>listenersWe chose aListover aSetto avoid allocating anIteratorobjects when iterating over the listeners.(package private) DefaultHttp2Connection.DefaultEndpoint<Http2LocalFlowController>localEndpointprivate static InternalLoggerlogger(package private) DefaultHttp2Connection.PropertyKeyRegistrypropertyKeyRegistry(package private) DefaultHttp2Connection.DefaultEndpoint<Http2RemoteFlowController>remoteEndpoint(package private) IntObjectMap<Http2Stream>streamMap
-
Constructor Summary
Constructors Constructor 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 Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) static Http2Stream.StateactiveState(int streamId, Http2Stream.State initialState, boolean isLocal, boolean halfClosed)voidaddListener(Http2Connection.Listener listener)Adds a listener of stream life-cycle events.Future<java.lang.Void>close(Promise<java.lang.Void> promise)Close this connection.private voidcloseStreamsGreaterThanLastKnownStreamId(int lastKnownStream, DefaultHttp2Connection.DefaultEndpoint<?> endpoint)Http2StreamconnectionStream()Gets the stream object representing the connection, itself (i.e.Http2StreamforEachActiveStream(Http2StreamVisitor visitor)Provide a means of iterating over the collection of active streams.booleangoAwayReceived()Indicates whether or not aGOAWAYwas received from the remote endpoint.voidgoAwayReceived(int lastKnownStream, long errorCode, ByteBuf debugData)Indicates that aGOAWAYwas received from the remote endpoint and sets the last known stream.booleangoAwaySent()Indicates whether or not aGOAWAYwas sent to the remote endpoint.booleangoAwaySent(int lastKnownStream, long errorCode, ByteBuf debugData)Updates the local state of thisHttp2Connectionas a result of aGOAWAYto send to the remote endpoint.(package private) booleanisClosed()Determine ifclose(Promise)has been called and no more streams are allowed to be created.booleanisServer()Indicates whether or not the local endpoint for this connection is the server.private booleanisStreamMapEmpty()Determine ifstreamMaponly contains the connection stream.Http2Connection.Endpoint<Http2LocalFlowController>local()Gets a view of this connection from the localHttp2Connection.Endpoint.Http2Connection.PropertyKeynewKey()Creates a new key that is unique within thisHttp2Connection.(package private) voidnotifyClosed(Http2Stream stream)(package private) voidnotifyHalfClosed(Http2Stream stream)intnumActiveStreams()Gets the number of streams that are actively in use (i.e.Http2Connection.Endpoint<Http2RemoteFlowController>remote()Gets a view of this connection from the remoteHttp2Connection.Endpoint.voidremoveListener(Http2Connection.Listener listener)Removes a listener of stream life-cycle events.(package private) voidremoveStream(DefaultHttp2Connection.DefaultStream stream, java.util.Iterator<?> itr)Remove a stream from thestreamMap.Http2Streamstream(int streamId)Gets the stream if it exists.booleanstreamMayHaveExisted(int streamId)Indicates whether or not the given stream may have existed within this connection.(package private) DefaultHttp2Connection.DefaultPropertyKeyverifyKey(Http2Connection.PropertyKey key)Verifies that the key is valid and returns it as the internalDefaultHttp2Connection.DefaultPropertyKeytype.
-
-
-
Field Detail
-
logger
private static final InternalLogger logger
-
streamMap
final IntObjectMap<Http2Stream> streamMap
-
propertyKeyRegistry
final DefaultHttp2Connection.PropertyKeyRegistry propertyKeyRegistry
-
connectionStream
final DefaultHttp2Connection.ConnectionStream connectionStream
-
localEndpoint
final DefaultHttp2Connection.DefaultEndpoint<Http2LocalFlowController> localEndpoint
-
remoteEndpoint
final DefaultHttp2Connection.DefaultEndpoint<Http2RemoteFlowController> remoteEndpoint
-
listeners
final java.util.List<Http2Connection.Listener> listeners
We chose aListover aSetto avoid allocating anIteratorobjects when iterating over the listeners.Initial size of 4 because the default configuration currently has 3 listeners (local/remote flow controller and
StreamByteDistributor) and we leave room for 1 extra. We could be more aggressive but the ArrayList resize will double the size if we are too small.
-
activeStreams
final DefaultHttp2Connection.ActiveStreams activeStreams
-
closePromise
Promise<java.lang.Void> closePromise
-
-
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
-
isClosed
final boolean isClosed()
Determine ifclose(Promise)has been called and no more streams are allowed to be created.
-
close
public Future<java.lang.Void> close(Promise<java.lang.Void> promise)
Description copied from interface:Http2ConnectionClose 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:
closein interfaceHttp2Connection- 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:Http2ConnectionAdds a listener of stream life-cycle events.- Specified by:
addListenerin interfaceHttp2Connection
-
removeListener
public void removeListener(Http2Connection.Listener listener)
Description copied from interface:Http2ConnectionRemoves a listener of stream life-cycle events. If the same listener was added multiple times then only the first occurrence gets removed.- Specified by:
removeListenerin interfaceHttp2Connection
-
isServer
public boolean isServer()
Description copied from interface:Http2ConnectionIndicates whether or not the local endpoint for this connection is the server.- Specified by:
isServerin interfaceHttp2Connection
-
connectionStream
public Http2Stream connectionStream()
Description copied from interface:Http2ConnectionGets the stream object representing the connection, itself (i.e. stream zero). This object always exists.- Specified by:
connectionStreamin interfaceHttp2Connection
-
stream
public Http2Stream stream(int streamId)
Description copied from interface:Http2ConnectionGets the stream if it exists. If not, returnsnull.- Specified by:
streamin interfaceHttp2Connection
-
streamMayHaveExisted
public boolean streamMayHaveExisted(int streamId)
Description copied from interface:Http2ConnectionIndicates whether or not the given stream may have existed within this connection. This is a short form for callingHttp2Connection.Endpoint.mayHaveCreatedStream(int)on both endpoints.- Specified by:
streamMayHaveExistedin interfaceHttp2Connection
-
numActiveStreams
public int numActiveStreams()
Description copied from interface:Http2ConnectionGets the number of streams that are actively in use (i.e.OPENorHALF CLOSED).- Specified by:
numActiveStreamsin interfaceHttp2Connection
-
forEachActiveStream
public Http2Stream forEachActiveStream(Http2StreamVisitor visitor) throws Http2Exception
Description copied from interface:Http2ConnectionProvide a means of iterating over the collection of active streams.- Specified by:
forEachActiveStreamin interfaceHttp2Connection- Parameters:
visitor- The visitor which will visit each active stream.- Returns:
- The stream before iteration stopped or
nullif iteration went past the end. - Throws:
Http2Exception
-
local
public Http2Connection.Endpoint<Http2LocalFlowController> local()
Description copied from interface:Http2ConnectionGets a view of this connection from the localHttp2Connection.Endpoint.- Specified by:
localin interfaceHttp2Connection
-
remote
public Http2Connection.Endpoint<Http2RemoteFlowController> remote()
Description copied from interface:Http2ConnectionGets a view of this connection from the remoteHttp2Connection.Endpoint.- Specified by:
remotein interfaceHttp2Connection
-
goAwayReceived
public boolean goAwayReceived()
Description copied from interface:Http2ConnectionIndicates whether or not aGOAWAYwas received from the remote endpoint.- Specified by:
goAwayReceivedin interfaceHttp2Connection
-
goAwayReceived
public void goAwayReceived(int lastKnownStream, long errorCode, ByteBuf debugData) throws Http2ExceptionDescription copied from interface:Http2ConnectionIndicates that aGOAWAYwas received from the remote endpoint and sets the last known stream.- Specified by:
goAwayReceivedin interfaceHttp2Connection- Parameters:
lastKnownStream- The Last-Stream-ID in the GOAWAY frame.errorCode- the Error Code in the GOAWAY frame.debugData- The Additional Debug Data in the GOAWAY frame. Note that reference count ownership belongs to the caller (ownership is not transferred to this method).- Throws:
Http2Exception
-
goAwaySent
public boolean goAwaySent()
Description copied from interface:Http2ConnectionIndicates whether or not aGOAWAYwas sent to the remote endpoint.- Specified by:
goAwaySentin interfaceHttp2Connection
-
goAwaySent
public boolean goAwaySent(int lastKnownStream, long errorCode, ByteBuf debugData) throws Http2ExceptionDescription copied from interface:Http2ConnectionUpdates the local state of thisHttp2Connectionas a result of aGOAWAYto send to the remote endpoint.- Specified by:
goAwaySentin interfaceHttp2Connection- Parameters:
lastKnownStream- The Last-Stream-ID in the GOAWAY frame.errorCode- the Error Code in the GOAWAY frame. GOAWAY frame. Note that reference count ownership belongs to the caller (ownership is not transferred to this method).- Returns:
trueif the correspondingGOAWAYframe should be sent to the remote endpoint.- Throws:
Http2Exception
-
closeStreamsGreaterThanLastKnownStreamId
private void closeStreamsGreaterThanLastKnownStreamId(int lastKnownStream, DefaultHttp2Connection.DefaultEndpoint<?> endpoint) throws Http2Exception- Throws:
Http2Exception
-
isStreamMapEmpty
private boolean isStreamMapEmpty()
Determine ifstreamMaponly contains the connection stream.
-
removeStream
void removeStream(DefaultHttp2Connection.DefaultStream stream, java.util.Iterator<?> itr)
Remove a stream from thestreamMap.- Parameters:
stream- the stream to remove.itr- an iterator that may be pointing to the stream during iteration andIterator.remove()will be used if non-null.
-
activeState
static Http2Stream.State activeState(int streamId, Http2Stream.State initialState, boolean isLocal, boolean halfClosed) throws Http2Exception
- Throws:
Http2Exception
-
notifyHalfClosed
void notifyHalfClosed(Http2Stream stream)
-
notifyClosed
void notifyClosed(Http2Stream stream)
-
newKey
public Http2Connection.PropertyKey newKey()
Description copied from interface:Http2ConnectionCreates a new key that is unique within thisHttp2Connection.- Specified by:
newKeyin interfaceHttp2Connection
-
verifyKey
final DefaultHttp2Connection.DefaultPropertyKey verifyKey(Http2Connection.PropertyKey key)
Verifies that the key is valid and returns it as the internalDefaultHttp2Connection.DefaultPropertyKeytype.- Throws:
java.lang.NullPointerException- if the key isnull.java.lang.ClassCastException- if the key is not of typeDefaultHttp2Connection.DefaultPropertyKey.java.lang.IllegalArgumentException- if the key was not created by this connection.
-
-