Modifier and Type	Class and Description
public static interface	QpackDecoder.Handler
pack-priv class	QpackDecoder.InstructionHandler This delivers notifications from the DecoderInstruction parser directly into the Decoder.
private static class	QpackDecoder.MetaDataNotification

Modifier and Type	Field and Description
private LongSupplier	_beginNanoTimeSupplier
private final Map<Long, AtomicInteger>	_blockedStreams
private final QpackContext	_context
private final List<EncodedFieldSection>	_encodedFieldSections
private final Instruction.Handler	_handler
private final QpackDecoder.InstructionHandler	_instructionHandler
private final List<Instruction>	_instructions
private final NBitIntegerDecoder	_integerDecoder
private int	_maxBlockedStreams
private int	_maxHeadersSize
private int	_maxTableCapacity
private final List<QpackDecoder.MetaDataNotification>	_metaDataNotifications
private final DecoderInstructionParser	_parser
private static final Logger	LOG

Access	Constructor and Description
public	QpackDecoder(Instruction.Handler handler)

Method Summary

Modifier and Type	Method and Description
private void	checkEncodedFieldSections()
public boolean	Returns: true if the MetaData could be decoded immediately without requiring addition state in the DynamicTable. decode(long the stream ID corresponding to this headers frame. streamId, ByteBuffer the content of the headers frame. buffer, QpackDecoder.Handler a handler that is invoked when the MetaData is able to be decoded. handler) Decode a buffer into a `MetaData` object given a HTTP/3 stream ID. The buffer must be the complete content of a headers frame and will be fully consumed.
private static int	decodeInsertCount(int encInsertCount, int totalNumInserts, int maxTableCapacity)
public void	dump(Appendable out, String indent) Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
pack-priv QpackDecoder.InstructionHandler	getInstructionHandler()
public int	getMaxBlockedStreams()
public int	getMaxHeadersSize()
public int	getMaxTableCapacity()
pack-priv QpackContext	getQpackContext()
private void	notifyInstructionHandler()
private void	notifyMetaDataHandler(boolean wasBlocked)
public void	parseInstructions(ByteBuffer a buffer containing bytes from the Encoder stream. buffer) Parse instructions from the Encoder stream.
public void	setBeginNanoTimeSupplier(LongSupplier beginNanoTimeSupplier)
public void	setMaxBlockedStreams(int maxBlockedStreams)
public void	setMaxHeadersSize(int The maximum allowed size of a headers block, expressed as total of all name and value characters, plus 32 per field maxHeadersSize)
public void	setMaxTableCapacity(int maxTableCapacity)
public void	streamCancellation(long the streamId of the stream that was cancelled. streamId) Tells the `QpackDecoder` that a particular stream has been cancelled.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

_beginNanoTimeSupplier	back to summary
private LongSupplier _beginNanoTimeSupplier

_blockedStreams	back to summary
private final Map<Long, AtomicInteger> _blockedStreams

_context	back to summary
private final QpackContext _context

_encodedFieldSections	back to summary
private final List<EncodedFieldSection> _encodedFieldSections

_handler	back to summary
private final Instruction.Handler _handler

_instructionHandler	back to summary
private final QpackDecoder.InstructionHandler _instructionHandler

_instructions	back to summary
private final List<Instruction> _instructions

_integerDecoder	back to summary
private final NBitIntegerDecoder _integerDecoder

_maxBlockedStreams	back to summary
private int _maxBlockedStreams

_maxHeadersSize	back to summary
private int _maxHeadersSize

_maxTableCapacity	back to summary
private int _maxTableCapacity

_metaDataNotifications	back to summary
private final List<QpackDecoder.MetaDataNotification> _metaDataNotifications

_parser	back to summary
private final DecoderInstructionParser _parser

LOG	back to summary
private static final Logger LOG

Constructor Detail

QpackDecoder	back to summary
public QpackDecoder(Instruction.Handler handler)

Method Detail

checkEncodedFieldSections	back to summary
private void checkEncodedFieldSections() throws QpackException

decode back to summary

decode	back to summary
public boolean decode(long streamId, ByteBuffer buffer, QpackDecoder.Handler handler) throws QpackException Decode a buffer into a `MetaData` object given a HTTP/3 stream ID. The buffer must be the complete content of a headers frame and will be fully consumed. It may be that the Dynamic Table does not yet contain the state required to decode this headers frame, in this case the encoded headers will be saved until the required state arrives on the instruction stream to update the dynamic table. This method may generate instructions to be sent back over the Decoder stream to the remote Encoder. Parameters streamId:long the stream ID corresponding to this headers frame. buffer:ByteBuffer the content of the headers frame. handler:QpackDecoder.Handler a handler that is invoked when the MetaData is able to be decoded. Returns:boolean true if the MetaData could be decoded immediately without requiring addition state in the DynamicTable. Exceptions QpackException: if there was an error with the QPACK decompression.

public boolean decode(long streamId, ByteBuffer buffer, QpackDecoder.Handler handler) throws QpackException

Decode a buffer into a MetaData object given a HTTP/3 stream ID. The buffer must be the complete content of a headers frame and will be fully consumed. It may be that the Dynamic Table does not yet contain the state required to decode this headers frame, in this case the encoded headers will be saved until the required state arrives on the instruction stream to update the dynamic table.

This method may generate instructions to be sent back over the Decoder stream to the remote Encoder.

Parameters

streamId:long: the stream ID corresponding to this headers frame.
buffer:ByteBuffer: the content of the headers frame.
handler:QpackDecoder.Handler: a handler that is invoked when the MetaData is able to be decoded.

Returns:boolean

true if the MetaData could be decoded immediately without requiring addition state in the DynamicTable.

Exceptions

QpackException:: if there was an error with the QPACK decompression.

decodeInsertCount	back to summary
private static int decodeInsertCount(int encInsertCount, int totalNumInserts, int maxTableCapacity) throws QpackException

dump	back to summary
public void dump(Appendable out, String indent) throws IOException Implements org.eclipse.jetty.util.component.Dumpable.dump. Doc from org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped. Annotations @Override Exceptions IOException: if unable to write to Appendable

dump

back to summary

public void dump(Appendable out, String indent) throws IOException

Implements org.eclipse.jetty.util.component.Dumpable.dump.

Doc from org.eclipse.jetty.util.component.Dumpable.dump.

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Annotations

@Override

Exceptions

IOException:: if unable to write to Appendable

getInstructionHandler	back to summary
pack-priv QpackDecoder.InstructionHandler getInstructionHandler()

getMaxBlockedStreams	back to summary
public int getMaxBlockedStreams()

getMaxHeadersSize	back to summary
public int getMaxHeadersSize()

getMaxTableCapacity	back to summary
public int getMaxTableCapacity()

getQpackContext	back to summary
pack-priv QpackContext getQpackContext()

notifyInstructionHandler	back to summary
private void notifyInstructionHandler()

notifyMetaDataHandler	back to summary
private void notifyMetaDataHandler(boolean wasBlocked)

parseInstructions back to summary

parseInstructions	back to summary
public void parseInstructions(ByteBuffer buffer) throws SessionException Parse instructions from the Encoder stream. The Encoder stream carries an unframed sequence of instructions from the Encoder to the Decoder. This method will fully consume the supplied `ByteBuffer` and produce instructions to update the state of the Decoder and its Dynamic Table. Parameters buffer:ByteBuffer a buffer containing bytes from the Encoder stream. Exceptions SessionException: if there was an error parsing or handling the instructions.

public void parseInstructions(ByteBuffer buffer) throws SessionException

Parse instructions from the Encoder stream. The Encoder stream carries an unframed sequence of instructions from the Encoder to the Decoder. This method will fully consume the supplied ByteBuffer and produce instructions to update the state of the Decoder and its Dynamic Table.

Parameters

buffer:ByteBuffer: a buffer containing bytes from the Encoder stream.

Exceptions

SessionException:: if there was an error parsing or handling the instructions.

setBeginNanoTimeSupplier	back to summary
public void setBeginNanoTimeSupplier(LongSupplier beginNanoTimeSupplier)

setMaxBlockedStreams	back to summary
public void setMaxBlockedStreams(int maxBlockedStreams)

setMaxHeadersSize	back to summary
public void setMaxHeadersSize(int maxHeadersSize) Parameters maxHeadersSize:int The maximum allowed size of a headers block, expressed as total of all name and value characters, plus 32 per field

setMaxTableCapacity	back to summary
public void setMaxTableCapacity(int maxTableCapacity)

streamCancellation back to summary

streamCancellation	back to summary
public void streamCancellation(long streamId) Tells the `QpackDecoder` that a particular stream has been cancelled. Any encoded field sections for this stream will be discarded and a stream cancellation instruction will be sent to the remote Encoder. Parameters streamId:long the streamId of the stream that was cancelled.

public void streamCancellation(long streamId)

Tells the QpackDecoder that a particular stream has been cancelled. Any encoded field sections for this stream will be discarded and a stream cancellation instruction will be sent to the remote Encoder.

Parameters

streamId:long: the streamId of the stream that was cancelled.

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

org.eclipse.jetty.http3.qpack back to summary

public Interface QpackDecoder.Handler

Method Summary

Modifier and Type	Method and Description
public void	onMetaData(long streamId, MetaData metadata, boolean wasBlocked)

Method Detail

onMetaData	back to summary
public void onMetaData(long streamId, MetaData metadata, boolean wasBlocked)

org.eclipse.jetty.http3.qpack back to summary

pack-priv Class QpackDecoder.InstructionHandler

Class Inheritance

extends Object
implements Handler

java.lang.Object
org.eclipse.jetty.http3.qpack.QpackDecoder.InstructionHandler

All Implemented Interfaces

org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler

This delivers notifications from the DecoderInstruction parser directly into the Decoder.

Constructor Summary

Access	Constructor and Description
pack-priv	InstructionHandler()

Method Summary

Modifier and Type	Method and Description
public void	onDuplicate(int index) Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onDuplicate.
public void	onInsertNameWithReference(int nameIndex, boolean isDynamicTableIndex, String value) Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onInsertNameWithReference.
public void	onInsertWithLiteralName(String name, String value) Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onInsertWithLiteralName.
public void	onSetDynamicTableCapacity(int capacity) Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onSetDynamicTableCapacity.

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

Constructor Detail

InstructionHandler	back to summary
pack-priv InstructionHandler()

Method Detail

onDuplicate	back to summary
public void onDuplicate(int index) throws QpackException Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onDuplicate. Annotations @Override

onDuplicate

back to summary

public void onDuplicate(int index) throws QpackException

Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onDuplicate.

Annotations

@Override

onInsertNameWithReference	back to summary
public void onInsertNameWithReference(int nameIndex, boolean isDynamicTableIndex, String value) throws QpackException Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onInsertNameWithReference. Annotations @Override

onInsertNameWithReference

back to summary

public void onInsertNameWithReference(int nameIndex, boolean isDynamicTableIndex, String value) throws QpackException

Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onInsertNameWithReference.

Annotations

@Override

onInsertWithLiteralName	back to summary
public void onInsertWithLiteralName(String name, String value) throws QpackException Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onInsertWithLiteralName. Annotations @Override

onInsertWithLiteralName

back to summary

public void onInsertWithLiteralName(String name, String value) throws QpackException

Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onInsertWithLiteralName.

Annotations

@Override

onSetDynamicTableCapacity	back to summary
public void onSetDynamicTableCapacity(int capacity) throws QpackException Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onSetDynamicTableCapacity. Annotations @Override

onSetDynamicTableCapacity

back to summary

public void onSetDynamicTableCapacity(int capacity) throws QpackException

Implements org.eclipse.jetty.http3.qpack.internal.parser.DecoderInstructionParser.Handler.onSetDynamicTableCapacity.

Annotations

@Override

org.eclipse.jetty.http3.qpack back to summary

private Class QpackDecoder.MetaDataNotification

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.http3.qpack.QpackDecoder.MetaDataNotification

Field Summary

Modifier and Type	Field and Description
private final QpackDecoder.Handler	_handler
private final MetaData	_metaData
private final long	_streamId

Constructor Summary

Access	Constructor and Description
public	MetaDataNotification(long streamId, MetaData metaData, QpackDecoder.Handler handler)

Method Summary

Modifier and Type	Method and Description
public void	notifyHandler(boolean wasBlocked)

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

Field Detail

_handler	back to summary
private final QpackDecoder.Handler _handler

_metaData	back to summary
private final MetaData _metaData

_streamId	back to summary
private final long _streamId

Constructor Detail

MetaDataNotification	back to summary
public MetaDataNotification(long streamId, MetaData metaData, QpackDecoder.Handler handler)

Method Detail

notifyHandler	back to summary
public void notifyHandler(boolean wasBlocked)

public Class QpackDecoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface QpackDecoder.Handler

Method Summary

Method Detail

pack-priv Class QpackDecoder.InstructionHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class QpackDecoder.MetaDataNotification

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail