OpenJDK 27 · jdk.internal.net.http.http3.streams.PeerUniStreamDispatcher

Modifier and Type	Field and Description
private final CompletableFuture<QuicReceiverStream>	cf
private final QuicStreamIntReader	reader
private final QuicReceiverStream	stream

Access	Constructor and Description
protected	PeerUniStreamDispatcher(QuicReceiverStream a new unidirectional stream opened by the peer stream) Creates a `PeerUniStreamDispatcher` for the given stream.

Method Summary

Modifier and Type	Method and Description
protected void	abandon() This method disconnects the reader, stops the dispatch, and unless the stream type could be decoded and was a reserved type, calls `onStreamAbandoned(QuicReceiverStream)`
private void	abort(Throwable the reason for aborting the dispatch throwable) Aborts the dispatch - for instance, if the stream type can't be read, or isn't recognized.
private static QuicReceiverStream	checkStream(QuicReceiverStream stream)
private void	controlStream(String description, Http3Streams.StreamType type)
protected abstract Logger	Returns: the debug logger that should be used debug() Returns the debug logger that should be used.
private void	dispatch(Long result, Throwable error)
public CompletableFuture<QuicReceiverStream>	Returns: a completable future that will contain the dispatched stream, once dispatched, or a throwable if dispatching the stream failed dispatchCF() Returns a completable future that will contain the dispatched stream, once dispatched, or a throwable if dispatching the stream failed.
private void	dispatchPushStream(Long result, Throwable error)
protected abstract void	onControlStreamCreated(String a brief description of the stream for logging purposes description, QuicReceiverStream the peer control stream stream) Called after disconnecting to handle the peer control stream.
protected abstract void	onDecoderStreamCreated(String a brief description of the stream for logging purposes description, QuicReceiverStream the peer decoder stream stream) Called after disconnecting to handle the peer decoder stream.
protected abstract void	onEncoderStreamCreated(String a brief description of the stream for logging purposes description, QuicReceiverStream the peer encoder stream stream) Called after disconnecting to handle the peer encoder stream.
protected abstract void	onPushStreamCreated(String a brief description of the stream for logging purposes description, QuicReceiverStream a peer initiated push stream stream, long pushId) Called after disconnecting to handle a peer initiated push stream.
protected void	onReservedStreamType(long the unrecognized stream type code, QuicReceiverStream the peer initiated stream stream) Called when a reserved stream type is read off the stream.
protected void	onStreamAbandoned(QuicReceiverStream a peer initiated stream which was abandoned due to having an unknown type, or which was abandoned due to being reset before being dispatched. stream) Called after disconnecting to abandon a peer initiated stream.
protected void	onUnknownStreamType(long the unrecognized stream type code, QuicReceiverStream the peer initiated stream stream) Called when an unrecognized stream type is read off the stream.
private void	pushStream(String description, Http3Streams.StreamType type, long pushId)
private void	qpackDecoderStream(String description, Http3Streams.StreamType type)
private void	qpackEncoderStream(String description, Http3Streams.StreamType type)
private void	reservedStreamType(long code, QuicReceiverStream stream)
protected void	start() Starts the dispatcher.
private void	unknownStreamType(long code, QuicReceiverStream stream)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

cf	back to summary
private final CompletableFuture<QuicReceiverStream> cf

reader	back to summary
private final QuicStreamIntReader reader

stream	back to summary
private final QuicReceiverStream stream

PeerUniStreamDispatcher	back to summary
protected PeerUniStreamDispatcher(QuicReceiverStream stream) Creates a `PeerUniStreamDispatcher` for the given stream. Parameters stream:QuicReceiverStream a new unidirectional stream opened by the peer

Method Detail

abandon	back to summary
protected void abandon() This method disconnects the reader, stops the dispatch, and unless the stream type could be decoded and was a reserved type, calls `onStreamAbandoned(QuicReceiverStream)`

abort back to summary

abort	back to summary
private void abort(Throwable throwable) Aborts the dispatch - for instance, if the stream type can't be read, or isn't recognized. This method requests the peer to stop sending this stream, and completes the `dispatchCF` exceptionally with the provided throwable. Parameters throwable:Throwable the reason for aborting the dispatch

private void abort(Throwable throwable)

Aborts the dispatch - for instance, if the stream type can't be read, or isn't recognized.

This method requests the peer to stop sending this stream, and completes the dispatchCF exceptionally with the provided throwable.

Parameters

throwable:Throwable: the reason for aborting the dispatch

checkStream	back to summary
private static QuicReceiverStream checkStream(QuicReceiverStream stream)

controlStream	back to summary
private void controlStream(String description, Http3Streams.StreamType type)

debug	back to summary
protected abstract Logger debug() Returns the debug logger that should be used. Returns:Logger the debug logger that should be used

debug

back to summary

protected abstract Logger debug()

Returns the debug logger that should be used.

Returns:Logger: the debug logger that should be used

dispatch	back to summary
private void dispatch(Long result, Throwable error)

dispatchCF	back to summary
public CompletableFuture<QuicReceiverStream> dispatchCF() Returns a completable future that will contain the dispatched stream, once dispatched, or a throwable if dispatching the stream failed. Returns:CompletableFuture<QuicReceiverStream> a completable future that will contain the dispatched stream, once dispatched, or a throwable if dispatching the stream failed

dispatchCF

back to summary

public CompletableFuture<QuicReceiverStream> dispatchCF()

Returns a completable future that will contain the dispatched stream, once dispatched, or a throwable if dispatching the stream failed.

Returns:CompletableFuture<QuicReceiverStream>: a completable future that will contain the dispatched stream, once dispatched, or a throwable if dispatching the stream failed

dispatchPushStream	back to summary
private void dispatchPushStream(Long result, Throwable error)

onControlStreamCreated	back to summary
protected abstract void onControlStreamCreated(String description, QuicReceiverStream stream) Called after disconnecting to handle the peer control stream. The stream type has already been read off the stream. Parameters description:String a brief description of the stream for logging purposes stream:QuicReceiverStream the peer control stream

onControlStreamCreated

back to summary

protected abstract void onControlStreamCreated(String description, QuicReceiverStream stream)

Called after disconnecting to handle the peer control stream. The stream type has already been read off the stream.

Parameters

description:String: a brief description of the stream for logging purposes
stream:QuicReceiverStream: the peer control stream

onDecoderStreamCreated	back to summary
protected abstract void onDecoderStreamCreated(String description, QuicReceiverStream stream) Called after disconnecting to handle the peer decoder stream. The stream type has already been read off the stream. Parameters description:String a brief description of the stream for logging purposes stream:QuicReceiverStream the peer decoder stream

onDecoderStreamCreated

back to summary

protected abstract void onDecoderStreamCreated(String description, QuicReceiverStream stream)

Called after disconnecting to handle the peer decoder stream. The stream type has already been read off the stream.

Parameters

description:String: a brief description of the stream for logging purposes
stream:QuicReceiverStream: the peer decoder stream

onEncoderStreamCreated	back to summary
protected abstract void onEncoderStreamCreated(String description, QuicReceiverStream stream) Called after disconnecting to handle the peer encoder stream. The stream type has already been read off the stream. Parameters description:String a brief description of the stream for logging purposes stream:QuicReceiverStream the peer encoder stream

onEncoderStreamCreated

back to summary

protected abstract void onEncoderStreamCreated(String description, QuicReceiverStream stream)

Called after disconnecting to handle the peer encoder stream. The stream type has already been read off the stream.

Parameters

description:String: a brief description of the stream for logging purposes
stream:QuicReceiverStream: the peer encoder stream

onPushStreamCreated	back to summary
protected abstract void onPushStreamCreated(String description, QuicReceiverStream stream, long pushId) Called after disconnecting to handle a peer initiated push stream. The stream type has already been read off the stream. Parameters description:String a brief description of the stream for logging purposes stream:QuicReceiverStream a peer initiated push stream

onPushStreamCreated

back to summary

protected abstract void onPushStreamCreated(String description, QuicReceiverStream stream, long pushId)

Called after disconnecting to handle a peer initiated push stream. The stream type has already been read off the stream.

Parameters

description:String: a brief description of the stream for logging purposes
stream:QuicReceiverStream: a peer initiated push stream

onReservedStreamType back to summary

onReservedStreamType	back to summary
protected void onReservedStreamType(long code, QuicReceiverStream stream) Called when a reserved stream type is read off the stream. Implementation Specification The default implementation of this method calls `stream.requestStopSending(Http3Error.H3_STREAM_CREATION_ERROR.code());` stream.requestStopSending(Http3Error.H3_STREAM_CREATION_ERROR.code()); Parameters code:long the unrecognized stream type stream:QuicReceiverStream the peer initiated stream

protected void onReservedStreamType(long code, QuicReceiverStream stream)

Called when a reserved stream type is read off the stream.

Implementation Specification

The default implementation of this method calls

stream.requestStopSending(Http3Error.H3_STREAM_CREATION_ERROR.code());

Parameters

code:long: the unrecognized stream type
stream:QuicReceiverStream: the peer initiated stream

onStreamAbandoned	back to summary
protected void onStreamAbandoned(QuicReceiverStream stream) Called after disconnecting to abandon a peer initiated stream. API Note A subclass may want to override this method in order to, e.g, emit a QPack Stream Cancellation instruction; See https://www.rfc-editor.org/rfc/rfc9204.html#name-abandonment-of-a-stream Parameters stream:QuicReceiverStream a peer initiated stream which was abandoned due to having an unknown type, or which was abandoned due to being reset before being dispatched.

onStreamAbandoned

back to summary

protected void onStreamAbandoned(QuicReceiverStream stream)

Called after disconnecting to abandon a peer initiated stream.

API Note

A subclass may want to override this method in order to, e.g, emit a QPack Stream Cancellation instruction; See https://www.rfc-editor.org/rfc/rfc9204.html#name-abandonment-of-a-stream

Parameters

stream:QuicReceiverStream: a peer initiated stream which was abandoned due to having an unknown type, or which was abandoned due to being reset before being dispatched.

onUnknownStreamType back to summary

onUnknownStreamType	back to summary
protected void onUnknownStreamType(long code, QuicReceiverStream stream) Called when an unrecognized stream type is read off the stream. Implementation Specification The default implementation of this method calls `stream.requestStopSending(Http3Error.H3_STREAM_CREATION_ERROR.code()); abandon();` stream.requestStopSending(Http3Error.H3_STREAM_CREATION_ERROR.code()); abandon(); Parameters code:long the unrecognized stream type stream:QuicReceiverStream the peer initiated stream

protected void onUnknownStreamType(long code, QuicReceiverStream stream)

Called when an unrecognized stream type is read off the stream.

Implementation Specification

The default implementation of this method calls

stream.requestStopSending(Http3Error.H3_STREAM_CREATION_ERROR.code());
abandon();

Parameters

code:long: the unrecognized stream type
stream:QuicReceiverStream: the peer initiated stream

pushStream	back to summary
private void pushStream(String description, Http3Streams.StreamType type, long pushId)

qpackDecoderStream	back to summary
private void qpackDecoderStream(String description, Http3Streams.StreamType type)

qpackEncoderStream	back to summary
private void qpackEncoderStream(String description, Http3Streams.StreamType type)

reservedStreamType	back to summary
private void reservedStreamType(long code, QuicReceiverStream stream)

start	back to summary
protected void start() Starts the dispatcher. API Note The dispatcher should be explicitly started after creating the dispatcher.

unknownStreamType	back to summary
private void unknownStreamType(long code, QuicReceiverStream stream)

public abstract Class PeerUniStreamDispatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail