Top Description Inners Fields Constructors Methods

io.undertow.protocols.http2

public Class HpackEncoder

Class Inheritance

extends Object

java.lang.Object
io.undertow.protocols.http2.HpackEncoder

Imports

io.undertow.util.HeaderMap, .HeaderValues, .Headers, .HttpString, java.nio.ByteBuffer, java.util.ArrayDeque, .ArrayList, .Collections, .Deque, .HashMap, .HashSet, .List, .Map, .Set

Encoder for HPACK frames.

Author: Stuart Douglas

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	HpackEncoder.DynamicTableEntry
public static interface	HpackEncoder.HpackHeaderFunction
public static enum	HpackEncoder.State
pack-priv static class	HpackEncoder.TableEntry

Field Summary

Modifier and Type	Field and Description
private HeaderMap	currentHeaders
private int	currentTableSize The current table size
public static final HpackEncoder.HpackHeaderFunction	DEFAULT_HEADER_FUNCTION
private final Map<HttpString, List<HpackEncoder.TableEntry>>	dynamicTable
private static final Map<HttpString, HpackEncoder.TableEntry[]>	ENCODING_STATIC_TABLE
private int	entryPositionCounter
private final Deque<HpackEncoder.TableEntry>	evictionQueue
private boolean	firstPass
private long	headersIterator
private final HpackEncoder.HpackHeaderFunction	hpackHeaderFunction
private int	maxTableSize The maximum table size
private int	minNewMaxHeaderSize
private int	newMaxHeaderSize
private byte[]	overflowData
private int	overflowLength
private int	overflowPos
private static final Set<HttpString>	SKIP

Constructor Summary

Access	Constructor and Description
public	HpackEncoder(int maxTableSize, HpackEncoder.HpackHeaderFunction headerFunction)
public	HpackEncoder(int maxTableSize)

Method Summary

Modifier and Type	Method and Description
private void	addToDynamicTable(HttpString headerName, String val)
public HpackEncoder.State	encode(HeaderMap headers, ByteBuffer target) Encodes the headers into a buffer.
private HpackEncoder.TableEntry	findInTable(HttpString headerName, String value)
private void	handleTableSizeChange(ByteBuffer target)
private void	preventPositionRollover()
private void	runEvictionIfRequired()
public void	setMaxTableSize(int newSize)
private void	writeHuffmanEncodableName(ByteBuffer target, HttpString headerName)
private void	writeHuffmanEncodableValue(ByteBuffer target, HttpString headerName, String val)
private void	writeValueString(ByteBuffer target, String val)

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

Field Detail

currentHeaders	back to summary
private HeaderMap currentHeaders

currentTableSize	back to summary
private int currentTableSize The current table size

DEFAULT_HEADER_FUNCTION	back to summary
public static final HpackEncoder.HpackHeaderFunction DEFAULT_HEADER_FUNCTION

dynamicTable	back to summary
private final Map<HttpString, List<HpackEncoder.TableEntry>> dynamicTable

ENCODING_STATIC_TABLE	back to summary
private static final Map<HttpString, HpackEncoder.TableEntry[]> ENCODING_STATIC_TABLE

entryPositionCounter	back to summary
private int entryPositionCounter

evictionQueue	back to summary
private final Deque<HpackEncoder.TableEntry> evictionQueue

firstPass	back to summary
private boolean firstPass

headersIterator	back to summary
private long headersIterator

hpackHeaderFunction	back to summary
private final HpackEncoder.HpackHeaderFunction hpackHeaderFunction

maxTableSize	back to summary
private int maxTableSize The maximum table size

minNewMaxHeaderSize	back to summary
private int minNewMaxHeaderSize

newMaxHeaderSize	back to summary
private int newMaxHeaderSize

overflowData	back to summary
private byte[] overflowData

overflowLength	back to summary
private int overflowLength

overflowPos	back to summary
private int overflowPos

SKIP	back to summary
private static final Set<HttpString> SKIP

Constructor Detail

HpackEncoder	back to summary
public HpackEncoder(int maxTableSize, HpackEncoder.HpackHeaderFunction headerFunction)

HpackEncoder	back to summary
public HpackEncoder(int maxTableSize)

Method Detail

addToDynamicTable	back to summary
private void addToDynamicTable(HttpString headerName, String val)

encode	back to summary
public HpackEncoder.State encode(HeaderMap headers, ByteBuffer target) Encodes the headers into a buffer.

findInTable	back to summary
private HpackEncoder.TableEntry findInTable(HttpString headerName, String value)

handleTableSizeChange	back to summary
private void handleTableSizeChange(ByteBuffer target)

preventPositionRollover	back to summary
private void preventPositionRollover()

runEvictionIfRequired	back to summary
private void runEvictionIfRequired()

setMaxTableSize	back to summary
public void setMaxTableSize(int newSize)

writeHuffmanEncodableName	back to summary
private void writeHuffmanEncodableName(ByteBuffer target, HttpString headerName)

writeHuffmanEncodableValue	back to summary
private void writeHuffmanEncodableValue(ByteBuffer target, HttpString headerName, String val)

writeValueString	back to summary
private void writeValueString(ByteBuffer target, String val)

io.undertow.protocols.http2 back to summary

pack-priv Class HpackEncoder.DynamicTableEntry

Class Inheritance

extends TableEntry

java.lang.Object
io.undertow.protocols.http2.HpackEncoder.TableEntry
io.undertow.protocols.http2.HpackEncoder.DynamicTableEntry

Field Summary

Inherited from io.undertow.protocols.http2.HpackEncoder.TableEntry:: name position size value

Constructor Summary

Access	Constructor and Description
pack-priv	DynamicTableEntry(HttpString name, String value, int position)

Method Summary

Modifier and Type	Method and Description
public int	getPosition() Overrides io.undertow.protocols.http2.HpackEncoder.TableEntry.getPosition.

Constructor Detail

DynamicTableEntry	back to summary
pack-priv DynamicTableEntry(HttpString name, String value, int position)

Method Detail

getPosition	back to summary
public int getPosition() Overrides io.undertow.protocols.http2.HpackEncoder.TableEntry.getPosition. Annotations @Override

getPosition

back to summary

public int getPosition()

Overrides io.undertow.protocols.http2.HpackEncoder.TableEntry.getPosition.

Annotations

@Override

io.undertow.protocols.http2 back to summary

public Interface HpackEncoder.HpackHeaderFunction

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the value should be encoded shouldUseHuffman(HttpString The header name header, String The header value to be encoded value) Returns true if huffman encoding should be used on the header value
public boolean	Returns: `true` if the value should be encoded shouldUseHuffman(HttpString The header name to be encoded header) Returns true if huffman encoding should be used on the header name
public boolean	shouldUseIndexing(HttpString header, String value)

Method Detail

shouldUseHuffman back to summary

shouldUseHuffman	back to summary
public boolean shouldUseHuffman(HttpString header, String value) Returns true if huffman encoding should be used on the header value Parameters header:HttpString The header name value:String The header value to be encoded Returns:boolean `true` if the value should be encoded

public boolean shouldUseHuffman(HttpString header, String value)

Returns true if huffman encoding should be used on the header value

Parameters

header:HttpString: The header name
value:String: The header value to be encoded

Returns:boolean

true if the value should be encoded

shouldUseHuffman back to summary

shouldUseHuffman	back to summary
public boolean shouldUseHuffman(HttpString header) Returns true if huffman encoding should be used on the header name Parameters header:HttpString The header name to be encoded Returns:boolean `true` if the value should be encoded

public boolean shouldUseHuffman(HttpString header)

Returns true if huffman encoding should be used on the header name

Parameters

header:HttpString: The header name to be encoded

Returns:boolean

true if the value should be encoded

shouldUseIndexing	back to summary
public boolean shouldUseIndexing(HttpString header, String value)

io.undertow.protocols.http2 back to summary

public final Enum HpackEncoder.State

Class Inheritance

extends Enum<HpackEncoder.State>

java.lang.Object
java.lang.Enum
io.undertow.protocols.http2.HpackEncoder.State

Field Summary

Modifier and Type	Field and Description
public static final HpackEncoder.State	COMPLETE
public static final HpackEncoder.State	OVERFLOW

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static HpackEncoder.State	valueOf(String name)
public static HpackEncoder.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMPLETE	back to summary
public static final HpackEncoder.State COMPLETE

OVERFLOW	back to summary
public static final HpackEncoder.State OVERFLOW

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static HpackEncoder.State valueOf(String name)

values	back to summary
public static HpackEncoder.State[] values()

io.undertow.protocols.http2 back to summary

pack-priv Class HpackEncoder.TableEntry

Class Inheritance

extends Object

java.lang.Object
io.undertow.protocols.http2.HpackEncoder.TableEntry

Known Direct Subclasses

io.undertow.protocols.http2.HpackEncoder.DynamicTableEntry

Field Summary

Modifier and Type	Field and Description
pack-priv final HttpString	name
pack-priv int	position
pack-priv final int	size
pack-priv final String	value

Constructor Summary

Access	Constructor and Description
pack-priv	TableEntry(HttpString name, String value, int position)

Method Summary

Modifier and Type	Method and Description
public int	getPosition()

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

Field Detail

name	back to summary
pack-priv final HttpString name

position	back to summary
pack-priv int position

size	back to summary
pack-priv final int size

value	back to summary
pack-priv final String value

Constructor Detail

TableEntry	back to summary
pack-priv TableEntry(HttpString name, String value, int position)

Method Detail

getPosition	back to summary
public int getPosition()