TCP (HTTP) flow

{
   "type":  "http",
   "name":  "<flow_name:str>",
   "source": {
         "port_group": [
            "<source_group:str>"
         ]
   },
   "destination": {
         "port_group": [
            "<destination_group:str>"
         ]
   },
   "ecn": "<ecn_code_point:str|int>",
   "dscp": "<dscp_code_point:str|int>",
   "tcp_server_port": "<tcp_server_port:int>",
   "tcp_client_port": "<tcp_client_port:int>",
   "request_size":"<request_size:int>",
   "duration": "<duration:float|int|timedelta>",
   "initial_time_to_wait": "<initial_time_to_wait:float|int|timedelta>",
   "maximum_bitrate": "<maximum_bitrate:float>",
   "receive_window_scaling": "<receive_window_scaling:int>",
   "slow_start_threshold": "<slow_start_threshold:int>",
   "enable_l4s": "<enable_l4s:bool>",
   "add_reverse_direction": "<add_reverse_direction_flow:bool>"
}

HTTP flow parameters

Specific parameters for HTTP flow. The type MUST be defined as http.

type

object

properties

  • type

Type of the flow. Defines which specific flow parameters will be possible.

type

string

enum

http

  • name

Name of this Flow, defaults to auto-generated name when set to none

type

string

  • source

Specifying the source of transmitted data for this flow

type

object

properties

  • port_group

List of port groups specifying the transmitting ports

type

array

items

Port group

additionalProperties

False

  • destination

Specifying the destination for receiving data for this flow

type

object

properties

  • port_group

List of port groups specifying the receiving ports

type

array

items

Port group

additionalProperties

False

  • ecn

IP ECN

Explicit Congestion Notification code point. Defaults to DEFAULT_IP_ECN (0x00)

oneOf

type

integer

maximum

3

minimum

0

type

string

  • dscp

IP DSCP

Differentiated Services Code Point. Defaults to DEFAULT_IP_DSCP (0x00)

oneOf

type

integer

maximum

63

minimum

0

type

string

  • add_reverse_direction

Enables adding a flow in the reverse direction of the original flow.

The reverse flow uses the same configuration as the original. Defaults to false

type

boolean

  • tcp_server_port

Port number of the TCP server, defaults to none

type

integer

maximum

65535

minimum

0

  • tcp_client_port

Port number of the TCP client, defaults to none

type

integer

maximum

65535

minimum

0

  • duration

The time it takes for a TCP request to be completed.

Mutual exclusive with request_size. Defaults to none

type

number

exclusiveMinimum

0

  • request_size

The size of the TCP request packet in bytes.

Mutual exclusive with duration. Defaults to none

type

integer

exclusiveMinimum

0

  • rate_limit

Limit the data traffic rate (in Bytes per second).

Mutual exclusive with maximum_bitrate. Defaults to none (== no limit).

Deprecated since version 1.1.0: Deprecated rate_limit in favor of maximum_bitrate. Will be removed in the next release.

type

number

exclusiveMinimum

0

  • maximum_bitrate

Limit the data traffic rate (in bits per second).

Mutual exclusive with rate_limit. Defaults to none (== no limit).

Added in version 1.1.0: Added maximum_bitrate deprecating rate_limit.

type

number

exclusiveMinimum

0

  • receive_window_scaling

When given, enable receive window scaling with the given scale factor.

Defaults to none.

When ByteBlower Endpoints are involved, this setting will not be applied on them, but only on the HTTP Server on the ByteBlower Port. The ByteBlower Endpoint has no control over the TCP parameters of the host operating system’s. It is then up to the Endpoint’s host configuration whether this setting will be applicable or not.

type

integer

maximum

12

minimum

0

  • slow_start_threshold

TCP Slow start threshold value.

Defaults to none.

When ByteBlower Endpoints are involved, this setting will not be applied on them, but only on the HTTP Server on the ByteBlower Port. The ByteBlower Endpoint has no control over the TCP parameters of the host operating system’s. It is then up to the Endpoint’s host configuration whether this setting will be applicable or not.

type

integer

maximum

2147483647

minimum

0

  • enable_l4s

Activate TCP Prague congestion avoidance algorithm, and enables ECN analysis for Congestion Experienced (CE) codepoint count.

Defaults to false (no L4S analysis, default TCP Prague for ByteBlower Server,disabled for ByteBlower Port, host operating system default for ByteBlower Endpoint).

Note

  • L4S support requires at least ByteBlower API v2.22.0, Server and Meeting Point v2.22.0, and ByteBlower Endpoint v2.22.0.

  • When using Endpoints, L4S must be supported and enabled in the hosting OS

Added in version 1.2.0: Add support for L4S HTTP flow

type

boolean