[This documentation is preliminary and is subject to change.]
Represents bandwidth information for network data transfer using a StreamSocket, StreamWebSocket, or MessageWebSocket object.
Syntax
var bandwidthStatistics = { inboundBandwidthPeaked : /* Your value */, inboundBitsPerSecond : /* Your value */, inboundBitsPerSecondInstability : /* Your value */, outboundBandwidthPeaked : /* Your value */, outboundBitsPerSecond : /* Your value */, outboundBitsPerSecondInstability : /* Your value */ }
Attributes
- VersionAttribute(NTDDI_WIN8)
Members
The BandwidthStatistics structure has these fields.
| Field | Data type | Description |
|---|---|---|
| InboundBandwidthPeaked | inboundBandwidthPeaked |
Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++] |
A Boolean value that indicates whether the computed inbound bandwidth estimate for the network has peaked. This member is set to true when the app is using enough of the connection bandwidth that the system can get a good estimate of the bandwidth delay product and can determine that the congestion window is a substantial fraction of the bandwidth delay product. This member can change from true to false if the app sends less data. |
| InboundBitsPerSecond | inboundBitsPerSecond |
Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++] |
The computed inbound bandwidth estimate in bits per second. |
| InboundBitsPerSecondInstability | inboundBitsPerSecondInstability |
Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++] |
A measure of the instability of the inbound bandwidth estimate in bits per second. |
| OutboundBandwidthPeaked | outboundBandwidthPeaked |
Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++] |
A Boolean value that indicates whether the computed outbound bandwidth estimate for the network path has peaked. This member is set to true when the app is using enough of the connection bandwidth that the system can get a good estimate of the bandwidth delay product and can determine that the congestion window is a substantial fraction of the bandwidth delay product. This member can change from true to false if the app sends less data. |
| OutboundBitsPerSecond | outboundBitsPerSecond |
Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++] |
The computed outbound bandwidth estimate in bits per second. |
| OutboundBitsPerSecondInstability | outboundBitsPerSecondInstability |
Number [JavaScript] | System.UInt64 [.NET] | uint64 [C++] |
A measure of the instability of the outbound bandwidth estimate in bits per second. |
Requirements
|
Minimum supported client | Windows 8 Release Preview |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Namespace |
|
|
Metadata |
|
|
DLL |
|
See also
Build date: 5/22/2012
