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>",
   "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

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

number

type

string

  • dscp

IP DSCP

Differentiated Services Code Point, defaults to DEFAULT_IP_DSCP (0x00)

oneOf

type

number

type

string

  • tcp_server_port

Port number of the TCP server, defaults to none

type

number

  • tcp_client_port

Port number of the TCP client, defaults to none

type

number

  • duration

The time it takes for a TCP request to be completed , mutual exclusive with request_size, defaults to none

type

number

  • request_size

The size of the TCP request packet in bytes, mutual exclusive with duration, defaults to none

type

number

  • rate_limit

Limit the data traffic rate (in Bytes per second), defaults to none (== no limit).

Mutual exclusive with maximum_bitrate

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

type

number

  • maximum_bitrate

Limit the data traffic rate (in bits per second), defaults to none (== no limit).

Mutual exclusive with rate_limit

New in version 1.1.0: Added maximum_bitrate deprecating rate_limit.

type

number

  • 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

number

  • 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

number

  • add_reverse_direction

Enables adding a flow in the reverse direction of the original flow with the same configuration, defaults to false

type

string