An interface to model a QuicStream. A quic stream can be either unidirectional or bidirectional. A unidirectional stream can be opened for reading or for writing. Concrete subclasses of QuicStream should implement QuicSenderStream (unidirectional StreamMode#WRITE_ONLY stream), or QuicReceiverStream (unidirectional StreamMode#READ_ONLY stream), or QuicBidiStream (bidirectional StreamMode#READ_WRITE stream).

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	QuicStream.StreamMode The stream operation mode.
public static interface	QuicStream.StreamState An interface that unifies the three different stream states.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the stream has errors hasError() Returns true if the stream has errors.
public boolean	Returns: whether this stream is bidirectional isBidirectional() Returns whether this stream is bidirectional.
public boolean	Returns: whether this stream is client initiated isClientInitiated() Returns whether this stream is client initiated.
public boolean	Returns: true if this stream is local initiated isLocalInitiated() Returns true if this stream is local initiated.
public boolean	Returns: true if this stream is remote initiated isRemoteInitiated() Returns true if this stream is remote initiated.
public boolean	Returns: whether this stream is server initiated isServerInitiated() Returns whether this stream is server initiated.
public QuicStream.StreamMode	Returns: this stream operation mode mode() Returns this stream operation mode.
public QuicStream.StreamState	Returns: the combined stream state state() Returns the combined stream state.
public long	Returns: the stream ID of this stream streamId() Returns the stream ID of this stream.
public int	Returns: the type of this stream, as an int type() The type of this stream, as an int.

Method Detail

hasError	back to summary
public boolean 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. Returns:boolean true if the stream has errors

hasError

back to summary

public boolean 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.

Returns:boolean: true if the stream has errors

isBidirectional	back to summary
public boolean isBidirectional() Returns whether this stream is bidirectional. Returns:boolean whether this stream is bidirectional

isBidirectional

back to summary

public boolean isBidirectional()

Returns whether this stream is bidirectional.

Returns:boolean: whether this stream is bidirectional

isClientInitiated	back to summary
public boolean isClientInitiated() Returns whether this stream is client initiated. Returns:boolean whether this stream is client initiated

isClientInitiated

back to summary

public boolean isClientInitiated()

Returns whether this stream is client initiated.

Returns:boolean: whether this stream is client initiated

isLocalInitiated	back to summary
public boolean isLocalInitiated() Returns true if this stream is local initiated. Returns:boolean true if this stream is local initiated

isLocalInitiated

back to summary

public boolean isLocalInitiated()

Returns true if this stream is local initiated.

Returns:boolean: true if this stream is local initiated

isRemoteInitiated	back to summary
public boolean isRemoteInitiated() Returns true if this stream is remote initiated. Returns:boolean true if this stream is remote initiated

isRemoteInitiated

back to summary

public boolean isRemoteInitiated()

Returns true if this stream is remote initiated.

Returns:boolean: true if this stream is remote initiated

isServerInitiated	back to summary
public boolean isServerInitiated() Returns whether this stream is server initiated. Returns:boolean whether this stream is server initiated

isServerInitiated

back to summary

public boolean isServerInitiated()

Returns whether this stream is server initiated.

Returns:boolean: whether this stream is server initiated

mode back to summary

mode	back to summary
public QuicStream.StreamMode mode() Returns this stream operation mode. One of `StreamMode#READ_ONLY`, `StreamMode#WRITE_ONLY`, or `StreamMode#READ_WRITE`. Returns:QuicStream.StreamMode this stream operation mode

public QuicStream.StreamMode mode()

Returns this stream operation mode. One of StreamMode#READ_ONLY, StreamMode#WRITE_ONLY, or StreamMode#READ_WRITE.

Returns:QuicStream.StreamMode: this stream operation mode

state	back to summary
public QuicStream.StreamState state() Returns the combined stream state. API Note This is mostly used for logging purposes, to log the combined state of a stream. Returns:QuicStream.StreamState the combined stream state

state

back to summary

public QuicStream.StreamState state()

Returns the combined stream state.

API Note

This is mostly used for logging purposes, to log the combined state of a stream.

Returns:QuicStream.StreamState: the combined stream state

streamId	back to summary
public long streamId() Returns the stream ID of this stream. Returns:long the stream ID of this stream

streamId

back to summary

public long streamId()

Returns the stream ID of this stream.

Returns:long: the stream ID of this stream

type	back to summary
public int type() The type of this stream, as an int. This is a number between 0 and 3 inclusive, and corresponds to the last two lowest bits of the stream ID. 0x00: bidirectional, client initiated 0x01: bidirectional, server initiated 0x02: unidirectional, client initiated 0x03: unidirectional, server initiated Returns:int the type of this stream, as an int

type

back to summary

public int type()

The type of this stream, as an int. This is a number between 0 and 3 inclusive, and corresponds to the last two lowest bits of the stream ID.

0x00: bidirectional, client initiated
0x01: bidirectional, server initiated
0x02: unidirectional, client initiated
0x03: unidirectional, server initiated

Returns:int: the type of this stream, as an int

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

public final Enum QuicStream.StreamMode

Class Inheritance

extends Enum<QuicStream.StreamMode>

java.lang.Object
java.lang.Enum
jdk.internal.net.http.quic.streams.QuicStream.StreamMode

The stream operation mode. One of READ_ONLY, WRITE_ONLY, or READ_WRITE.

Field Summary

Modifier and Type	Field and Description
public static final QuicStream.StreamMode	READ_ONLY
public static final QuicStream.StreamMode	READ_WRITE
public static final QuicStream.StreamMode	WRITE_ONLY

Constructor Summary

Access	Constructor and Description
private	StreamMode()

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if this operation mode allows reading data from the stream isReadable() Returns true if this operation mode allows reading data from the stream.
public boolean	Returns: true if this operation mode allows writing data to the stream isWritable() Returns true if this operation mode allows writing data to the stream.
public static QuicStream.StreamMode	valueOf(String name)
public static QuicStream.StreamMode[]	values()

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

Field Detail

READ_ONLY	back to summary
public static final QuicStream.StreamMode READ_ONLY

READ_WRITE	back to summary
public static final QuicStream.StreamMode READ_WRITE

WRITE_ONLY	back to summary
public static final QuicStream.StreamMode WRITE_ONLY

Constructor Detail

StreamMode	back to summary
private StreamMode()

Method Detail

isReadable	back to summary
public boolean isReadable() Returns true if this operation mode allows reading data from the stream. Returns:boolean true if this operation mode allows reading data from the stream

isReadable

back to summary

public boolean isReadable()

Returns true if this operation mode allows reading data from the stream.

Returns:boolean: true if this operation mode allows reading data from the stream

isWritable	back to summary
public boolean isWritable() Returns true if this operation mode allows writing data to the stream. Returns:boolean true if this operation mode allows writing data to the stream

isWritable

back to summary

public boolean isWritable()

Returns true if this operation mode allows writing data to the stream.

Returns:boolean: true if this operation mode allows writing data to the stream

valueOf	back to summary
public static QuicStream.StreamMode valueOf(String name)

values	back to summary
public static QuicStream.StreamMode[] values()

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

public sealed Interface QuicStream.StreamState

Known Direct Implementers: jdk.internal.net.http.quic.streams.QuicBidiStream.BidiStreamState, jdk.internal.net.http.quic.streams.QuicReceiverStream.ReceivingStreamState, jdk.internal.net.http.quic.streams.QuicSenderStream.SendingStreamState

An interface that unifies the three different stream states.

API Note

This is mostly used for logging purposes, to log the combined state of a stream.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if this is a terminal state isTerminal() Returns true if this is a terminal state.
public String	name()

Method Detail

isTerminal	back to summary
public boolean isTerminal() Returns true if this is a terminal state. Returns:boolean true if this is a terminal state

isTerminal

back to summary

public boolean isTerminal()

Returns true if this is a terminal state.

Returns:boolean: true if this is a terminal state

name	back to summary
public String name()