io.netty.handler.codec.http2

Interface Http2Connection.Endpoint<F extends Http2FlowController>

Enclosing interface:

Http2Connection

public static interface Http2Connection.Endpoint<F extends Http2FlowController>

A view of the connection from one endpoint (local or remote).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptingNewStreams() Indicates whether or not this endpoint is currently accepting new streams.
boolean	allowPushTo() Gets whether or not server push is allowed to this endpoint.
void	allowPushTo(boolean allow) Sets whether server push is allowed to this endpoint.
boolean	createdStreamId(int streamId) Indicates whether the given streamId is from the set of IDs used by this endpoint to create new streams.
Http2Stream	createStream(int streamId) Creates a stream initiated by this endpoint.
F	flowController() Gets the flow controller for this endpoint.
void	flowController(F flowController) Sets the flow controller for this endpoint.
boolean	isServer() Indicates whether or not this endpoint is the server-side of the connection.
int	lastKnownStream() Gets the last stream created by this endpoint that is "known" by the opposite endpoint.
int	lastStreamCreated() Gets the ID of the stream last successfully created by this endpoint.
int	maxStreams() Gets the maximum number of concurrent streams allowed by this endpoint.
void	maxStreams(int maxStreams) Sets the maximum number of concurrent streams allowed by this endpoint.
int	nextStreamId() Returns the next valid streamId for this endpoint.
int	numActiveStreams() Gets the number of currently active streams that were created by this endpoint.
Http2Connection.Endpoint<? extends Http2FlowController>	opposite() Gets the Http2Connection.Endpoint opposite this one.
Http2Stream	reservePushStream(int streamId, Http2Stream parent) Creates a push stream in the reserved state for this endpoint and notifies all listeners.

Method Detail

nextStreamId

int nextStreamId()

Returns the next valid streamId for this endpoint. If negative, the stream IDs are exhausted for this endpoint an no further streams may be created.

createdStreamId

boolean createdStreamId(int streamId)

Indicates whether the given streamId is from the set of IDs used by this endpoint to create new streams.

acceptingNewStreams

boolean acceptingNewStreams()

Indicates whether or not this endpoint is currently accepting new streams. This will be be false if numActiveStreams() + 1 >= maxStreams() or if the stream IDs for this endpoint have been exhausted (i.e. nextStreamId() < 0).

createStream

Http2Stream createStream(int streamId)
                         throws Http2Exception

Creates a stream initiated by this endpoint. This could fail for the following reasons:

• The requested stream ID is not the next sequential ID for this endpoint.
• The stream already exists.
• The number of concurrent streams is above the allowed threshold for this endpoint.
• The connection is marked as going away.

The caller is expected to Http2Stream.open(boolean) the stream.

Parameters:

streamId - The ID of the stream

Throws:

Http2Exception

See Also:

Http2Stream.open(boolean)

reservePushStream

Http2Stream reservePushStream(int streamId,
                            Http2Stream parent)
                              throws Http2Exception

Creates a push stream in the reserved state for this endpoint and notifies all listeners. This could fail for the following reasons:

• Server push is not allowed to the opposite endpoint.
• The requested stream ID is not the next sequential stream ID for this endpoint.
• The number of concurrent streams is above the allowed threshold for this endpoint.
• The connection is marked as going away.
• The parent stream ID does not exist or is not open from the side sending the push promise.
• Could not set a valid priority for the new stream.

Parameters:

streamId - the ID of the push stream

parent - the parent stream used to initiate the push stream.

Throws:

Http2Exception

isServer

boolean isServer()

Indicates whether or not this endpoint is the server-side of the connection.

allowPushTo

void allowPushTo(boolean allow)

Sets whether server push is allowed to this endpoint.

allowPushTo

boolean allowPushTo()

Gets whether or not server push is allowed to this endpoint. This is always false for a server endpoint.

numActiveStreams

int numActiveStreams()

Gets the number of currently active streams that were created by this endpoint.

maxStreams

int maxStreams()

Gets the maximum number of concurrent streams allowed by this endpoint.

maxStreams

void maxStreams(int maxStreams)

Sets the maximum number of concurrent streams allowed by this endpoint.

lastStreamCreated

int lastStreamCreated()

Gets the ID of the stream last successfully created by this endpoint.

lastKnownStream

int lastKnownStream()

Gets the last stream created by this endpoint that is "known" by the opposite endpoint. If a GOAWAY was received for this endpoint, this will be the last stream ID from the GOAWAY frame. Otherwise, this will be same as lastStreamCreated().

flowController

F flowController()

Gets the flow controller for this endpoint.

flowController

void flowController(F flowController)

Sets the flow controller for this endpoint.

opposite

Http2Connection.Endpoint<? extends Http2FlowController> opposite()

Gets the Http2Connection.Endpoint opposite this one.