LocalLB::ProfileSPDY¶
Introduced : BIG-IP_v11.4.0
The SPDY Profile interface configures the handling of the SPDY
protocol. The SPDY Profile facilitates conversion of HTTP traffic from
a back-end server to clients across the BIG-IP.
Methods¶
| Method | Description | Introduced |
| create | Creates a list of the specified SPDY profiles. | BIG-IP_v11.4.0 |
| delete_all_profiles | Deletes all SPDY profiles. | BIG-IP_v11.4.0 |
| delete_profile | Deletes a list of SPDY profiles. | BIG-IP_v11.4.0 |
| get_activation_mode | Gets the activation mode for the specified SPDY profiles. | BIG-IP_v11.4.0 |
| get_all_statistics | Gets the statistics for all the SPDY profiles. | BIG-IP_v11.4.0 |
| get_compression_level | Gets the amount of compression to do by default for the headers of the specified profiles. | BIG-IP_v11.4.0 |
| get_compression_window_size | Gets the size of the compression window for the specified profiles. | BIG-IP_v11.4.0 |
| get_connection_idle_timeout | Sets how many seconds a SPDY connection is left open idly before it is shutdown. | BIG-IP_v11.4.0 |
| get_default_profile | Gets the default profile of the specified SPDY profiles. | BIG-IP_v11.4.0 |
| get_description | Gets the descriptions for the specified SPDY profiles. | BIG-IP_v11.4.0 |
| get_frame_size | Specifies the size of the data frames, in bytes, that SPDY will send to the client. | BIG-IP_v11.4.0 |
| get_insert_header | Gets the HTTP header sent to the back-end server when header insertion is enabled. | BIG-IP_v11.4.0 |
| get_insert_header_state | Gets the state to indicate whether an HTTP header that indicates the use of SPDY should be inserted in the request going to the back-end server. | BIG-IP_v11.4.0 |
| get_list | Gets the name of all SPDY profiles. | BIG-IP_v11.4.0 |
| get_maximum_concurrent_streams_per_connection | Gets the maximum number of concurrent streams allowed on a single SPDY connection. | BIG-IP_v11.4.0 |
| get_priority_mode | Gets the priority mode for the specified SPDY profiles which handles how concurrent streams of different priorities are handled. See PriorityMode for more details. | BIG-IP_v11.4.0 |
| get_receive_window | Specifies the receive window in kilobytes. | BIG-IP_v11.4.0 |
| get_statistics | Gets the statistics for the specified SPDY profiles. | BIG-IP_v11.4.0 |
| get_statistics_by_virtual | Gets the statistics for the specified profiles, by virtual server. | BIG-IP_v11.4.0 |
| get_supported_version | Gets the list of SPDY versions supported by the specified SPDY profiles. This parameter has effect only if the ActivationMode is set to ACTIVATION_NPN. The order of the protocols determines which are most preferred. See SupportedProtocolVersion for more information. The ordering determines the priority in which a SPDY version is chosen by a client to create a SPDY connection. For example, if the list returned for a profile is [SPDY_VERSION_2, SPDY_VERSION_3, SPDY_VERISION_HTTP], then, when a connection is made using NPN, if the client supports only SPDY version 3 and HTTP, the client will choose to make a connection using SPDY version 3. | BIG-IP_v11.4.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.4.0 |
| get_write_size | Specifies the total size of combined data frames, in bytes, for the specified profiles. | BIG-IP_v11.4.0 |
| is_base_profile | Determines whether the specified SPDY profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). | BIG-IP_v11.4.0 |
| is_system_profile | Determines whether the specified SPDY profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). | BIG-IP_v11.4.0 |
| replace_supported_versions | Replaces the lists of SPDY versions supported by the specified SPDY profiles. The supported versions will be ordered as they are listed in the arguments. | BIG-IP_v11.4.0 |
| reset_statistics | Resets the statistics for the specified SPDY profiles. | BIG-IP_v11.4.0 |
| reset_statistics_by_virtual | Resets the statistics for the specified profiles, for specified virtual servers. | BIG-IP_v11.4.0 |
| set_activation_mode | Sets the activation mode for the specified SPDY profiles which determines the manner in which SPDY connections are made. See ActivationMode for more details. | BIG-IP_v11.4.0 |
| set_compression_level | Sets the amount of compression to do by default for the headers of the specified profiles. The compression level must be between 0 and 10. Higher numbers correspond to more compression. | BIG-IP_v11.4.0 |
| set_compression_window_size | Sets the size of the compression window for the specified profiles in kilobytes. The compression window size must be between 1 and 128 kilobytes. The compression window is the number of bytes that will be compressed in a stream. | BIG-IP_v11.4.0 |
| set_connection_idle_timeout | Sets how many seconds a SPDY connection is left open idly before it is shutdown. | BIG-IP_v11.4.0 |
| set_default_profile | Sets the default profiles for the given SPDY profiles. | BIG-IP_v11.4.0 |
| set_description | Sets the description for the specified SPDY profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.4.0 |
| set_frame_size | Specifies the size of the data frames, in bytes, that SPDY will send to the client. Larger frame sizes will improve network utilization, but may affect concurrency. The default value is 2048. | BIG-IP_v11.4.0 |
| set_insert_header | Sets the HTTP header sent to the back-end server when header insertion is enabled. The default value is “X-SPDY”. | BIG-IP_v11.4.0 |
| set_insert_header_state | Specifies whether an HTTP header that indicates the use of SPDY should be inserted in the request going to the back-end server. | BIG-IP_v11.4.0 |
| set_maximum_concurrent_streams_per_connection | Sets the maximum number of concurrent streams allowed on a single SPDY connection. | BIG-IP_v11.4.0 |
| set_priority_mode | Sets the priority mode for the specified SPDY profiles. See PriorityMode for more details. | BIG-IP_v11.4.0 |
| set_receive_window | Specifies the receive window in kilobytes. The receive window is a mechanism used by SPDY to perform flow control. The receive window allows SPDY to stall individual upload streams when needed. This mechanism is available only for SPDY version 3. The default value is 32. | BIG-IP_v11.4.0 |
| set_write_size | Specifies the total size of combined data frames, in bytes, SPDY will send in a single write for the specified profiles. This controls the size of the TLS records when SPDY is used over SSL. A large write size will cause SPDY to buffer more data, but will improve network utilization. The default value is 16384. | BIG-IP_v11.4.0 |
Structures¶
Structure
Description
A structure that specifies an ActivationMode enum used in profile attributes.
A structure that specifies an PriorityMode enum used in profile attributes.
A struct that describes statistics for a particular SPDY profile.
A struct that describes profile statistics and timestamp.
ProfileSupportedProtocolVersionSequence
A structure that specifies a SupportedProtocolVersion enum used in profile attributes.
Enumerations¶
| Enumeration | Description |
| ActivationMode | Determines the manner in which SPDY connections are made. |
| PriorityMode | Specifies how SPDY profiles should handle priorities of concurrent streams within the same connection. |
| SupportedProtocolVersion | Specifies which SPDY protocols clients are allowed to use. This parameter has effect only if the ActivationMode is set to SPDY_ACTIVATION_NPN. The order of the protocols determines which are most preferred. |
Aliases¶
| Alias | Type | Description |
| ProfileActivationModeSequence | ProfileActivationMode [] | A sequence of ProfileActivationModes. |
| ProfilePriorityModeSequence | ProfilePriorityMode [] | A sequence of ProfilePriorityModes. |
| ProfileSPDYStatisticEntrySequence | ProfileSPDYStatisticEntry [] | A sequence of ProfileSPDY statistics. |
| ProfileSupportedProtocolVersionSequenceSequence | ProfileSupportedProtocolVersionSequence [] | A list of ProfileSupportedProtocolVersionSequences. |
| SupportedProtocolVersionSequence | SupportedProtocolVersion [] | A list of SupportedProtocolVersion enums. |
See Also¶
iControl ::
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.