Accelerate Object

class activelogic.AccelerateObject

Object representing an accelerate object in the ruleset.

Parameters:

  • name (str) – Name of the object.

  • id (int) – Id of the object.

  • internal_congestion_control_initial_cwnd (int) – The initial congestion window size toward the internal side. This attribute sets the number of packets that TCP Accelerator sends into the flight at the start of a connection before it receives any acknowledgments.

  • external_congestion_control_initial_cwnd (int) – The initial congestion window size toward the external side. This attribute sets the number of packets that TCP Accelerator should send into flight at the start of a connection before it receives any acknowledgments.

  • internal_congestion_control_max_cwnd (int) – The maximum number of unacknowledged packets toward the external side that TCP Accelerator should send in flight toward the internet (the internal side).

  • external_congestion_control_max_cwnd (int) – The maximum number of unacknowledged packets toward the external side that TCP Accelerator should send in flight toward the internet (the external side).

  • internal_congestion_control_min_cwnd (int) – The maximum number of unacknowledged packets toward the external side that TCP Accelerator should send into flight towards the internet. This controls the minimum throughput a single connection sends toward the internet (internal side).

  • external_congestion_control_min_cwnd (int) – The maximum number of unacknowledged packets toward the external side that TCP Accelerator should send into flight towards the internet. This controls the minimum throughput a single connection sends toward the internet (external side). :param internal_congestion_control_free_events: The number of packet-loss congestion events toward the internal side that the TCP Accelerator should ignore at the start of a connection.

  • external_congestion_control_free_events (int) – The number of packet-loss congestion-events toward the external side that TCP Accelerator should ignore at the start of a connection.

  • internal_congestion_control_initial_ssthresh (int) – The initial slow start threshold toward the internal side.

  • external_congestion_control_initial_ssthresh (int) – The initial slow start threshold toward the external side.

  • internal_congestion_control_ssthresh_factor (int) – The slow-start threshold toward the internal side in terms of the percentage of in flight packets.

  • external_congestion_control_ssthresh_factor (int) – The slow-start threshold toward the external side in terms of the percentage of inflight packets.

  • internal_congestion_control_event_factor (int) – The percentage of the congestion window toward the internal side after a congestion event occurs.

  • external_congestion_control_event_factor (int) – The percentage of the congestion window toward the external side after a congestion event occurs.

  • internal_retransmission_loss_probe_interval (int) – The interval between probes for detecting packet loss(in milliseconds) on the internal side.

  • external_retransmission_loss_probe_interval (int) – The interval between probes for detecting packet loss(in milliseconds) on the external side.

  • internal_retransmission_enable_loss_probes (bool) – When enabled, TCP Accelerator uses 1-byte loss probing instead of full-sized packet retransmissions on the internal side.

  • external_retransmission_enable_loss_probes (bool) – When enabled, TCP Accelerator uses 1-byte loss probing instead of full-sized packet retransmissions on the external side.

  • retransmission_min_fast_retransmit_data_packets (int) – The number of data packets retransmitted immediately, ignoring cwnd.

  • retransmission_rto_base_timeout_ms (int) – The time delay by which all retransmit timeouts.

  • retransmission_loss_probe_on_sack (bool) – Enables loss probing for SACKs.

  • dynamic_buffering (bool) – Advertises the receive window towards the internal side depending on the rate at which the packet is delivered.

  • dynamic_buffering_max_bytes (int) – Forces TCP Accelerator to not advertise a lower window to the sender than the receiver has advertised.

  • dynamic_buffering_use_internal_window (bool) – When enabled, forces the TCP Accelerator to not advertise a lower window to the sender than the receiver has advertised.

  • dynamic_buffering_target_interval (int) – The interval in seconds for the volume of data that should be in progress, aiming to have n seconds worth of data, based on the recent latency measurements.

  • buffering_max_window (int) – The maximum window size in bytes that should be advertised in either direction.

  • buffering_static_buffering_bytes (int) – Sets the maximum target buffer size used when dynamic buffering is not enabled.

  • buffering_internal_max_window (int) – The maximum window size (in bytes) that is advertised toward the internal side.

  • buffering_external_max_window (int) – The maximum window size (in bytes) that is advertised toward the external side.

  • buffering_min_advert_mss (int) – Sets the minimum advertise window.

  • reordering_detect_packet_loss_timeout (int) – The time in milliseconds before an ambiguous packet loss or reordering signal (such as SACK, dupack) is considered a lost packet.

  • reordering_internal_reordering_threshold (int) – The number of out-of-order ACKs that the internal side receives before the system considers a packet lost, and not just reordered.

  • reordering_external_reordering_threshold (int) – The number of out-of-order ACKs that the external side receives before the system considers a packet lost, and not just reordered.

  • reordering_detect_reordering_retroactively (bool) – Use a heuristic to identify which packet is reordered and which packet is lost after a retransmit.

  • optimize_probablity (int) – A random probability that the connection should accelerate.

  • delayed_ack_data_packets (int) – The maximum number of data packets that should remain unacknowledged before the transmission of a delayed ACK is forced.

  • delayed_ack_data_internal_activate_at_bytes (int) – Prevents TCP Accelerator from delaying ACKs towards the internal side before a specified number of payload bytes has been delivered to the external side.

  • delayed_ack_data_external_activate_at_bytes (int) – Prevents TCP Accelerator from delaying ACKs towards the external side before a specified number of payload bytes has been delivered to the internal side.

  • delayed_ack_data_internal_delayed_sack_timeout (int) – The time delay (in milliseconds) by which TCP Accelerator sends SACKs toward the internal side.

  • delayed_ack_data_external_delayed_sack_timeout (int) – The time delay (in milliseconds) by which TCP Accelerator sends SACKs toward the external side.

  • delayed_ack_data_timeout (int) – The time before which TCP Accelerator sends delayed ACKs (in milliseconds).

  • criteria_require_sack_in_syn (bool) – Optimizes connections where the SYN packet has the TCP selective ACKs option.

  • criteria_require_sack_in_synack (bool) – Optimizes the connections where the SYNACK packet has the TCP selective acknowledgments option.

  • criteria_allow_fast_open (bool) – Controls the optimization of connections that uses TFO.

  • zero_window_interval (int) – The interval between zero-window probe transmissions.

  • clamp_advertised_window_by_cnwd (bool) – Advertises the window, which exceeds the congestion window of the other flow.

  • max_segments_per_half_stream (int) – The maximum number of segments queued in a half stream (upstream/downstream) of a connection.

  • min_initial_advertised_window_bytes (int) – The minimum initial window size in bytes that TCP Accelerator advertises in either direction at the start of the connection.

  • loss_probe_connection_timeout (int) – The maximum time spent probing for packet losses before the connection is reset (in milliseconds).

  • loss_probe_transmitted (int) – The number of loss probes transmitted before the back-off factor stops increasing.

  • loss_probe_max_backoff (int) – The maximum exponential back-off factor for the loss probes. This attribute defines the multiplication factor by which the loss probe interval should increase after each timeout.

  • loss_probe_target_payload_size (int) – The payload size (in bytes) in the loss probe.

  • max_burst_control_idle_quota (int) – The maximum number of bytes for burst control.

  • use_bbr_cc_algo (bool) – The congestion control algorithm used by the TCP accelerator. It enables the use of the Bottleneck Bandwidth and RTT (BBR) congestion control algorithm.

>>> obj = rs.add(AccelerateObject('myaccelerateobj'), internal_congestion_control_initial_cwnd = 15)