Modifier and Type	Class and Description
public class	Encoder.EncodingContext
public static record	Encoder.SectionReference Descriptor of entries range referenced from a field lines section.
private class	Encoder.TableUpdatesCallback

Modifier and Type	Field and Description
private final ReentrantLock	blockedStreamsCounterLock
private long	blockedStreamsInFlight
private final DecoderInstructionsReader	decoderInstructionsReader
private final DynamicTable	dynamicTable
private static final AtomicLong	ENCODERS_IDS
private final QueuingStreamPair	encoderStreams
private long	knownReceivedCount
private final ReentrantReadWriteLock	krcLock
private final ConcurrentMap<Long, ConcurrentSkipListSet<Long>>	liveContextReferences
private final QPACK.Logger	logger
private long	maxBlockedStreams
private final InsertionPolicy	policy
private final QPACK.QPACKErrorHandler	qpackErrorHandler
private static final Set<String>	SENSITIVE_HEADER_NAMES
private final TablesIndexer	tablesIndexer
private final ConcurrentMap<Long, Queue<Encoder.SectionReference>>	unacknowledgedSections

Access	Constructor and Description
public	Encoder(InsertionPolicy policy, QPACK.StreamPairSupplier supplier of the encoder unidirectional stream pair streamPairs, QPACK.QPACKErrorHandler codingError) Constructs an `Encoder` with zero initial capacity of the dynamic table.

Method Summary

Modifier and Type	Method and Description
pack-priv long	blockedStreamsCount()
private void	cleanupStreamData(long streamId)
public void	configure(ConnectionSettings the peer settings peerSettings) Configures encoder according to the settings received from the peer.
public List<ByteBuffer>	encodeHeaders(HeaderFrameWriter writer, long streamId, int bufferSize, HttpHeaders... headers)
public QueuingStreamPair	encoderStreams()
public void	generateFieldLineSectionPrefix(Encoder.EncodingContext encodingContext, List<ByteBuffer> buffers)
private ByteBuffer	getByteBuffer(int size)
public void	header(Encoder.EncodingContext context, CharSequence name, CharSequence value, boolean sensitive)
public void	header(Encoder.EncodingContext the encoding context context, CharSequence the name name, CharSequence the value value, boolean whether the value is sensitive sensitive, long the count of received entries known to a peer decoder or `-1` to skip the dynamic table entry index check during header encoding. knownReceivedCount) Sets up the given header `(name, value)` with possibly sensitive value.
public long	knownReceivedCount()
public Encoder.EncodingContext	newEncodingContext(long streamId, long base, HeaderFrameWriter writer)
public HeaderFrameWriter	newHeaderFrameWriter()
private void	processDecoderAcks(ByteBuffer data sent by the peer's decoder buffer) This method is called when the peer decoder sends data on the peer's decoder stream
public void	registerUnackedFieldLineSection(long streamId, Encoder.SectionReference sectionReference)
public void	setTableCapacity(long a non-negative long capacity) Sets the capacity of the encoder's dynamic table and notifies the decoder by issuing "Set Dynamic Table Capacity" instruction.
public Encoder.SectionReference	unackedFieldLineSectionsRange(Encoder.EncodingContext context)
private Encoder.SectionReference	unackedFieldLineSectionsRange(Encoder.SectionReference initial)
private void	updateKrcInsertCountIncrement(long increment)
private void	updateKrcSectionAck(long streamId)

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

blockedStreamsCounterLock	back to summary
private final ReentrantLock blockedStreamsCounterLock

blockedStreamsInFlight	back to summary
private long blockedStreamsInFlight

decoderInstructionsReader	back to summary
private final DecoderInstructionsReader decoderInstructionsReader

dynamicTable	back to summary
private final DynamicTable dynamicTable

ENCODERS_IDS	back to summary
private static final AtomicLong ENCODERS_IDS

encoderStreams	back to summary
private final QueuingStreamPair encoderStreams

knownReceivedCount	back to summary
private long knownReceivedCount

krcLock	back to summary
private final ReentrantReadWriteLock krcLock

liveContextReferences	back to summary
private final ConcurrentMap<Long, ConcurrentSkipListSet<Long>> liveContextReferences

logger	back to summary
private final QPACK.Logger logger

maxBlockedStreams	back to summary
private long maxBlockedStreams

policy	back to summary
private final InsertionPolicy policy

qpackErrorHandler	back to summary
private final QPACK.QPACKErrorHandler qpackErrorHandler

SENSITIVE_HEADER_NAMES	back to summary
private static final Set<String> SENSITIVE_HEADER_NAMES

tablesIndexer	back to summary
private final TablesIndexer tablesIndexer

unacknowledgedSections	back to summary
private final ConcurrentMap<Long, Queue<Encoder.SectionReference>> unacknowledgedSections

Constructor Detail

Encoder back to summary

Encoder	back to summary
public Encoder(InsertionPolicy policy, QPACK.StreamPairSupplier streamPairs, QPACK.QPACKErrorHandler codingError) Constructs an `Encoder` with zero initial capacity of the dynamic table. Maximum dynamic table capacity is not initialized until peer (decoder) HTTP/3 settings frame is received (see `Encoder#configure(ConnectionSettings)`). Dynamic table capacity values has to be agreed between decoder and encoder out-of-band, e.g. by a protocol that uses QPACK. Maximum dynamic table capacity is determined by the value of SETTINGS_QPACK_MAX_TABLE_CAPACITY HTTP/3 setting sent by the decoder side (see 3.2.3. Maximum Dynamic Table Capacity). An encoder informs the decoder of a change to the dynamic table capacity using the "Set Dynamic Table Capacity" instruction (see 4.3.1. Set Dynamic Table Capacity) Parameters streamPairs:QPACK.StreamPairSupplier supplier of the encoder unidirectional stream pair Exceptions IllegalArgumentException: if maxCapacity is negative See Also `Encoder#configure(ConnectionSettings)`

public Encoder(InsertionPolicy policy, QPACK.StreamPairSupplier streamPairs, QPACK.QPACKErrorHandler codingError)

Constructs an Encoder with zero initial capacity of the dynamic table. Maximum dynamic table capacity is not initialized until peer (decoder) HTTP/3 settings frame is received (see Encoder#configure(ConnectionSettings)).

Dynamic table capacity values has to be agreed between decoder and encoder out-of-band, e.g. by a protocol that uses QPACK.

Maximum dynamic table capacity is determined by the value of SETTINGS_QPACK_MAX_TABLE_CAPACITY HTTP/3 setting sent by the decoder side (see 3.2.3. Maximum Dynamic Table Capacity).

An encoder informs the decoder of a change to the dynamic table capacity using the "Set Dynamic Table Capacity" instruction (see 4.3.1. Set Dynamic Table Capacity)

Parameters

streamPairs:QPACK.StreamPairSupplier: supplier of the encoder unidirectional stream pair

Exceptions

IllegalArgumentException:: if maxCapacity is negative

See Also

Encoder#configure(ConnectionSettings)

Method Detail

blockedStreamsCount	back to summary
pack-priv long blockedStreamsCount()

cleanupStreamData	back to summary
private void cleanupStreamData(long streamId)

configure	back to summary
public void configure(ConnectionSettings peerSettings) Configures encoder according to the settings received from the peer. Parameters peerSettings:ConnectionSettings the peer settings

configure

back to summary

public void configure(ConnectionSettings peerSettings)

Configures encoder according to the settings received from the peer.

Parameters

peerSettings:ConnectionSettings: the peer settings

encodeHeaders	back to summary
public List<ByteBuffer> encodeHeaders(HeaderFrameWriter writer, long streamId, int bufferSize, HttpHeaders... headers)

encoderStreams	back to summary
public QueuingStreamPair encoderStreams()

generateFieldLineSectionPrefix	back to summary
public void generateFieldLineSectionPrefix(Encoder.EncodingContext encodingContext, List<ByteBuffer> buffers)

getByteBuffer	back to summary
private ByteBuffer getByteBuffer(int size)

header	back to summary
public void header(Encoder.EncodingContext context, CharSequence name, CharSequence value, boolean sensitive) throws IllegalStateException

header

back to summary

public void header(Encoder.EncodingContext context, CharSequence name, CharSequence value, boolean sensitive) throws IllegalStateException

header back to summary

header	back to summary
public void header(Encoder.EncodingContext context, CharSequence name, CharSequence value, boolean sensitive, long knownReceivedCount) throws IllegalStateException Sets up the given header `(name, value)` with possibly sensitive value. If the `value` is sensitive (think security, secrecy, etc.) this encoder will compress it using a special representation (see 7.1.3. Never-Indexed Literals). Fixates `name` and `value` for the duration of encoding. Parameters context:Encoder.EncodingContext the encoding context name:CharSequence the name value:CharSequence the value sensitive:boolean whether the value is sensitive knownReceivedCount:long the count of received entries known to a peer decoder or `-1` to skip the dynamic table entry index check during header encoding. Exceptions IllegalStateException: if the encoder hasn't fully encoded the previous header, or hasn't yet started to encode it NullPointerException: if any of the arguments are `null` See Also `DecodingCallback#onDecoded(CharSequence, CharSequence, boolean)`

public void header(Encoder.EncodingContext context, CharSequence name, CharSequence value, boolean sensitive, long knownReceivedCount) throws IllegalStateException

Sets up the given header (name, value) with possibly sensitive value.

If the value is sensitive (think security, secrecy, etc.) this encoder will compress it using a special representation (see 7.1.3. Never-Indexed Literals).

Fixates name and value for the duration of encoding.

Parameters

context:Encoder.EncodingContext: the encoding context
name:CharSequence: the name
value:CharSequence: the value
sensitive:boolean: whether the value is sensitive
knownReceivedCount:long: the count of received entries known to a peer decoder or -1 to skip the dynamic table entry index check during header encoding.

Exceptions

IllegalStateException:: if the encoder hasn't fully encoded the previous header, or hasn't yet started to encode it
NullPointerException:: if any of the arguments are null

knownReceivedCount	back to summary
public long knownReceivedCount()

newEncodingContext	back to summary
public Encoder.EncodingContext newEncodingContext(long streamId, long base, HeaderFrameWriter writer)

newHeaderFrameWriter	back to summary
public HeaderFrameWriter newHeaderFrameWriter()

processDecoderAcks	back to summary
private void processDecoderAcks(ByteBuffer buffer) This method is called when the peer decoder sends data on the peer's decoder stream Parameters buffer:ByteBuffer data sent by the peer's decoder

processDecoderAcks

back to summary

private void processDecoderAcks(ByteBuffer buffer)

This method is called when the peer decoder sends data on the peer's decoder stream

Parameters

buffer:ByteBuffer: data sent by the peer's decoder

registerUnackedFieldLineSection	back to summary
public void registerUnackedFieldLineSection(long streamId, Encoder.SectionReference sectionReference)

setTableCapacity	back to summary
public void setTableCapacity(long capacity) Sets the capacity of the encoder's dynamic table and notifies the decoder by issuing "Set Dynamic Table Capacity" instruction. The value has to be agreed between decoder and encoder out-of-band, e.g. by a protocol that uses QPACK (see 4.3.1. Set Dynamic Table Capacity). Parameters capacity:long a non-negative long Exceptions IllegalArgumentException: if capacity is negative or exceeds the negotiated max capacity HTTP/3 setting

setTableCapacity

back to summary

public void setTableCapacity(long capacity)

Sets the capacity of the encoder's dynamic table and notifies the decoder by issuing "Set Dynamic Table Capacity" instruction.

The value has to be agreed between decoder and encoder out-of-band, e.g. by a protocol that uses QPACK (see 4.3.1. Set Dynamic Table Capacity).

Parameters

capacity:long: a non-negative long

Exceptions

IllegalArgumentException:: if capacity is negative or exceeds the negotiated max capacity HTTP/3 setting

unackedFieldLineSectionsRange	back to summary
public Encoder.SectionReference unackedFieldLineSectionsRange(Encoder.EncodingContext context)

unackedFieldLineSectionsRange	back to summary
private Encoder.SectionReference unackedFieldLineSectionsRange(Encoder.SectionReference initial)

updateKrcInsertCountIncrement	back to summary
private void updateKrcInsertCountIncrement(long increment)

updateKrcSectionAck	back to summary
private void updateKrcSectionAck(long streamId)

jdk.internal.net.http.qpack back to summary

public Class Encoder.EncodingContext

Class Inheritance

extends Object
implements AutoCloseable

java.lang.Object
jdk.internal.net.http.qpack.Encoder.EncodingContext

All Implemented Interfaces

java.lang.AutoCloseable

Field Summary

Modifier and Type	Field and Description
pack-priv final long	base
pack-priv boolean	blockedDecoderExpected
pack-priv final EncoderInstructionsWriter	encoderInstructionsWriter
pack-priv long	maxIndex
pack-priv long	minIndex
pack-priv final ConcurrentSkipListSet<Long>	referencedIndexes
pack-priv final long	streamId
pack-priv final HeaderFrameWriter	writer

Constructor Summary

Access	Constructor and Description
public	EncodingContext(long streamId, long base, HeaderFrameWriter writer)

Method Summary

Modifier and Type	Method and Description
private boolean	canReferenceNewEntry()
public void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public Encoder.SectionReference	evictionLimit()
public void	referenceEntry(TableEntry tableEntry)
public void	registerSessionReference(long absoluteEntryId)
public FieldSectionPrefix	sectionPrefix()
public TableEntry	tryInsertEntry(TableEntry entry)

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

Field Detail

base	back to summary
pack-priv final long base

blockedDecoderExpected	back to summary
pack-priv boolean blockedDecoderExpected

encoderInstructionsWriter	back to summary
pack-priv final EncoderInstructionsWriter encoderInstructionsWriter

maxIndex	back to summary
pack-priv long maxIndex

minIndex	back to summary
pack-priv long minIndex

referencedIndexes	back to summary
pack-priv final ConcurrentSkipListSet<Long> referencedIndexes

streamId	back to summary
pack-priv final long streamId

writer	back to summary
pack-priv final HeaderFrameWriter writer

Constructor Detail

EncodingContext	back to summary
public EncodingContext(long streamId, long base, HeaderFrameWriter writer)

Method Detail

canReferenceNewEntry	back to summary
private boolean canReferenceNewEntry()

close back to summary

public void close()

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

evictionLimit	back to summary
public Encoder.SectionReference evictionLimit()

referenceEntry	back to summary
public void referenceEntry(TableEntry tableEntry)

registerSessionReference	back to summary
public void registerSessionReference(long absoluteEntryId)

sectionPrefix	back to summary
public FieldSectionPrefix sectionPrefix()

tryInsertEntry	back to summary
public TableEntry tryInsertEntry(TableEntry entry)

jdk.internal.net.http.qpack back to summary

public final Record Encoder.SectionReference

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
jdk.internal.net.http.qpack.Encoder.SectionReference

Record Components

min:long: minimum entry id referenced from a field lines section
max:long: maximum entry id referenced from a field lines section

Descriptor of entries range referenced from a field lines section.

Field Summary

Modifier and Type	Field and Description
private final long	max Record Component accessed by max(). maximum entry id referenced from a field lines section
private final long	min Record Component accessed by min(). minimum entry id referenced from a field lines section

Constructor Summary

Access	Constructor and Description
public	SectionReference(long min, long max)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public boolean	fullyAcked(long knownReceiveCount)
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public long	max() Record Component getter of max. Record Component maximum entry id referenced from a field lines section
public long	min() Record Component getter of min. Record Component minimum entry id referenced from a field lines section
public static Encoder.SectionReference	noReferences()
public static Encoder.SectionReference	of(Encoder.EncodingContext context)
public Encoder.SectionReference	reduce(Encoder.SectionReference other)
public Encoder.SectionReference	reduce(long entryId)
public boolean	referencesEntries()
public static Encoder.SectionReference	singleReference(long entryId)
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

max

back to summary

private final long max

Record Component accessed by max().

maximum entry id referenced from a field lines section

min

back to summary

private final long min

Record Component accessed by min().

minimum entry id referenced from a field lines section

Constructor Detail

SectionReference	back to summary
public SectionReference(long min, long max)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

fullyAcked	back to summary
public boolean fullyAcked(long knownReceiveCount)

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

max

back to summary

public long max()

Record Component getter of max.

Record Component: maximum entry id referenced from a field lines section

min

back to summary

public long min()

Record Component getter of min.

Record Component: minimum entry id referenced from a field lines section

noReferences	back to summary
public static Encoder.SectionReference noReferences()

of	back to summary
public static Encoder.SectionReference of(Encoder.EncodingContext context)

reduce	back to summary
public Encoder.SectionReference reduce(Encoder.SectionReference other)

reduce	back to summary
public Encoder.SectionReference reduce(long entryId)

referencesEntries	back to summary
public boolean referencesEntries()

singleReference	back to summary
public static Encoder.SectionReference singleReference(long entryId)

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class Encoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Encoder.EncodingContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record Encoder.SectionReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Encoder.TableUpdatesCallback

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	onInsertCountIncrement(long increment) Implements jdk.internal.net.http.qpack.readers.DecoderInstructionsReader.Callback.onInsertCountIncrement.
public void	onSectionAck(long streamId) Implements jdk.internal.net.http.qpack.readers.DecoderInstructionsReader.Callback.onSectionAck.
public void	onStreamCancel(long streamId) Implements jdk.internal.net.http.qpack.readers.DecoderInstructionsReader.Callback.onStreamCancel.