NWTcpMetadata.SetMaximumPacingRate(UInt64) Method

Definition

Namespace:: Network

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets the maximum pacing rate for TCP transmissions.

public int SetMaximumPacingRate(ulong maximumPacingRate);

member this.SetMaximumPacingRate : uint64 -> int

Parameters

maximumPacingRate: UInt64

The maximum pacing rate, in bytes per second.

Returns

Int32

Zero on success; otherwise, a POSIX error code.

Remarks

A value of 0 or ulong.MaxValue disables pacing. Values between 1 and 12,499 are clamped to 12,500. Each call replaces the previous pacing rate.

Applies to