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

Field Summary

Modifier and Type	Field and Description
public static final ConnectionCloseFrame	APPLICATION_ERROR An immutable ConnectionCloseFrame of type 0x1c with no reason phrase and an error of type APPLICATION_ERROR.
private String	cachedReason
private String	cachedToString
public static final int	CONNECTION_CLOSE_VARIANT This variant indicates an error originating from the higher level protocol, for instance, HTTP/3.
private final long	errorCode
private final long	errorFrameType
private final byte[]	reason
private final boolean	variant

Constructor Summary

Access	Constructor and Description
pack-priv	ConnectionCloseFrame(ByteBuffer buffer, int type) Incoming CONNECTION_CLOSE frame returned by QuicFrame.decode()
public	ConnectionCloseFrame(long errorCode, long errorFrameType, String reason) Outgoing CONNECTION_CLOSE frame (variant with errorFrameType - 0x1c).
public	ConnectionCloseFrame(long errorCode, String reason) Outgoing CONNECTION_CLOSE frame (variant without errorFrameType).

Method Summary

Modifier and Type	Method and Description
public ConnectionCloseFrame	Returns: a ConnectionCloseFrame suitable for inclusion in an Initial or Handshake packet clearApplicationState() Returns a ConnectionCloseFrame suitable for inclusion in an Initial or Handshake packet.
public void	encode(ByteBuffer buffer) Implements abstract jdk.internal.net.http.quic.frames.QuicFrame.encode. Encode this QUIC Frame into given ByteBuffer
public long	errorCode()
public long	errorFrameType()
private static byte[]	getReasonBytes(String reason)
public long	getTypeField() Overrides jdk.internal.net.http.quic.frames.QuicFrame.getTypeField. Returns the type field that was / should be encoded.
public boolean	isAckEliciting() Overrides jdk.internal.net.http.quic.frames.QuicFrame.isAckEliciting. Returns true if this frame is ACK-eliciting.
public boolean	isApplicationCode()
public boolean	isQuicTransportCode()
public byte[]	reason()
public String	reasonString()
public int	size() Implements abstract jdk.internal.net.http.quic.frames.QuicFrame.size. Returns the minimum number of bytes needed to encode this frame.
public String	toString() Overrides jdk.internal.net.http.quic.frames.QuicFrame.toString. Returns a string representation of the object.
public boolean	variant()

Inherited from jdk.internal.net.http.quic.frames.QuicFrame:: decode decodeVLField decodeVLFieldAsInt encodeVLField frameClassOf frameType frameTypeOf getVLFieldLengthFor isValidIn putByteBuffer requireVLRange requireVLRange validateRemainingLength

Field Detail

APPLICATION_ERROR	back to summary
public static final ConnectionCloseFrame APPLICATION_ERROR An immutable ConnectionCloseFrame of type 0x1c with no reason phrase and an error of type APPLICATION_ERROR. API Note From RFC 9000 - section 10.2.3: A CONNECTION_CLOSE of type 0x1d MUST be replaced by a CONNECTION_CLOSE of type 0x1c when sending the frame in Initial or Handshake packets. Otherwise, information about the application state might be revealed. Endpoints MUST clear the value of the Reason Phrase field and SHOULD use the APPLICATION_ERROR code when converting to a CONNECTION_CLOSE of type 0x1c.

APPLICATION_ERROR

back to summary

public static final ConnectionCloseFrame APPLICATION_ERROR

An immutable ConnectionCloseFrame of type 0x1c with no reason phrase and an error of type APPLICATION_ERROR.

API Note

From RFC 9000 - section 10.2.3:

A CONNECTION_CLOSE of type 0x1d MUST be replaced by a CONNECTION_CLOSE of type 0x1c when sending the frame in Initial or Handshake packets. Otherwise, information about the application state might be revealed. Endpoints MUST clear the value of the Reason Phrase field and SHOULD use the APPLICATION_ERROR code when converting to a CONNECTION_CLOSE of type 0x1c.

cachedReason	back to summary
private String cachedReason

cachedToString	back to summary
private String cachedToString

CONNECTION_CLOSE_VARIANT	back to summary
public static final int CONNECTION_CLOSE_VARIANT This variant indicates an error originating from the higher level protocol, for instance, HTTP/3.

errorCode	back to summary
private final long errorCode

errorFrameType	back to summary
private final long errorFrameType

reason	back to summary
private final byte[] reason

variant	back to summary
private final boolean variant

Constructor Detail

ConnectionCloseFrame	back to summary
pack-priv ConnectionCloseFrame(ByteBuffer buffer, int type) throws QuicTransportException Incoming CONNECTION_CLOSE frame returned by QuicFrame.decode() Exceptions QuicTransportException: if the frame was malformed

ConnectionCloseFrame

back to summary

pack-priv ConnectionCloseFrame(ByteBuffer buffer, int type) throws QuicTransportException

Incoming CONNECTION_CLOSE frame returned by QuicFrame.decode()

Exceptions

QuicTransportException:: if the frame was malformed

ConnectionCloseFrame	back to summary
public ConnectionCloseFrame(long errorCode, long errorFrameType, String reason) Outgoing CONNECTION_CLOSE frame (variant with errorFrameType - 0x1c). This indicates a quic transport error.

ConnectionCloseFrame	back to summary
public ConnectionCloseFrame(long errorCode, String reason) Outgoing CONNECTION_CLOSE frame (variant without errorFrameType). This indicates an error originating from the higher level protocol, for instance HTTP/3.

Method Detail

clearApplicationState	back to summary
public ConnectionCloseFrame clearApplicationState() Returns a ConnectionCloseFrame suitable for inclusion in an Initial or Handshake packet. Returns:ConnectionCloseFrame a ConnectionCloseFrame suitable for inclusion in an Initial or Handshake packet

clearApplicationState

back to summary

public ConnectionCloseFrame clearApplicationState()

Returns a ConnectionCloseFrame suitable for inclusion in an Initial or Handshake packet.

Returns:ConnectionCloseFrame: a ConnectionCloseFrame suitable for inclusion in an Initial or Handshake packet

encode	back to summary
public void encode(ByteBuffer buffer) Implements abstract jdk.internal.net.http.quic.frames.QuicFrame.encode. Doc from jdk.internal.net.http.quic.frames.QuicFrame.encode. Encode this QUIC Frame into given ByteBuffer Annotations @Override

encode

back to summary

public void encode(ByteBuffer buffer)

Implements abstract jdk.internal.net.http.quic.frames.QuicFrame.encode.

Doc from jdk.internal.net.http.quic.frames.QuicFrame.encode.

Encode this QUIC Frame into given ByteBuffer

Annotations

@Override

errorCode	back to summary
public long errorCode()

errorFrameType	back to summary
public long errorFrameType()

getReasonBytes	back to summary
private static byte[] getReasonBytes(String reason)

getTypeField	back to summary
public long getTypeField() Overrides jdk.internal.net.http.quic.frames.QuicFrame.getTypeField. Doc from jdk.internal.net.http.quic.frames.QuicFrame.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. Annotations @Override

getTypeField

back to summary

public long getTypeField()

Overrides jdk.internal.net.http.quic.frames.QuicFrame.getTypeField.

Doc from jdk.internal.net.http.quic.frames.QuicFrame.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.

Annotations

@Override

isAckEliciting back to summary

isAckEliciting	back to summary
public boolean isAckEliciting() Overrides jdk.internal.net.http.quic.frames.QuicFrame.isAckEliciting. Doc from jdk.internal.net.http.quic.frames.QuicFrame.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). Annotations @Override

public boolean isAckEliciting()

Overrides jdk.internal.net.http.quic.frames.QuicFrame.isAckEliciting.

Doc from jdk.internal.net.http.quic.frames.QuicFrame.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).

Annotations

@Override

isApplicationCode	back to summary
public boolean isApplicationCode()

isQuicTransportCode	back to summary
public boolean isQuicTransportCode()

reason	back to summary
public byte[] reason()

reasonString	back to summary
public String reasonString()

size	back to summary
public int size() Implements abstract jdk.internal.net.http.quic.frames.QuicFrame.size. Doc from jdk.internal.net.http.quic.frames.QuicFrame.size. Returns the minimum number of bytes needed to encode this frame. Annotations @Override

size

back to summary

public int size()

Implements abstract jdk.internal.net.http.quic.frames.QuicFrame.size.

Doc from jdk.internal.net.http.quic.frames.QuicFrame.size.

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

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides jdk.internal.net.http.quic.frames.QuicFrame.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 jdk.internal.net.http.quic.frames.QuicFrame.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

variant	back to summary
public boolean variant()

public final Class ConnectionCloseFrame

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail