|
Java example source code file (Http2Connection.java)
The Http2Connection.java Java example source code/* * Copyright 2014 The Netty Project * * The Netty Project licenses this file to you under the Apache License, version 2.0 (the * "License"); you may not use this file except in compliance with the License. You may obtain a * copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under * the License. */ package io.netty.handler.codec.http2; import io.netty.buffer.ByteBuf; import io.netty.util.concurrent.Future; import io.netty.util.concurrent.Promise; import io.netty.util.internal.UnstableApi; /** * Manager for the state of an HTTP/2 connection with the remote end-point. */ @UnstableApi public interface Http2Connection { /** * Listener for life-cycle events for streams in this connection. */ interface Listener { /** * Notifies the listener that the given stream was added to the connection. This stream may * not yet be active (i.e. {@code OPEN} or {@code HALF CLOSED}). * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. */ void onStreamAdded(Http2Stream stream); /** * Notifies the listener that the given stream was made active (i.e. {@code OPEN} or {@code HALF CLOSED}). * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. */ void onStreamActive(Http2Stream stream); /** * Notifies the listener that the given stream has transitioned from {@code OPEN} to {@code HALF CLOSED}. * This method will <strong>not be called until a state transition occurs from when * {@link #onStreamActive(Http2Stream)} was called. * The stream can be inspected to determine which side is {@code HALF CLOSED}. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. */ void onStreamHalfClosed(Http2Stream stream); /** * Notifies the listener that the given stream is now {@code CLOSED} in both directions and will no longer * be accessible via {@link #forEachActiveStream(Http2StreamVisitor)}. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. */ void onStreamClosed(Http2Stream stream); /** * Notifies the listener that the given stream has now been removed from the connection and * will no longer be returned via {@link Http2Connection#stream(int)}. The connection may * maintain inactive streams for some time before removing them. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. */ void onStreamRemoved(Http2Stream stream); /** * Notifies the listener that a priority tree parent change has occurred. This method will be invoked * in a top down order relative to the priority tree. This method will also be invoked after all tree * structure changes have been made and the tree is in steady state relative to the priority change * which caused the tree structure to change. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. * @param stream The stream which had a parent change (new parent and children will be steady state) * @param oldParent The old parent which {@code stream} used to be a child of (may be {@code null}) */ void onPriorityTreeParentChanged(Http2Stream stream, Http2Stream oldParent); /** * Notifies the listener that a parent dependency is about to change * This is called while the tree is being restructured and so the tree * structure is not necessarily steady state. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. * @param stream The stream which the parent is about to change to {@code newParent} * @param newParent The stream which will be the parent of {@code stream} */ void onPriorityTreeParentChanging(Http2Stream stream, Http2Stream newParent); /** * Notifies the listener that the weight has changed for {@code stream}. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. * @param stream The stream which the weight has changed * @param oldWeight The old weight for {@code stream} */ void onWeightChanged(Http2Stream stream, short oldWeight); /** * Called when a {@code GOAWAY} frame was sent for the connection. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. * @param lastStreamId the last known stream of the remote endpoint. * @param errorCode the error code, if abnormal closure. * @param debugData application-defined debug data. */ void onGoAwaySent(int lastStreamId, long errorCode, ByteBuf debugData); /** * Called when a {@code GOAWAY} was received from the remote endpoint. This event handler duplicates {@link * Http2FrameListener#onGoAwayRead(io.netty.channel.ChannelHandlerContext, int, long, io.netty.buffer.ByteBuf)} * but is added here in order to simplify application logic for handling {@code GOAWAY} in a uniform way. An * application should generally not handle both events, but if it does this method is called second, after * notifying the {@link Http2FrameListener}. * <p> * If a {@link RuntimeException} is thrown it will be logged and <strong>not propagated. * Throwing from this method is not supported and is considered a programming error. * @param lastStreamId the last known stream of the remote endpoint. * @param errorCode the error code, if abnormal closure. * @param debugData application-defined debug data. */ void onGoAwayReceived(int lastStreamId, long errorCode, ByteBuf debugData); } /** * A view of the connection from one endpoint (local or remote). */ interface Endpoint<F extends Http2FlowController> { /** * Increment and get the next generated stream id this endpoint. If negative, the stream IDs are * exhausted for this endpoint an no further streams may be created. */ int incrementAndGetNextStreamId(); /** * Indicates whether the given streamId is from the set of IDs used by this endpoint to * create new streams. */ boolean isValidStreamId(int streamId); /** * Indicates whether or not this endpoint may have created the given stream. This is {@code true} if * {@link #isValidStreamId(int)} and {@code streamId} <= {@link #lastStreamCreated()}. */ boolean mayHaveCreatedStream(int streamId); /** * Indicates whether or not this endpoint created the given stream. */ boolean created(Http2Stream stream); /** * Indicates whether or a stream created by this endpoint can be opened without violating * {@link #maxActiveStreams()}. */ boolean canOpenStream(); /** * Creates a stream initiated by this endpoint. This could fail for the following reasons: * <ul> * <li>The requested stream ID is not the next sequential ID for this endpoint. * <li>The stream already exists. * <li>The connection is marked as going away. * </ul> * <p> * Note that IDLE streams can always be created so long as there are stream IDs available. * The {@link #numActiveStreams()} will be enforced upon attempting to open the stream. * <p> * If the stream is intended to initialized to {@link Http2Stream.State#OPEN} then use * {@link #createStream(int, boolean)} otherwise optimizations in {@link Listener}s may not work * and memory may be thrashed. The caller is expected to {@link Http2Stream#open(boolean)} the stream. * @param streamId The ID of the stream * @see Http2Stream#open(boolean) */ Http2Stream createIdleStream(int streamId) throws Http2Exception; /** * Creates a stream initiated by this endpoint. This could fail for the following reasons: * <ul> * <li>The requested stream ID is not the next sequential ID for this endpoint. * <li>The stream already exists. * <li>{@link #isExhausted()} is {@code true} * <li>{@link #canOpenStream()} is {@code false}. * <li>The connection is marked as going away. * </ul> * <p> * This method differs from {@link #createIdleStream(int)} because the initial state of the stream will be * Immediately set before notifying {@link Listener}s. The state transition is sensitive to {@code halfClosed} * and is defined by {@link Http2Stream#open(boolean)}. * @param streamId The ID of the stream * @param halfClosed see {@link Http2Stream#open(boolean)}. * @see Http2Stream#open(boolean) */ Http2Stream createStream(int streamId, boolean halfClosed) throws Http2Exception; /** * Creates a push stream in the reserved state for this endpoint and notifies all listeners. * This could fail for the following reasons: * <ul> * <li>Server push is not allowed to the opposite endpoint. * <li>The requested stream ID is not the next sequential stream ID for this endpoint. * <li>The number of concurrent streams is above the allowed threshold for this endpoint. * <li>The connection is marked as going away. * <li>The parent stream ID does not exist or is not {@code OPEN} from the side sending the push * promise.</li> * <li>Could not set a valid priority for the new stream. * </ul> * * @param streamId the ID of the push stream * @param parent the parent stream used to initiate the push stream. */ Http2Stream reservePushStream(int streamId, Http2Stream parent) throws Http2Exception; /** * Indicates whether or not this endpoint is the server-side of the connection. */ boolean isServer(); /** * Sets whether server push is allowed to this endpoint. */ void allowPushTo(boolean allow); /** * Gets whether or not server push is allowed to this endpoint. This is always false * for a server endpoint. */ boolean allowPushTo(); /** * Gets the number of active streams (i.e. {@code OPEN} or {@code HALF CLOSED}) that were created by this * endpoint. */ int numActiveStreams(); /** * Gets the maximum number of streams (created by this endpoint) that are allowed to be active at * the same time. This is the {@code SETTINGS_MAX_CONCURRENT_STREAMS} value sent from the opposite endpoint to * restrict stream creation by this endpoint. */ int maxActiveStreams(); /** * Sets the maximum number of streams (created by this endpoint) that are allowed to be active at once. * This is the {@code SETTINGS_MAX_CONCURRENT_STREAMS} value sent from the opposite endpoint to * restrict stream creation by this endpoint. */ void maxActiveStreams(int maxActiveStreams); /** * Gets the ID of the stream last successfully created by this endpoint. */ int lastStreamCreated(); /** * If a GOAWAY was received for this endpoint, this will be the last stream ID from the * GOAWAY frame. Otherwise, this will be {@code -1}. */ int lastStreamKnownByPeer(); /** * Gets the flow controller for this endpoint. */ F flowController(); /** * Sets the flow controller for this endpoint. */ void flowController(F flowController); /** * Gets the {@link Endpoint} opposite this one. */ Endpoint<? extends Http2FlowController> opposite(); } /** * A key to be used for associating application-defined properties with streams within this connection. */ interface PropertyKey { } /** * 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. * <p>Note if iterating active streams via {@link #forEachActiveStream(Http2StreamVisitor)} and an exception is * thrown it is necessary to call this method again to ensure the close completes. * @param promise Will be completed when all streams have been removed, and listeners have been notified. * @return A future that will be completed when all streams have been removed, and listeners have been notified. */ Future<Void> close(Promise Other Java examples (source code examples)Here is a short list of links related to this Java Http2Connection.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.