Share via

TCP_ESTATS_BANDWIDTH_RW_v0 (Compact 2013)

  • Article

3/26/2014

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

Syntax

typedef struct _TCP_ESTATS_BANDWIDTH_RW_v0 {
  TCP_BOOLEAN_OPTIONAL EnableCollectionOutbound;
  TCP_BOOLEAN_OPTIONAL EnableCollectionInbound;
} TCP_ESTATS_BANDWIDTH_RW_v0,
  *PTCP_ESTATS_BANDWIDTH_RW_v0;

Members

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

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

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

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

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

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

Remarks

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 by using this structure and the SetPerTcp6ConnectionEStats and SetPerTcpConnectionEStats functions when TcpConnectionEstatsBandwidth is passed in the EstatsType parameter.

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

Reference

IP Helper Structures
GetPerTcp6ConnectionEStats
GetPerTcpConnectionEStats
SetPerTcp6ConnectionEStats
SetPerTcpConnectionEStats
TCP_BOOLEAN_OPTIONAL
TCP_ESTATS_TYPE