Modifier and Type	Class and Description
private static enum	HTTP3Stream.CloseState
protected static enum	HTTP3Stream.FrameState Defines the state of the stream for received frames, allowing to verify that a frame sequence is valid for the HTTP protocol.

Modifier and Type	Field and Description
private Object	attachment
private HTTP3Stream.CloseState	closeState
private boolean	dataAvailable
private boolean	dataDemand
private boolean	dataLast
private final AtomicReference<Stream.Data>	dataRef
private boolean	dataStalled
private final QuicStreamEndPoint	endPoint
private long	expireNanoTime
private HTTP3Stream.FrameState	frameState
private long	idleTimeout
private final boolean	local
private final AutoLock	lock
private static final Logger	LOG
private final HTTP3Session	session

Access	Constructor and Description
public	HTTP3Stream(HTTP3Session session, QuicStreamEndPoint endPoint, boolean local)

Method Summary

Modifier and Type	Method and Description
public CompletableFuture<Stream>	data(DataFrame frame) Implements org.eclipse.jetty.http3.api.Stream.data. Sends the given DATA frame containing some or all the bytes of the request content or of the response content.
public void	demand() Implements org.eclipse.jetty.http3.api.Stream.demand. Demands more `DATA` frames for this stream.
public Object	getAttachment() Implements org.eclipse.jetty.util.Attachable.getAttachment.
public QuicStreamEndPoint	getEndPoint()
public long	getExpireNanoTime() Implements org.eclipse.jetty.io.CyclicTimeouts.Expirable.getExpireNanoTime. Returns the expiration time in nanoseconds.
public long	getId() Implements org.eclipse.jetty.http3.api.Stream.getId. Get the stream id.
public long	getIdleTimeout()
public HTTP3Session	getSession() Implements org.eclipse.jetty.http3.api.Stream.getSession. Get the session this stream is associated to.
public boolean	hasDemand()
protected boolean	hasDemandOrStall()
public boolean	isClosed()
private boolean	isLast()
public boolean	isLocal()
private boolean	isStalled()
protected void	notIdle()
protected abstract void	notifyDataAvailable()
protected abstract void	notifyFailure(long error, Throwable failure)
protected abstract void	notifyIdleTimeout(TimeoutException timeout, Promise<Boolean> promise)
protected abstract void	notifyTrailer(HeadersFrame frame)
public void	onData(DataFrame ignored)
public void	onData(Stream.Data data)
private void	onDataAvailable()
public void	onFailure(long error, Throwable failure)
public void	onHeaders(HeadersFrame frame)
pack-priv void	onIdleTimeout(TimeoutException timeout, Promise<Boolean> promise)
public void	onTrailer(HeadersFrame frame)
private void	processData()
private Stream.Data	read()
public Stream.Data	readData() Implements org.eclipse.jetty.http3.api.Stream.readData. Reads request content bytes or response content bytes.
public void	reset(long error, Throwable failure) Implements org.eclipse.jetty.http3.api.Stream.reset. Abruptly terminates this stream with the given error.
public void	setAttachment(Object attachment) Implements org.eclipse.jetty.util.Attachable.setAttachment. Attaches the given object to this stream for later retrieval.
public void	setIdleTimeout(long idleTimeout)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public CompletableFuture<Stream>	trailer(HeadersFrame frame) Implements org.eclipse.jetty.http3.api.Stream.trailer. Sends the given HEADERS frame containing the trailer headers.
public void	updateClose(boolean update, boolean local)
protected boolean	validateAndUpdate(EnumSet<HTTP3Stream.FrameState> allowed, HTTP3Stream.FrameState target)
protected CompletableFuture<Stream>	write(Frame frame)
public Promise.Completable<Stream>	writeFrame(Frame frame)

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

Field Detail

attachment	back to summary
private Object attachment

closeState	back to summary
private HTTP3Stream.CloseState closeState

dataAvailable	back to summary
private boolean dataAvailable

dataDemand	back to summary
private boolean dataDemand

dataLast	back to summary
private boolean dataLast

dataRef	back to summary
private final AtomicReference<Stream.Data> dataRef

dataStalled	back to summary
private boolean dataStalled

endPoint	back to summary
private final QuicStreamEndPoint endPoint

expireNanoTime	back to summary
private long expireNanoTime

frameState	back to summary
private HTTP3Stream.FrameState frameState

idleTimeout	back to summary
private long idleTimeout

local	back to summary
private final boolean local

lock	back to summary
private final AutoLock lock

LOG	back to summary
private static final Logger LOG

session	back to summary
private final HTTP3Session session

Constructor Detail

HTTP3Stream	back to summary
public HTTP3Stream(HTTP3Session session, QuicStreamEndPoint endPoint, boolean local)

Method Detail

data	back to summary
public CompletableFuture<Stream> data(DataFrame frame) Implements org.eclipse.jetty.http3.api.Stream.data. Doc from org.eclipse.jetty.http3.api.Stream.data. Sends the given DATA frame containing some or all the bytes of the request content or of the response content. Annotations @Override

demand back to summary

demand	back to summary
public void demand() Implements org.eclipse.jetty.http3.api.Stream.demand. Doc from org.eclipse.jetty.http3.api.Stream.demand. Demands more `DATA` frames for this stream. Calling this method causes `Stream.Client.Listener#onDataAvailable(Stream.Client)` on the client, or `Stream.Server.Listener#onDataAvailable(Stream.Server)` on the server, to be invoked, possibly at a later time, when the stream has data to be read, but also when the stream has reached EOF. This method is idempotent: calling it when there already is an outstanding demand to invoke `onDataAvailable(Stream)` is a no-operation. The thread invoking this method may invoke directly `onDataAvailable(Stream)`, unless another thread that must invoke `onDataAvailable(Stream)` notices the outstanding demand first. It is always guaranteed that invoking this method from within `onDataAvailable(Stream)` will not cause a `StackOverflowError`. Annotations @Override

public void demand()

Implements org.eclipse.jetty.http3.api.Stream.demand.

Doc from org.eclipse.jetty.http3.api.Stream.demand.

Demands more DATA frames for this stream.

Calling this method causes Stream.Client.Listener#onDataAvailable(Stream.Client) on the client, or Stream.Server.Listener#onDataAvailable(Stream.Server) on the server, to be invoked, possibly at a later time, when the stream has data to be read, but also when the stream has reached EOF.

This method is idempotent: calling it when there already is an outstanding demand to invoke onDataAvailable(Stream) is a no-operation.

The thread invoking this method may invoke directly onDataAvailable(Stream), unless another thread that must invoke onDataAvailable(Stream) notices the outstanding demand first.

It is always guaranteed that invoking this method from within onDataAvailable(Stream) will not cause a StackOverflowError.

Annotations

@Override

getAttachment	back to summary
public Object getAttachment() Implements org.eclipse.jetty.util.Attachable.getAttachment. Annotations @Override

getAttachment

back to summary

public Object getAttachment()

Implements org.eclipse.jetty.util.Attachable.getAttachment.

Annotations

@Override

getEndPoint	back to summary
public QuicStreamEndPoint getEndPoint()

getExpireNanoTime back to summary

getExpireNanoTime	back to summary
public long getExpireNanoTime() Implements org.eclipse.jetty.io.CyclicTimeouts.Expirable.getExpireNanoTime. Doc from org.eclipse.jetty.io.CyclicTimeouts.Expirable.getExpireNanoTime. Returns the expiration time in nanoseconds. The value to return must be calculated taking into account the current nanoTime, for example: `expireNanoTime = NanoTime.now() + timeoutNanos` Returning `Long#MAX_VALUE` indicates that this entity does not expire. Annotations @Override

public long getExpireNanoTime()

Implements org.eclipse.jetty.io.CyclicTimeouts.Expirable.getExpireNanoTime.

Doc from org.eclipse.jetty.io.CyclicTimeouts.Expirable.getExpireNanoTime.

Returns the expiration time in nanoseconds.

The value to return must be calculated taking into account the current nanoTime, for example:

expireNanoTime = NanoTime.now() + timeoutNanos

Returning Long#MAX_VALUE indicates that this entity does not expire.

Annotations

@Override

getId	back to summary
public long getId() Implements org.eclipse.jetty.http3.api.Stream.getId. Doc from org.eclipse.jetty.http3.api.Stream.getId. Get the stream id. Annotations @Override

getId

back to summary

public long getId()

Implements org.eclipse.jetty.http3.api.Stream.getId.

Doc from org.eclipse.jetty.http3.api.Stream.getId.

Get the stream id.

Annotations

@Override

getIdleTimeout	back to summary
public long getIdleTimeout()

getSession	back to summary
public HTTP3Session getSession() Implements org.eclipse.jetty.http3.api.Stream.getSession. Doc from org.eclipse.jetty.http3.api.Stream.getSession. Get the session this stream is associated to. Annotations @Override

getSession

back to summary

public HTTP3Session getSession()

Implements org.eclipse.jetty.http3.api.Stream.getSession.

Doc from org.eclipse.jetty.http3.api.Stream.getSession.

Get the session this stream is associated to.

Annotations

@Override

hasDemand	back to summary
public boolean hasDemand()

hasDemandOrStall	back to summary
protected boolean hasDemandOrStall()

isClosed	back to summary
public boolean isClosed()

isLast	back to summary
private boolean isLast()

isLocal	back to summary
public boolean isLocal()

isStalled	back to summary
private boolean isStalled()

notIdle	back to summary
protected void notIdle()

notifyDataAvailable	back to summary
protected abstract void notifyDataAvailable()

notifyFailure	back to summary
protected abstract void notifyFailure(long error, Throwable failure)

notifyIdleTimeout	back to summary
protected abstract void notifyIdleTimeout(TimeoutException timeout, Promise<Boolean> promise)

notifyTrailer	back to summary
protected abstract void notifyTrailer(HeadersFrame frame)

onData	back to summary
public void onData(DataFrame ignored)

onData	back to summary
public void onData(Stream.Data data)

onDataAvailable	back to summary
private void onDataAvailable()

onFailure	back to summary
public void onFailure(long error, Throwable failure)

onHeaders	back to summary
public void onHeaders(HeadersFrame frame)

onIdleTimeout	back to summary
pack-priv void onIdleTimeout(TimeoutException timeout, Promise<Boolean> promise)

onTrailer	back to summary
public void onTrailer(HeadersFrame frame)

processData	back to summary
private void processData()

read	back to summary
private Stream.Data read()

readData back to summary

readData	back to summary
public Stream.Data readData() Implements org.eclipse.jetty.http3.api.Stream.readData. Doc from org.eclipse.jetty.http3.api.Stream.readData. Reads request content bytes or response content bytes. The returned `Stream.Data` object may be `null`, indicating that the end of the read side of the stream has not yet been reached, which may happen in these cases: not all the bytes have been received so far, for example the remote peer did not send them yet, or they are in-flight all the bytes have been received, but there is a trailer HEADERS frame to be received to indicate the end of the read side of the stream When the returned `Stream.Data` object is not `null`, applications must call, either immediately or later (possibly asynchronously) `Stream.Data#release()` to notify the implementation that the bytes have been processed. `Stream.Data` objects may be stored away for later, asynchronous, processing (for example, to process them only when all of them have been received). Annotations @Override

public Stream.Data readData()

Implements org.eclipse.jetty.http3.api.Stream.readData.

Doc from org.eclipse.jetty.http3.api.Stream.readData.

Reads request content bytes or response content bytes.

The returned Stream.Data object may be null, indicating that the end of the read side of the stream has not yet been reached, which may happen in these cases:

not all the bytes have been received so far, for example the remote peer did not send them yet, or they are in-flight
all the bytes have been received, but there is a trailer HEADERS frame to be received to indicate the end of the read side of the stream

When the returned Stream.Data object is not null, applications must call, either immediately or later (possibly asynchronously) Stream.Data#release() to notify the implementation that the bytes have been processed.

Stream.Data objects may be stored away for later, asynchronous, processing (for example, to process them only when all of them have been received).

Annotations

@Override

reset	back to summary
public void reset(long error, Throwable failure) Implements org.eclipse.jetty.http3.api.Stream.reset. Doc from org.eclipse.jetty.http3.api.Stream.reset. Abruptly terminates this stream with the given error. Annotations @Override

reset

back to summary

public void reset(long error, Throwable failure)

Implements org.eclipse.jetty.http3.api.Stream.reset.

Doc from org.eclipse.jetty.http3.api.Stream.reset.

Abruptly terminates this stream with the given error.

Annotations

@Override

setAttachment

back to summary

public void setAttachment(Object attachment)

Implements org.eclipse.jetty.util.Attachable.setAttachment.

Doc from org.eclipse.jetty.util.Attachable.setAttachment.

Attaches the given object to this stream for later retrieval.

Annotations

@Override

setIdleTimeout	back to summary
public void setIdleTimeout(long idleTimeout)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

trailer

back to summary

public CompletableFuture<Stream> trailer(HeadersFrame frame)

Implements org.eclipse.jetty.http3.api.Stream.trailer.

Doc from org.eclipse.jetty.http3.api.Stream.trailer.

Sends the given HEADERS frame containing the trailer headers.

Annotations

@Override

updateClose	back to summary
public void updateClose(boolean update, boolean local)

validateAndUpdate	back to summary
protected boolean validateAndUpdate(EnumSet<HTTP3Stream.FrameState> allowed, HTTP3Stream.FrameState target)

write	back to summary
protected CompletableFuture<Stream> write(Frame frame)

writeFrame	back to summary
public Promise.Completable<Stream> writeFrame(Frame frame)

org.eclipse.jetty.http3 back to summary

private final Enum HTTP3Stream.CloseState

Class Inheritance

extends Enum<HTTP3Stream.CloseState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.http3.HTTP3Stream.CloseState

Field Summary

Modifier and Type	Field and Description
public static final HTTP3Stream.CloseState	CLOSED
public static final HTTP3Stream.CloseState	LOCALLY_CLOSED
public static final HTTP3Stream.CloseState	NOT_CLOSED
public static final HTTP3Stream.CloseState	REMOTELY_CLOSED

Constructor Summary

Access	Constructor and Description
private	CloseState()

Method Summary

Modifier and Type	Method and Description
public static HTTP3Stream.CloseState	valueOf(String name)
public static HTTP3Stream.CloseState[]	values()

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

Field Detail

CLOSED	back to summary
public static final HTTP3Stream.CloseState CLOSED

LOCALLY_CLOSED	back to summary
public static final HTTP3Stream.CloseState LOCALLY_CLOSED

NOT_CLOSED	back to summary
public static final HTTP3Stream.CloseState NOT_CLOSED

REMOTELY_CLOSED	back to summary
public static final HTTP3Stream.CloseState REMOTELY_CLOSED

Constructor Detail

CloseState	back to summary
private CloseState()

Method Detail

valueOf	back to summary
public static HTTP3Stream.CloseState valueOf(String name)

values	back to summary
public static HTTP3Stream.CloseState[] values()

org.eclipse.jetty.http3 back to summary

protected final Enum HTTP3Stream.FrameState

Class Inheritance

extends Enum<HTTP3Stream.FrameState>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.http3.HTTP3Stream.FrameState

Defines the state of the stream for received frames,

allowing to verify that a frame sequence is valid for the HTTP protocol.

For example, for a stream in the INITIAL state, receiving a DataFrame would move the stream to the DATA state which would be invalid, since for the HTTP protocol a HeadersFrame is expected before any DataFrame.

Field Summary

Modifier and Type	Field and Description
public static final HTTP3Stream.FrameState	DATA The stream has received HTTP content.
public static final HTTP3Stream.FrameState	FAILED The stream has encountered a failure.
public static final HTTP3Stream.FrameState	HEADER The stream has received an HTTP final response.
public static final HTTP3Stream.FrameState	INFORMATIONAL The stream has received an HTTP informational response.
public static final HTTP3Stream.FrameState	INITIAL The initial state of the stream, before it receives any frame.
public static final HTTP3Stream.FrameState	TRAILER The stream has received an HTTP trailer.

Constructor Summary

Access	Constructor and Description
private	FrameState()

Method Summary

Modifier and Type	Method and Description
public static HTTP3Stream.FrameState	valueOf(String name)
public static HTTP3Stream.FrameState[]	values()

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

Field Detail

DATA	back to summary
public static final HTTP3Stream.FrameState DATA The stream has received HTTP content.

FAILED	back to summary
public static final HTTP3Stream.FrameState FAILED The stream has encountered a failure.

INFORMATIONAL	back to summary
public static final HTTP3Stream.FrameState INFORMATIONAL The stream has received an HTTP informational response.

INITIAL	back to summary
public static final HTTP3Stream.FrameState INITIAL The initial state of the stream, before it receives any frame.

TRAILER	back to summary
public static final HTTP3Stream.FrameState TRAILER The stream has received an HTTP trailer.

Constructor Detail

FrameState	back to summary
private FrameState()

Method Detail

valueOf	back to summary
public static HTTP3Stream.FrameState valueOf(String name)

values	back to summary
public static HTTP3Stream.FrameState[] values()

public abstract Class HTTP3Stream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum HTTP3Stream.CloseState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Enum HTTP3Stream.FrameState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail