NL_BANDWIDTH_INFORMATION structure (nldef.h)

The NL_BANDWIDTH_INFORMATION structure contains read-only information on the available bandwidth estimates and associated variance as determined by the TCP/IP stack.

Syntax

typedef struct _NL_BANDWIDTH_INFORMATION {
  ULONG64 Bandwidth;
  ULONG64 Instability;
  BOOLEAN BandwidthPeaked;
} NL_BANDWIDTH_INFORMATION, *PNL_BANDWIDTH_INFORMATION;

Members

Bandwidth

The estimated maximum available bandwidth, in bits per second.

Instability

A measure of the variation based on recent bandwidth samples, in bits per second.

BandwidthPeaked

A value that indicates if the bandwidth estimate in the Bandwidth member has peaked and reached its maximum value for the given network conditions.

The TCP/IP stack uses a heuristic to set this variable. Until this variable is set, there is no guarantee that the true available maximum bandwidth is not higher than the estimated bandwidth in the Bandwidth member. However, it is safe to assume that maximum available bandwidth is not lower than the estimate reported in the Bandwidth member.

Remarks

The NL_BANDWIDTH_INFORMATION structure is defined in the Nldef.h header file which is automatically included by the Iptypes.h header file which is automatically included in the Iphlpapi.h header file. The Nldef.h and Iptypes.h header files should never be used directly.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Header nldef.h (include Iphlpapi.h)

See also

GetIpNetworkConnectionBandwidthEstimates

GetPerTcp6ConnectionEStats

GetPerTcpConnectionEStats

MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES

TCP_ESTATS_BANDWIDTH_ROD_v0