SpdySettingsFrame (Netty API Reference (4.1.11.Final))

All Superinterfaces:

SpdyFrame

All Known Implementing Classes:

DefaultSpdySettingsFrame
```
public interface SpdySettingsFrame
extends SpdyFrame
```
A SPDY Protocol SETTINGS Frame

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SETTINGS_CLIENT_CERTIFICATE_VECTOR_SIZE`
`static int`	`SETTINGS_CURRENT_CWND`
`static int`	`SETTINGS_DOWNLOAD_BANDWIDTH`
`static int`	`SETTINGS_DOWNLOAD_RETRANS_RATE`
`static int`	`SETTINGS_INITIAL_WINDOW_SIZE`
`static int`	`SETTINGS_MAX_CONCURRENT_STREAMS`
`static int`	`SETTINGS_MINOR_VERSION`
`static int`	`SETTINGS_ROUND_TRIP_TIME`
`static int`	`SETTINGS_UPLOAD_BANDWIDTH`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`clearPreviouslyPersistedSettings()` Returns `true` if previously persisted settings should be cleared.
`int`	`getValue(int id)` Returns the value of the setting ID.
`Set<Integer>`	`ids()` Returns a `Set` of the setting IDs.
`boolean`	`isPersisted(int id)` Returns `true` if this setting is persisted.
`boolean`	`isPersistValue(int id)` Returns `true` if this setting should be persisted.
`boolean`	`isSet(int id)` Returns `true` if the setting ID has a value.
`SpdySettingsFrame`	`removeValue(int id)` Removes the value of the setting ID.
`SpdySettingsFrame`	`setClearPreviouslyPersistedSettings(boolean clear)` Sets if previously persisted settings should be cleared.
`SpdySettingsFrame`	`setPersisted(int id, boolean persisted)` Sets if this setting is persisted.
`SpdySettingsFrame`	`setPersistValue(int id, boolean persistValue)` Sets if this setting should be persisted.
`SpdySettingsFrame`	`setValue(int id, int value)` Sets the value of the setting ID.
`SpdySettingsFrame`	`setValue(int id, int value, boolean persistVal, boolean persisted)` Sets the value of the setting ID.

- Field Detail
  - SETTINGS_MINOR_VERSION
```
static final int SETTINGS_MINOR_VERSION
```
    See Also:
    
    Constant Field Values
  - SETTINGS_UPLOAD_BANDWIDTH
```
static final int SETTINGS_UPLOAD_BANDWIDTH
```
    See Also:
    
    Constant Field Values
  - SETTINGS_DOWNLOAD_BANDWIDTH
```
static final int SETTINGS_DOWNLOAD_BANDWIDTH
```
    See Also:
    
    Constant Field Values
  - SETTINGS_ROUND_TRIP_TIME
```
static final int SETTINGS_ROUND_TRIP_TIME
```
    See Also:
    
    Constant Field Values
  - SETTINGS_MAX_CONCURRENT_STREAMS
```
static final int SETTINGS_MAX_CONCURRENT_STREAMS
```
    See Also:
    
    Constant Field Values
  - SETTINGS_CURRENT_CWND
```
static final int SETTINGS_CURRENT_CWND
```
    See Also:
    
    Constant Field Values
  - SETTINGS_DOWNLOAD_RETRANS_RATE
```
static final int SETTINGS_DOWNLOAD_RETRANS_RATE
```
    See Also:
    
    Constant Field Values
  - SETTINGS_INITIAL_WINDOW_SIZE
```
static final int SETTINGS_INITIAL_WINDOW_SIZE
```
    See Also:
    
    Constant Field Values
  - SETTINGS_CLIENT_CERTIFICATE_VECTOR_SIZE
```
static final int SETTINGS_CLIENT_CERTIFICATE_VECTOR_SIZE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - ids
```
Set<Integer> ids()
```
    Returns a Set of the setting IDs. The set's iterator will return the IDs in ascending order.
  - isSet
```
boolean isSet(int id)
```
    Returns true if the setting ID has a value.
  - getValue
```
int getValue(int id)
```
    Returns the value of the setting ID. Returns -1 if the setting ID is not set.
  - setValue
```
SpdySettingsFrame setValue(int id,
                           int value)
```
    Sets the value of the setting ID. The ID cannot be negative and cannot exceed 16777215.
  - setValue
```
SpdySettingsFrame setValue(int id,
                           int value,
                           boolean persistVal,
                           boolean persisted)
```
    Sets the value of the setting ID. Sets if the setting should be persisted (should only be set by the server). Sets if the setting is persisted (should only be set by the client). The ID cannot be negative and cannot exceed 16777215.
  - removeValue
```
SpdySettingsFrame removeValue(int id)
```
    Removes the value of the setting ID. Removes all persistence information for the setting.
  - isPersistValue
```
boolean isPersistValue(int id)
```
    Returns true if this setting should be persisted. Returns false if this setting should not be persisted or if the setting ID has no value.
  - setPersistValue
```
SpdySettingsFrame setPersistValue(int id,
                                  boolean persistValue)
```
    Sets if this setting should be persisted. Has no effect if the setting ID has no value.
  - isPersisted
```
boolean isPersisted(int id)
```
    Returns true if this setting is persisted. Returns false if this setting should not be persisted or if the setting ID has no value.
  - setPersisted
```
SpdySettingsFrame setPersisted(int id,
                               boolean persisted)
```
    Sets if this setting is persisted. Has no effect if the setting ID has no value.
  - clearPreviouslyPersistedSettings
```
boolean clearPreviouslyPersistedSettings()
```
    Returns true if previously persisted settings should be cleared.
  - setClearPreviouslyPersistedSettings
```
SpdySettingsFrame setClearPreviouslyPersistedSettings(boolean clear)
```
    Sets if previously persisted settings should be cleared.

Interface SpdySettingsFrame

Field Summary

Method Summary

Field Detail

SETTINGS_MINOR_VERSION

SETTINGS_UPLOAD_BANDWIDTH

SETTINGS_DOWNLOAD_BANDWIDTH

SETTINGS_ROUND_TRIP_TIME

SETTINGS_MAX_CONCURRENT_STREAMS

SETTINGS_CURRENT_CWND

SETTINGS_DOWNLOAD_RETRANS_RATE

SETTINGS_INITIAL_WINDOW_SIZE

SETTINGS_CLIENT_CERTIFICATE_VECTOR_SIZE

Method Detail

ids

isSet

getValue

setValue

setValue

removeValue

isPersistValue

setPersistValue

isPersisted

setPersisted

clearPreviouslyPersistedSettings

setClearPreviouslyPersistedSettings