OpenJDK 27 · jdk.internal.net.http.quic.frames.QuicFrame

Field Summary

Modifier and Type	Field and Description
public static final int	ACK
public static final int	CONNECTION_CLOSE
public static final int	CRYPTO
public static final int	DATA_BLOCKED
private final int	frameType
public static final int	HANDSHAKE_DONE
public static final int	MAX_DATA
private static final int	MAX_KNOWN_FRAME_TYPE
public static final int	MAX_STREAM_DATA
public static final int	MAX_STREAMS
public static final long	MAX_VL_INTEGER
public static final int	NEW_CONNECTION_ID
public static final int	NEW_TOKEN
public static final int	PADDING Frame types
public static final int	PATH_CHALLENGE
public static final int	PATH_RESPONSE
public static final int	PING
public static final int	RESET_STREAM
public static final int	RETIRE_CONNECTION_ID
public static final int	STOP_SENDING
public static final int	STREAM
public static final int	STREAM_DATA_BLOCKED
public static final int	STREAMS_BLOCKED

Access	Constructor and Description
pack-priv	QuicFrame(int the first byte of the frame, which encodes the frame type. type) Concrete Frame types normally have two constructors which call this XXXFrame(ByteBuffer, int firstByte) which is called for incoming frames after reading the first byte to determine the type.

Method Summary

Modifier and Type	Method and Description
public static QuicFrame	decode(ByteBuffer buffer) decode given ByteBuffer and return a QUICFrame
protected final long	decodeVLField(ByteBuffer buffer, String name)
protected final int	decodeVLFieldAsInt(ByteBuffer buffer, String name)
public abstract void	encode(ByteBuffer buffer) Encode this QUIC Frame into given ByteBuffer
protected static void	encodeVLField(ByteBuffer buffer, long val, String name)
public static Class<? extends QuicFrame>	frameClassOf(int frameType)
public int	frameType() The type of this frame, ie.
public static int	frameTypeOf(Class<? extends QuicFrame> frameClass)
public long	Returns: the type field that was / should be encoded getTypeField() Returns the type field that was / should be encoded.
protected static int	getVLFieldLengthFor(long val)
public boolean	Returns: true if this frame is ACK-eliciting isAckEliciting() Returns true if this frame is ACK-eliciting.
public boolean	Returns: true if the frame can be embedded in a packet of that type isValidIn(QuicPacket.PacketType the packet type packetType) Tells whether this particular frame is valid in the given packet type.
private static int	maskType(int type) depending on the frame type, additional bits can be encoded in frameType().
protected static void	putByteBuffer(ByteBuffer dest, ByteBuffer src) Writes src to dest, preserving position in src
protected static int	requireVLRange(int val, String message)
protected static long	requireVLRange(long val, String fieldName)
public abstract int	Returns: the minimum number of bytes needed to encode this frame size() Returns the minimum number of bytes needed to encode this frame.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected static void	validateRemainingLength(ByteBuffer source buffer buffer, int minimum number of bytes required expected, long frame type to include in exception type) Throws a QuicTransportException if the given buffer does not have enough bytes to finish decoding the frame

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

Field Detail

ACK	back to summary
public static final int ACK

CONNECTION_CLOSE	back to summary
public static final int CONNECTION_CLOSE

CRYPTO	back to summary
public static final int CRYPTO

DATA_BLOCKED	back to summary
public static final int DATA_BLOCKED

frameType	back to summary
private final int frameType

HANDSHAKE_DONE	back to summary
public static final int HANDSHAKE_DONE

MAX_DATA	back to summary
public static final int MAX_DATA

MAX_KNOWN_FRAME_TYPE	back to summary
private static final int MAX_KNOWN_FRAME_TYPE

MAX_STREAM_DATA	back to summary
public static final int MAX_STREAM_DATA

MAX_STREAMS	back to summary
public static final int MAX_STREAMS

MAX_VL_INTEGER	back to summary
public static final long MAX_VL_INTEGER

NEW_CONNECTION_ID	back to summary
public static final int NEW_CONNECTION_ID

NEW_TOKEN	back to summary
public static final int NEW_TOKEN

PADDING	back to summary
public static final int PADDING Frame types

PATH_CHALLENGE	back to summary
public static final int PATH_CHALLENGE

PATH_RESPONSE	back to summary
public static final int PATH_RESPONSE

PING	back to summary
public static final int PING

RESET_STREAM	back to summary
public static final int RESET_STREAM

RETIRE_CONNECTION_ID	back to summary
public static final int RETIRE_CONNECTION_ID

STOP_SENDING	back to summary
public static final int STOP_SENDING

STREAM	back to summary
public static final int STREAM

STREAM_DATA_BLOCKED	back to summary
public static final int STREAM_DATA_BLOCKED

STREAMS_BLOCKED	back to summary
public static final int STREAMS_BLOCKED

Constructor Detail

QuicFrame	back to summary
pack-priv QuicFrame(int type) Concrete Frame types normally have two constructors which call this XXXFrame(ByteBuffer, int firstByte) which is called for incoming frames after reading the first byte to determine the type. The firstByte is also supplied to the constructor because it can contain additional state information XXXFrame(...) which is called to instantiate outgoing frames Parameters type:int the first byte of the frame, which encodes the frame type.

QuicFrame

back to summary

pack-priv QuicFrame(int type)

Concrete Frame types normally have two constructors which call this XXXFrame(ByteBuffer, int firstByte) which is called for incoming frames after reading the first byte to determine the type. The firstByte is also supplied to the constructor because it can contain additional state information XXXFrame(...) which is called to instantiate outgoing frames

Parameters

type:int: the first byte of the frame, which encodes the frame type.

Method Detail

decode	back to summary
public static QuicFrame decode(ByteBuffer buffer) throws QuicTransportException decode given ByteBuffer and return a QUICFrame

decodeVLField	back to summary
protected final long decodeVLField(ByteBuffer buffer, String name) throws QuicTransportException

decodeVLFieldAsInt	back to summary
protected final int decodeVLFieldAsInt(ByteBuffer buffer, String name) throws QuicTransportException

encode	back to summary
public abstract void encode(ByteBuffer buffer) Encode this QUIC Frame into given ByteBuffer

encodeVLField	back to summary
protected static void encodeVLField(ByteBuffer buffer, long val, String name)

frameClassOf	back to summary
public static Class<? extends QuicFrame> frameClassOf(int frameType)

frameType	back to summary
public int frameType() The type of this frame, ie. one of values above, which means it excludes the additional information that is encoded into the first field of some QUIC frames. That additional info has to be maintained by the sub class and used by its encode() method to generate the first field for outgoing frames. see maskType() below

frameTypeOf	back to summary
public static int frameTypeOf(Class<? extends QuicFrame> frameClass)

getTypeField back to summary

getTypeField	back to summary
public long getTypeField() Returns the type field that was / should be encoded. This is the frame type with possibly some additional bits set, depending on the frame. Implementation Specification The default implementation of this method is to return `frameType()`. Returns:long the type field that was / should be encoded

public long getTypeField()

Returns the type field that was / should be encoded. This is the frame type with possibly some additional bits set, depending on the frame.

Implementation Specification

The default implementation of this method is to return frameType().

Returns:long: the type field that was / should be encoded

getVLFieldLengthFor	back to summary
protected static int getVLFieldLengthFor(long val)

isAckEliciting back to summary

isAckEliciting	back to summary
public boolean isAckEliciting() Returns true if this frame is ACK-eliciting. A frame is ACK-eliciting if it is anything other than `QuicFrame#ACK`, `QuicFrame#PADDING` or `QuicFrame#CONNECTION_CLOSE` (or its variant). Returns:boolean true if this frame is ACK-eliciting

public boolean isAckEliciting()

Returns true if this frame is ACK-eliciting. A frame is ACK-eliciting if it is anything other than QuicFrame#ACK, QuicFrame#PADDING or QuicFrame#CONNECTION_CLOSE (or its variant).

Returns:boolean: true if this frame is ACK-eliciting

isValidIn	back to summary
public boolean isValidIn(QuicPacket.PacketType packetType) Tells whether this particular frame is valid in the given packet type. From RFC 9000, section 12.5. Frames and Number Spaces: Some frames are prohibited in different packet number space The rules here generalize those of TLS, in that frames associated with establishing the connection can usually appear in packets in any packet number space, whereas those associated with transferring data can only appear in the application data packet number space: PADDING, PING, and CRYPTO frames MAY appear in any packet number space. CONNECTION_CLOSE frames signaling errors at the QUIC layer (type 0x1c) MAY appear in any packet number space. CONNECTION_CLOSE frames signaling application errors (type 0x1d) MUST only appear in the application data packet number space. ACK frames MAY appear in any packet number space but can only acknowledge packets that appeared in that packet number space. However, as noted below, 0-RTT packets cannot contain ACK frames. All other frame types MUST only be sent in the application data packet number space. Note that it is not possible to send the following frames in 0-RTT packets for various reasons: ACK, CRYPTO, HANDSHAKE_DONE, NEW_TOKEN, PATH_RESPONSE, and RETIRE_CONNECTION_ID. A server MAY treat receipt of these frames in 0-RTT packets as a connection error of type PROTOCOL_VIOLATION. Parameters packetType:QuicPacket.PacketType the packet type Returns:boolean true if the frame can be embedded in a packet of that type

isValidIn

back to summary

public boolean isValidIn(QuicPacket.PacketType packetType)

Tells whether this particular frame is valid in the given packet type.

From RFC 9000, section 12.5. Frames and Number Spaces:

Some frames are prohibited in different packet number space The rules here generalize those of TLS, in that frames associated with establishing the connection can usually appear in packets in any packet number space, whereas those associated with transferring data can only appear in the application data packet number space:

PADDING, PING, and CRYPTO frames MAY appear in any packet number space.

CONNECTION_CLOSE frames signaling errors at the QUIC layer (type 0x1c) MAY appear in any packet number space.

CONNECTION_CLOSE frames signaling application errors (type 0x1d) MUST only appear in the application data packet number space.
ACK frames MAY appear in any packet number space but can only acknowledge packets that appeared in that packet number space. However, as noted below, 0-RTT packets cannot contain ACK frames.

All other frame types MUST only be sent in the application data packet number space.

Note that it is not possible to send the following frames in 0-RTT packets for various reasons: ACK, CRYPTO, HANDSHAKE_DONE, NEW_TOKEN, PATH_RESPONSE, and RETIRE_CONNECTION_ID. A server MAY treat receipt of these frames in 0-RTT packets as a connection error of type PROTOCOL_VIOLATION.

Parameters

packetType:QuicPacket.PacketType: the packet type

Returns:boolean

true if the frame can be embedded in a packet of that type

maskType	back to summary
private static int maskType(int type) depending on the frame type, additional bits can be encoded in frameType(). This masks them out to return a unique value for each frame type.

putByteBuffer	back to summary
protected static void putByteBuffer(ByteBuffer dest, ByteBuffer src) Writes src to dest, preserving position in src

requireVLRange	back to summary
protected static int requireVLRange(int val, String message)

requireVLRange	back to summary
protected static long requireVLRange(long val, String fieldName)

size	back to summary
public abstract int size() Returns the minimum number of bytes needed to encode this frame. Returns:int the minimum number of bytes needed to encode this frame

size

back to summary

public abstract int size()

Returns the minimum number of bytes needed to encode this frame.

Returns:int: the minimum number of bytes needed to encode this frame

toString back to summary

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

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

validateRemainingLength back to summary

validateRemainingLength	back to summary
protected static void validateRemainingLength(ByteBuffer buffer, int expected, long type) throws QuicTransportException Throws a QuicTransportException if the given buffer does not have enough bytes to finish decoding the frame Parameters buffer:ByteBuffer source buffer expected:int minimum number of bytes required type:long frame type to include in exception Exceptions QuicTransportException: if the buffer is shorter than `expected`

protected static void validateRemainingLength(ByteBuffer buffer, int expected, long type) throws QuicTransportException

Throws a QuicTransportException if the given buffer does not have enough bytes to finish decoding the frame

Parameters

buffer:ByteBuffer: source buffer
expected:int: minimum number of bytes required
type:long: frame type to include in exception

Exceptions

QuicTransportException:: if the buffer is shorter than expected

public abstract sealed Class QuicFrame

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail