Skip to content

Latest commit

 

History

History
111 lines (75 loc) · 5.86 KB

ns-tcpestats-tcp_estats_bandwidth_rw_v0.md

File metadata and controls

111 lines (75 loc) · 5.86 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:tcpestats._TCP_ESTATS_BANDWIDTH_RW_v0
TCP_ESTATS_BANDWIDTH_RW_v0 (tcpestats.h)
Contains read/write configuration information for extended TCP statistics on bandwidth estimation for a TCP connection.
*PTCP_ESTATS_BANDWIDTH_RW_v0
PTCP_ESTATS_BANDWIDTH_RW_v0
PTCP_ESTATS_BANDWIDTH_RW_v0 structure pointer [IP Helper]
TCP_ESTATS_BANDWIDTH_RW_v0
TCP_ESTATS_BANDWIDTH_RW_v0 structure [IP Helper]
iphlp.tcp_estats_bandwidth_rw_v0
tcpestats/PTCP_ESTATS_BANDWIDTH_RW_v0
tcpestats/TCP_ESTATS_BANDWIDTH_RW_v0
iphlp\tcp_estats_bandwidth_rw_v0.htm
IpHlp
a9bf5ad3-a8db-4194-8e47-5a7409391f4c
12/05/2018
*PTCP_ESTATS_BANDWIDTH_RW_v0, PTCP_ESTATS_BANDWIDTH_RW_v0, PTCP_ESTATS_BANDWIDTH_RW_v0 structure pointer [IP Helper], TCP_ESTATS_BANDWIDTH_RW_v0, TCP_ESTATS_BANDWIDTH_RW_v0 structure [IP Helper], iphlp.tcp_estats_bandwidth_rw_v0, tcpestats/PTCP_ESTATS_BANDWIDTH_RW_v0, tcpestats/TCP_ESTATS_BANDWIDTH_RW_v0
tcpestats.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Windows
TCP_ESTATS_BANDWIDTH_RW_v0, *PTCP_ESTATS_BANDWIDTH_RW_v0
19H1
_TCP_ESTATS_BANDWIDTH_RW_v0
tcpestats/_TCP_ESTATS_BANDWIDTH_RW_v0
PTCP_ESTATS_BANDWIDTH_RW_v0
tcpestats/PTCP_ESTATS_BANDWIDTH_RW_v0
TCP_ESTATS_BANDWIDTH_RW_v0
tcpestats/TCP_ESTATS_BANDWIDTH_RW_v0
c++
APIRef
kbSyntax
HeaderDef
Tcpestats.h
TCP_ESTATS_BANDWIDTH_RW_v0

TCP_ESTATS_BANDWIDTH_RW_v0 structure

-description

The TCP_ESTATS_BANDWIDTH_RW_v0 structure contains read/write configuration information for extended TCP statistics on bandwidth estimation for a TCP connection.

-struct-fields

-field EnableCollectionOutbound

A value that indicates if extended statistics on a TCP connection should be collected for outbound bandwidth estimation.

If this member is set to TcpBoolOptEnabled, extended statistics on the TCP connection for outbound bandwidth estimation are enabled. If this member is set to TcpBoolOptDisabled, extended statistics on the TCP connection for outbound bandwidth estimation are disabled. If this member is set to TcpBoolOptUnchanged, extended statistics on the TCP connection for outbound bandwidth estimation are left unchanged.

The default state for this member when not set is disabled.

-field EnableCollectionInbound

A value that indicates if extended statistics on a TCP connection should be collected for inbound bandwidth estimation.

If this member is set to TcpBoolOptEnabled, extended statistics on the TCP connection for inbound bandwidth estimation are enabled. If this member is set to TcpBoolOptDisabled, extended statistics on the TCP connection for inbound bandwidth estimation are disabled. If this member is set to TcpBoolOptUnchanged, extended statistics on the TCP connection for inbound bandwidth estimation are unchanged.

The default state for this member when not set is disabled.

-remarks

The TCP_ESTATS_BANDWIDTH_RW_v0 structure is used as part of the TCP extended statistics feature available on Windows Vista and later.

The TCP_ESTATS_BANDWIDTH_RW_v0 is defined as version 0 of the structure for read/write configuration information on bandwidth estimation for a TCP connection.

Extended TCP statistics on bandwidth estimation for a TCP connection are enabled and disabled using this structure and the SetPerTcp6ConnectionEStats and SetPerTcpConnectionEStats functions when TcpConnectionEstatsBandwidth is passed in the EstatsType parameter.

The Offset parameter passed to the SetPerTcp6ConnectionEStats and SetPerTcpConnectionEStats functions is currently unused and must be set to 0. Consequently, the TCP_ESTATS_BANDWIDTH_RW_v0 structure pointed to by the Rw parameter when the EstatsType parameter is set to TcpConnectionEstatsBandwidth must have both the EnableCollectionOutbound and EnableCollectionInbound structure members set to the preferred values in a single call to the SetPerTcp6ConnectionEStats and SetPerTcpConnectionEStats functions.

The TCP_ESTATS_BANDWIDTH_RW_v0 structure is retrieved by calls to the GetPerTcp6ConnectionEStats or GetPerTcpConnectionEStats functions when TcpConnectionEstatsBandwidth is passed in the EstatsType parameter.

-see-also

GetPerTcp6ConnectionEStats

GetPerTcpConnectionEStats

SetPerTcp6ConnectionEStats

SetPerTcpConnectionEStats

TCP_BOOLEAN_OPTIONAL

TCP_ESTATS_TYPE