io.netty.handler.codec.http2

Class Http2Settings

java.lang.Object

io.netty.util.collection.IntObjectHashMap<Long>

io.netty.handler.codec.http2.Http2Settings

All Implemented Interfaces:

IntObjectMap<Long>, Iterable<IntObjectMap.Entry<Long>>

public final class Http2Settings
extends IntObjectHashMap<Long>

Settings for one endpoint in an HTTP/2 connection. Each of the values are optional as defined in the spec for the SETTINGS frame. Permits storage of arbitrary key/value pairs but provides helper methods for standard settings.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.util.collection.IntObjectMap

IntObjectMap.Entry<V>

Constructor Summary

Constructors

Constructor and Description
Http2Settings()
Http2Settings(int initialCapacity)
Http2Settings(int initialCapacity, float loadFactor)

Method Summary

Methods

Modifier and Type	Method and Description
Http2Settings	copyFrom(Http2Settings settings) Clears and then copies the given settings into this object.
Long	headerTableSize() Gets the SETTINGS_HEADER_TABLE_SIZE value.
Http2Settings	headerTableSize(int value) Sets the SETTINGS_HEADER_TABLE_SIZE value.
Integer	initialWindowSize() Gets the SETTINGS_INITIAL_WINDOW_SIZE value.
Http2Settings	initialWindowSize(int value) Sets the SETTINGS_INITIAL_WINDOW_SIZE value.
protected String	keyToString(int key) Helper method called by IntObjectHashMap.toString() in order to convert a single map key into a string.
Long	maxConcurrentStreams() Gets the SETTINGS_MAX_CONCURRENT_STREAMS value.
Http2Settings	maxConcurrentStreams(long value) Sets the SETTINGS_MAX_CONCURRENT_STREAMS value.
Integer	maxFrameSize() Gets the SETTINGS_MAX_FRAME_SIZE value.
Http2Settings	maxFrameSize(int value) Sets the SETTINGS_MAX_FRAME_SIZE value.
Integer	maxHeaderListSize() Gets the SETTINGS_MAX_HEADER_LIST_SIZE value.
Http2Settings	maxHeaderListSize(int value) Sets the SETTINGS_MAX_HEADER_LIST_SIZE value.
Boolean	pushEnabled() Gets the SETTINGS_ENABLE_PUSH value.
Http2Settings	pushEnabled(boolean enabled) Sets the SETTINGS_ENABLE_PUSH value.
Long	put(int key, Long value) Overrides the superclass method to perform verification of standard HTTP/2 settings.

Methods inherited from class io.netty.util.collection.IntObjectHashMap

clear, containsKey, containsValue, entries, equals, get, hashCode, isEmpty, iterator, keys, putAll, remove, size, toString, values, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Http2Settings

public Http2Settings()

Http2Settings

public Http2Settings(int initialCapacity,
             float loadFactor)

Http2Settings

public Http2Settings(int initialCapacity)

Method Detail

put

public Long put(int key,
       Long value)

Overrides the superclass method to perform verification of standard HTTP/2 settings.

Specified by:

put in interface IntObjectMap<Long>

Overrides:

put in class IntObjectHashMap<Long>

Parameters:

key - the key of the entry.

value - the value of the entry.

Returns:

the previous value for this key or null if there was no previous mapping.

Throws:

IllegalArgumentException - if verification of the setting fails.

headerTableSize

public Long headerTableSize()

Gets the SETTINGS_HEADER_TABLE_SIZE value. If unavailable, returns null.

headerTableSize

public Http2Settings headerTableSize(int value)

Sets the SETTINGS_HEADER_TABLE_SIZE value.

Throws:

IllegalArgumentException - if verification of the setting fails.

pushEnabled

public Boolean pushEnabled()

Gets the SETTINGS_ENABLE_PUSH value. If unavailable, returns null.

pushEnabled

public Http2Settings pushEnabled(boolean enabled)

Sets the SETTINGS_ENABLE_PUSH value.

maxConcurrentStreams

public Long maxConcurrentStreams()

Gets the SETTINGS_MAX_CONCURRENT_STREAMS value. If unavailable, returns null.

maxConcurrentStreams

public Http2Settings maxConcurrentStreams(long value)

Sets the SETTINGS_MAX_CONCURRENT_STREAMS value.

Throws:

IllegalArgumentException - if verification of the setting fails.

initialWindowSize

public Integer initialWindowSize()

Gets the SETTINGS_INITIAL_WINDOW_SIZE value. If unavailable, returns null.

initialWindowSize

public Http2Settings initialWindowSize(int value)

Sets the SETTINGS_INITIAL_WINDOW_SIZE value.

Throws:

IllegalArgumentException - if verification of the setting fails.

maxFrameSize

public Integer maxFrameSize()

Gets the SETTINGS_MAX_FRAME_SIZE value. If unavailable, returns null.

maxFrameSize

public Http2Settings maxFrameSize(int value)

Sets the SETTINGS_MAX_FRAME_SIZE value.

Throws:

IllegalArgumentException - if verification of the setting fails.

maxHeaderListSize

public Integer maxHeaderListSize()

Gets the SETTINGS_MAX_HEADER_LIST_SIZE value. If unavailable, returns null.

maxHeaderListSize

public Http2Settings maxHeaderListSize(int value)

Sets the SETTINGS_MAX_HEADER_LIST_SIZE value.

Throws:

IllegalArgumentException - if verification of the setting fails.

copyFrom

public Http2Settings copyFrom(Http2Settings settings)

Clears and then copies the given settings into this object.

keyToString

protected String keyToString(int key)

Description copied from class: IntObjectHashMap

Helper method called by IntObjectHashMap.toString() in order to convert a single map key into a string.

Overrides:

keyToString in class IntObjectHashMap<Long>