Class StreamFrame

java.lang.Object

org.eclipse.jetty.quic.api.frames.Frame

org.eclipse.jetty.quic.api.frames.Frame.WithStreamId

org.eclipse.jetty.quic.api.frames.StreamFrame

public class StreamFrame
extends Frame.WithStreamId

A QUIC frame carrying stream data bytes.

Nested Class Summary

Nested classes/interfaces inherited from class Frame

Frame.WithStreamId

Field Summary

Fields

Modifier and Type	Field	Description
static final long	END_STREAM_MASK
static final long	LENGTH_MASK
static final long	OFFSET_MASK

Fields inherited from class Frame

DEFAULT_MAX_SIZE

Constructor Summary

Constructors

Constructor	Description
StreamFrame(long frameType, long streamId, ByteBuffer data, long offset, boolean endData)	Creates a stream frame for a Stream.
StreamFrame(long streamId, ByteBuffer data, boolean endStream)	Creates the first stream frame with offset=0 for a new Stream.
StreamFrame(long streamId, ByteBuffer data, long offset, boolean endStream)	Creates a stream frame with the given offset for a Stream.
StreamFrame(long streamId, ByteBuffer data, long offset, boolean hasLength, boolean endStream)	Creates a stream frame for a Stream.

Method Summary

Modifier and Type	Method	Description
ByteBuffer	getData()
int	getLength()
long	getOffset()
boolean	isEndData()
boolean	isEndStream()
String	toString()

Methods inherited from class Frame.WithStreamId

getStreamId

Methods inherited from class Frame

getFrameType

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

END_STREAM_MASK

public static final long END_STREAM_MASK

See Also:

• Constant Field Values

LENGTH_MASK

public static final long LENGTH_MASK

See Also:

• Constant Field Values

OFFSET_MASK

public static final long OFFSET_MASK

See Also:

• Constant Field Values

Constructor Details

StreamFrame

public StreamFrame(long streamId,
 ByteBuffer data,
 boolean endStream)

Creates the first stream frame with offset=0 for a new Stream.

Applications should use this constructor in conjunction with Session.newStream(long, Stream.Listener). For subsequent data to be sent on the same stream, applications should use Stream.data(boolean, java.util.List, org.eclipse.jetty.util.Promise.Invocable), so that the implementation can compute the offset on behalf of the application.

Parameters:

streamId - the stream id generated using Session.newStreamId(boolean)

data - the data bytes to send

endStream - whether the data is the last to be sent

StreamFrame

public StreamFrame(long streamId,
 ByteBuffer data,
 long offset,
 boolean endStream)

Creates a stream frame with the given offset for a Stream.

Applications should not use this constructor, but instead use Stream.data(boolean, List, Promise.Invocable).

Parameters:

streamId - the stream id generated using Session.newStreamId(boolean)

data - the data bytes to send

offset - the data offset

endStream - whether the data is the last to be sent

StreamFrame

public StreamFrame(long streamId,
 ByteBuffer data,
 long offset,
 boolean hasLength,
 boolean endStream)

Creates a stream frame for a Stream.

Applications should not use this constructor, but instead use Stream.data(boolean, List, Promise.Invocable).

Parameters:

streamId - the stream id generated using Session.newStreamId(boolean)

data - the data bytes to send

offset - the data offset

hasLength - whether the frame explicitly specifies the data length

endStream - whether the data is the last to be sent

StreamFrame

public StreamFrame(long frameType,
 long streamId,
 ByteBuffer data,
 long offset,
 boolean endData)

Creates a stream frame for a Stream.

Applications should not use this constructor, but instead use Stream.data(boolean, List, Promise.Invocable).

Parameters:

frameType - the frame type

streamId - the stream id generated using Session.newStreamId(boolean)

data - the data bytes to send

offset - the data offset

Method Details

getOffset

public long getOffset()

Returns:

the stream offset of the data bytes carried by this frame

getData

public ByteBuffer getData()

Returns:

the data bytes

getLength

public int getLength()

Returns:

the number of data bytes

isEndStream

public boolean isEndStream()

Returns:

whether this frame is the last in the stream

isEndData

public boolean isEndData()

Returns:

whether this frame is the last carrying data for the stream

toString

public String toString()

Overrides:

toString in class Frame.WithStreamId