Modifier and Type	Class and Description
public static enum	QuicSenderStream.SendingStreamState An enum that models the state of the sending part of a stream.

Method Summary

Modifier and Type	Method and Description
public QuicStreamWriter	Returns: a `QuicStreamWriter` to write data to this stream. connectWriter(SequentialScheduler A sequential scheduler that will push data on the returned writer. scheduler) Connects a writer to the sending end of this stream.
public long	Returns: the amount of data that has been sent dataSent() Returns the amount of data that has been sent.
public void	disconnectWriter(QuicStreamWriter the writer to be disconnected writer) Disconnect the writer, so that a new writer can be connected.
public default boolean	hasError() Implements jdk.internal.net.http.quic.streams.QuicStream.hasError. Returns true if the stream has errors.
public void	reset(long the application error code errorCode) Abruptly closes the writing side of a stream by sending a RESET_STREAM frame.
public QuicSenderStream.SendingStreamState	Returns: the sending state of the stream sendingState() Returns the sending state of the stream.
public long	Returns: the error code for this stream, or `-1` sndErrorCode() Returns the error code for this stream, or `-1`.
public boolean	Returns: true if STOP_SENDING was received stopSendingReceived() Returns true if STOP_SENDING was received.

Inherited from jdk.internal.net.http.quic.streams.QuicStream:: isBidirectional isClientInitiated isLocalInitiated isRemoteInitiated isServerInitiated mode state streamId type

Method Detail

connectWriter back to summary

connectWriter	back to summary
public QuicStreamWriter connectWriter(SequentialScheduler scheduler) Connects a writer to the sending end of this stream. Parameters scheduler:SequentialScheduler A sequential scheduler that will push data on the returned writer. Returns:QuicStreamWriter a `QuicStreamWriter` to write data to this stream. Exceptions IllegalStateException: if a writer is already connected.

public QuicStreamWriter connectWriter(SequentialScheduler scheduler)

Connects a writer to the sending end of this stream.

Parameters

scheduler:SequentialScheduler: A sequential scheduler that will push data on the returned writer.

Returns:QuicStreamWriter

a QuicStreamWriter to write data to this stream.

Exceptions

IllegalStateException:: if a writer is already connected.

dataSent	back to summary
public long dataSent() Returns the amount of data that has been sent. API Note This may include data that has not been acknowledged. Returns:long the amount of data that has been sent

dataSent

back to summary

public long dataSent()

Returns the amount of data that has been sent.

API Note

This may include data that has not been acknowledged.

Returns:long: the amount of data that has been sent

disconnectWriter	back to summary
public void disconnectWriter(QuicStreamWriter writer) Disconnect the writer, so that a new writer can be connected. API Note This can be useful for handing the stream over after having written some bytes. Parameters writer:QuicStreamWriter the writer to be disconnected Exceptions IllegalStateException: if the given writer is not currently connected to the stream

disconnectWriter

back to summary

public void disconnectWriter(QuicStreamWriter writer)

Disconnect the writer, so that a new writer can be connected.

API Note

This can be useful for handing the stream over after having written some bytes.

Parameters

writer:QuicStreamWriter: the writer to be disconnected

Exceptions

IllegalStateException:: if the given writer is not currently connected to the stream

hasError	back to summary
public default boolean hasError() Implements jdk.internal.net.http.quic.streams.QuicStream.hasError. Doc from jdk.internal.net.http.quic.streams.QuicStream.hasError. Returns true if the stream has errors. For a bidirectional stream, this method returns true if either its sending part or its receiving part was closed with a non-zero error code. Annotations @Override

hasError

back to summary

public default boolean hasError()

Implements jdk.internal.net.http.quic.streams.QuicStream.hasError.

Doc from jdk.internal.net.http.quic.streams.QuicStream.hasError.

Returns true if the stream has errors. For a bidirectional stream, this method returns true if either its sending part or its receiving part was closed with a non-zero error code.

Annotations

@Override

reset	back to summary
public void reset(long errorCode) throws IOException Abruptly closes the writing side of a stream by sending a RESET_STREAM frame. Parameters errorCode:long the application error code

reset

back to summary

public void reset(long errorCode) throws IOException

Abruptly closes the writing side of a stream by sending a RESET_STREAM frame.

Parameters

errorCode:long: the application error code

sendingState	back to summary
public QuicSenderStream.SendingStreamState sendingState() Returns the sending state of the stream. Returns:QuicSenderStream.SendingStreamState the sending state of the stream

sendingState

back to summary

public QuicSenderStream.SendingStreamState sendingState()

Returns the sending state of the stream.

Returns:QuicSenderStream.SendingStreamState: the sending state of the stream

sndErrorCode back to summary

sndErrorCode	back to summary
public long sndErrorCode() Returns the error code for this stream, or `-1`. Returns:long the error code for this stream, or `-1`

public long sndErrorCode()

Returns the error code for this stream, or -1.

Returns:long: the error code for this stream, or -1

stopSendingReceived	back to summary
public boolean stopSendingReceived() Returns true if STOP_SENDING was received. Returns:boolean true if STOP_SENDING was received

stopSendingReceived

back to summary

public boolean stopSendingReceived()

Returns true if STOP_SENDING was received.

Returns:boolean: true if STOP_SENDING was received

jdk.internal.net.http.quic.streams back to summary

public final Enum QuicSenderStream.SendingStreamState

Class Inheritance

extends Enum<QuicSenderStream.SendingStreamState>
implements StreamState

java.lang.Object
java.lang.Enum
jdk.internal.net.http.quic.streams.QuicSenderStream.SendingStreamState

All Implemented Interfaces

jdk.internal.net.http.quic.streams.QuicStream.StreamState

An enum that models the state of the sending part of a stream.

Field Summary

Modifier and Type	Field and Description
public static final QuicSenderStream.SendingStreamState	DATA_RECVD Once all stream data has been successfully acknowledged, the sending part of the stream enters the "Data Recvd" state, which is a terminal state.
public static final QuicSenderStream.SendingStreamState	DATA_SENT After the application indicates that all stream data has been sent and a STREAM frame containing the FIN bit is sent, the sending part of the stream enters the "Data Sent" state.
public static final QuicSenderStream.SendingStreamState	READY The "Ready" state represents a newly created stream that is able to accept data from the application.
public static final QuicSenderStream.SendingStreamState	RESET_RECVD Once a packet containing a RESET_STREAM has been acknowledged, the sending part of the stream enters the "Reset Recvd" state, which is a terminal state.
public static final QuicSenderStream.SendingStreamState	RESET_SENT From any state that is one of "Ready", "Send", or "Data Sent", an application can signal that it wishes to abandon transmission of stream data.
public static final QuicSenderStream.SendingStreamState	SEND In the "Send" state, an endpoint transmits -- and retransmits as necessary -- stream data in STREAM frames.

Constructor Summary

Access	Constructor and Description
private	SendingStreamState()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if this state indicates that the stream has been reset by the sender isReset() Returns true if this state indicates that the stream has been reset by the sender.
public boolean	Returns: true if a stream in this state can be used for sending, that is, if this state is either `READY` or `SEND` isSending() Returns true if a stream in this state can be used for sending, that is, if this state is either `READY` or `SEND`.
public boolean	isTerminal() Implements jdk.internal.net.http.quic.streams.QuicStream.StreamState.isTerminal. Returns true if this is a terminal state.
public static QuicSenderStream.SendingStreamState	valueOf(String name)
public static QuicSenderStream.SendingStreamState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DATA_RECVD	back to summary
public static final QuicSenderStream.SendingStreamState DATA_RECVD Once all stream data has been successfully acknowledged, the sending part of the stream enters the "Data Recvd" state, which is a terminal state. [RFC 9000, Section 3.1] (https://www.rfc-editor.org/rfc/rfc9000#name-sending-stream-states)

DATA_RECVD

back to summary

public static final QuicSenderStream.SendingStreamState DATA_RECVD

Once all stream data has been successfully acknowledged, the sending part of the stream enters the "Data Recvd" state, which is a terminal state.