Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModifyTransferOptions

Hierarchy

  • ModifyTransferOptions

Index

Properties

Properties

Optional lock_min_rate

lock_min_rate: boolean
deprecated

Use lock_min_rate_kbps instead.

Optional lock_min_rate_kbps

lock_min_rate_kbps: boolean

If true, lock the minimum transfer rate to the value set for min_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

Optional lock_rate_policy

lock_rate_policy: boolean

Lock the rate policy to the value set for rate_policy.

Optional lock_target_rate

lock_target_rate: boolean
deprecated

Use lock_target_rate_kbps instead.

Optional lock_target_rate_kbps

lock_target_rate_kbps: boolean

If true, lock the target transfer rate to the default value set for target_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

Optional min_rate_kbps

min_rate_kbps: number

Optional rate_policy

rate_policy: "fixed" | "fair" | "high" | "low"

The congestion control behavior to use when sharing bandwidth.

  • fixed - Transfer at the target rate regardless of actual network capacity. Do not share bandwidth. Not recommended.
  • high - When sharing bandwidth, transfer at twice the rate of a transfer using "fair" policy.
  • fair - Share bandwidth equally with other traffic.
  • low - Use only unutilized bandwidth.

Optional target_rate_cap_kbps

target_rate_cap_kbps: number

Maximum target rate for incoming transfers, in kilobits per second.

Optional target_rate_kbps

target_rate_kbps: number

Ideal transfer rate, in kilobits per second.