Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	QpackEncoder.InstructionHandler

Field Summary

Modifier and Type	Field and Description
private int	_blockedStreams
private final QpackContext	_context
private final Instruction.Handler	_handler
private final QpackEncoder.InstructionHandler	_instructionHandler
private final List<Instruction>	_instructions
private int	_knownInsertCount
private int	_maxBlockedStreams
private int	_maxHeadersSize
private int	_maxTableCapacity
private final EncoderInstructionParser	_parser
private final Map<Long, StreamInfo>	_streamInfoMap
public static final EnumSet<HttpHeader>	DO_NOT_HUFFMAN
public static final EnumSet<HttpHeader>	DO_NOT_INDEX
private final AutoLock	lock
private static final Logger	LOG
public static final EnumSet<HttpHeader>	NEVER_INDEX

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
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.
public void	encode(ByteBuffer the buffer to take the bytes of the encoded `MetaData`. buffer, long the stream ID corresponding to this headers frame. streamId, MetaData the `MetaData` to encode into the buffer. metadata) Encodes a `MetaData` object into the supplied `ByteBuffer` for a specific HTTP/s stream.
private EncodableEntry	encode(StreamInfo streamInfo, HttpField field)
private static int	encodeInsertCount(int reqInsertCount, int maxTableCapacity)
pack-priv QpackEncoder.InstructionHandler	getInstructionHandler()
public int	getMaxBlockedStreams()
public int	getMaxHeadersSize()
public int	getMaxTableCapacity()
pack-priv Map<Long, StreamInfo>	getStreamInfoMap()
public int	getTableCapacity()
public boolean	Returns: true if the field was successfully inserted into the Dynamic Table. insert(HttpField the field to insert into the Dynamic Table. field) A speculative insert of a Header into the Encoders Dynamic Table.
private void	notifyInstructionHandler()
public void	parseInstructions(ByteBuffer a buffer containing bytes from the Decoder stream. buffer) Parse instructions from the Decoder stream.
private boolean	referenceEntry(Entry entry, StreamInfo streamInfo)
public void	setMaxBlockedStreams(int maxBlockedStreams)
public void	setMaxHeadersSize(int maxHeadersSize)
public void	setMaxTableCapacity(int maxTableCapacity)
public void	setTableCapacity(int the new capacity. capacity) Set the capacity of the DynamicTable and send a instruction to set the capacity on the remote Decoder.
protected boolean	shouldHuffmanEncode(HttpField httpField)
protected boolean	shouldIndex(HttpField httpField)
public void	streamCancellation(long the streamId of the stream that was cancelled. streamId) Tells the `QpackEncoder` that a particular stream has been cancelled.

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

Field Detail

_blockedStreams	back to summary
private int _blockedStreams

_context	back to summary
private final QpackContext _context

_handler	back to summary
private final Instruction.Handler _handler

_instructionHandler	back to summary
private final QpackEncoder.InstructionHandler _instructionHandler

_instructions	back to summary
private final List<Instruction> _instructions

_knownInsertCount	back to summary
private int _knownInsertCount

_maxBlockedStreams	back to summary
private int _maxBlockedStreams

_maxHeadersSize	back to summary
private int _maxHeadersSize

_maxTableCapacity	back to summary
private int _maxTableCapacity

_parser	back to summary
private final EncoderInstructionParser _parser

_streamInfoMap	back to summary
private final Map<Long, StreamInfo> _streamInfoMap

DO_NOT_HUFFMAN	back to summary
public static final EnumSet<HttpHeader> DO_NOT_HUFFMAN

DO_NOT_INDEX	back to summary
public static final EnumSet<HttpHeader> DO_NOT_INDEX

lock	back to summary
private final AutoLock lock

LOG	back to summary
private static final Logger LOG

NEVER_INDEX	back to summary
public static final EnumSet<HttpHeader> NEVER_INDEX

Constructor Detail

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

Method Detail

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

encode back to summary

public void encode(ByteBuffer buffer, long streamId, MetaData metadata) throws QpackException

Encodes a MetaData object into the supplied ByteBuffer for a specific HTTP/s stream.

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

The given buffer is filled starting from its current position p with N encoded bytes and upon return its position will be p + N.

Parameters

buffer:ByteBuffer: the buffer to take the bytes of the encoded MetaData.
streamId:long: the stream ID corresponding to this headers frame.
metadata:MetaData: the MetaData to encode into the buffer.

Exceptions

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

encode	back to summary
private EncodableEntry encode(StreamInfo streamInfo, HttpField field)

encodeInsertCount	back to summary
private static int encodeInsertCount(int reqInsertCount, int maxTableCapacity)

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

getMaxBlockedStreams	back to summary
public int getMaxBlockedStreams()

getMaxHeadersSize	back to summary
public int getMaxHeadersSize()

getMaxTableCapacity	back to summary
public int getMaxTableCapacity()

getStreamInfoMap	back to summary
pack-priv Map<Long, StreamInfo> getStreamInfoMap()

getTableCapacity	back to summary
public int getTableCapacity()

insert	back to summary
public boolean insert(HttpField field) A speculative insert of a Header into the Encoders Dynamic Table. This will also generate an instruction to be sent over the Encoder stream to the remote Decoder. Parameters field:HttpField the field to insert into the Dynamic Table. Returns:boolean true if the field was successfully inserted into the Dynamic Table.

insert

back to summary

public boolean insert(HttpField field)

A speculative insert of a Header into the Encoders Dynamic Table. This will also generate an instruction to be sent over the Encoder stream to the remote Decoder.

Parameters

field:HttpField: the field to insert into the Dynamic Table.

Returns:boolean

true if the field was successfully inserted into the Dynamic Table.

notifyInstructionHandler	back to summary
private void notifyInstructionHandler()

parseInstructions back to summary

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

public void parseInstructions(ByteBuffer buffer) throws QpackException

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

Parameters

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

Exceptions

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

referenceEntry	back to summary
private boolean referenceEntry(Entry entry, StreamInfo streamInfo)

setMaxBlockedStreams	back to summary
public void setMaxBlockedStreams(int maxBlockedStreams)

setMaxHeadersSize	back to summary
public void setMaxHeadersSize(int maxHeadersSize)

setMaxTableCapacity	back to summary
public void setMaxTableCapacity(int maxTableCapacity)

setTableCapacity	back to summary
public void setTableCapacity(int capacity) Set the capacity of the DynamicTable and send a instruction to set the capacity on the remote Decoder. Parameters capacity:int the new capacity.

setTableCapacity

back to summary

public void setTableCapacity(int capacity)

Set the capacity of the DynamicTable and send a instruction to set the capacity on the remote Decoder.

Parameters

capacity:int: the new capacity.

shouldHuffmanEncode	back to summary
protected boolean shouldHuffmanEncode(HttpField httpField)

shouldIndex	back to summary
protected boolean shouldIndex(HttpField httpField)

streamCancellation back to summary

streamCancellation	back to summary
public void streamCancellation(long streamId) Tells the `QpackEncoder` that a particular stream has been cancelled. Any state stored for this stream will be discarded. The encoder may also receive a stream cancellation instruction from the remote Decoder to cancel the stream which will be a noop if this method was called on the local encoder first. Parameters streamId:long the streamId of the stream that was cancelled.

public void streamCancellation(long streamId)

Tells the QpackEncoder that a particular stream has been cancelled. Any state stored for this stream will be discarded. The encoder may also receive a stream cancellation instruction from the remote Decoder to cancel the stream which will be a noop if this method was called on the local encoder first.

Parameters

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

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

pack-priv Class QpackEncoder.InstructionHandler

Class Inheritance

extends Object
implements Handler

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

All Implemented Interfaces

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

Constructor Summary

Access	Constructor and Description
pack-priv	InstructionHandler()

Method Summary

Modifier and Type	Method and Description
public void	onInsertCountIncrement(int increment) Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onInsertCountIncrement.
public void	onSectionAcknowledgement(long streamId) Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onSectionAcknowledgement.
public void	onStreamCancellation(long streamId) Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onStreamCancellation.

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

onInsertCountIncrement	back to summary
public void onInsertCountIncrement(int increment) throws QpackException Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onInsertCountIncrement. Annotations @Override

onInsertCountIncrement

back to summary

public void onInsertCountIncrement(int increment) throws QpackException

Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onInsertCountIncrement.

Annotations

@Override

onSectionAcknowledgement	back to summary
public void onSectionAcknowledgement(long streamId) throws QpackException Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onSectionAcknowledgement. Annotations @Override

onSectionAcknowledgement

back to summary

public void onSectionAcknowledgement(long streamId) throws QpackException

Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onSectionAcknowledgement.

Annotations

@Override

onStreamCancellation	back to summary
public void onStreamCancellation(long streamId) Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onStreamCancellation. Annotations @Override

onStreamCancellation

back to summary

public void onStreamCancellation(long streamId)

Implements org.eclipse.jetty.http3.qpack.internal.parser.EncoderInstructionParser.Handler.onStreamCancellation.

Annotations

@Override

public Class QpackEncoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class QpackEncoder.InstructionHandler

Constructor Summary

Method Summary

Constructor Detail

Method Detail