TCP_ESTATS_TYPE enumeration (tcpestats.h)

Article
03/13/2023

The TCP_ESTATS_TYPE enumeration defines the type of extended statistics for a TCP connection that is requested or being set.

Syntax

typedef enum {
  TcpConnectionEstatsSynOpts,
  TcpConnectionEstatsData,
  TcpConnectionEstatsSndCong,
  TcpConnectionEstatsPath,
  TcpConnectionEstatsSendBuff,
  TcpConnectionEstatsRec,
  TcpConnectionEstatsObsRec,
  TcpConnectionEstatsBandwidth,
  TcpConnectionEstatsFineRtt,
  TcpConnectionEstatsMaximum
} TCP_ESTATS_TYPE, *PTCP_ESTATS_TYPE;

Constants


`TcpConnectionEstatsSynOpts` This value specifies SYN exchange information for a TCP connection. Only read-only static information is available for this enumeration value.
`TcpConnectionEstatsData` This value specifies extended data transfer information for a TCP connection. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsSndCong` This value specifies sender congestion for a TCP connection. All three types of information (read-only static, read-only dynamic, and read/write information) are available for this enumeration value.
`TcpConnectionEstatsPath` This value specifies extended path measurement information for a TCP connection. This information is used to infer segment reordering on the path from the local sender to the remote receiver. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsSendBuff` This value specifies extended output-queuing information for a TCP connection. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsRec` This value specifies extended local-receiver information for a TCP connection. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsObsRec` This value specifies extended remote-receiver information for a TCP connection. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsBandwidth` This value specifies bandwidth estimation statistics for a TCP connection on bandwidth. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsFineRtt` This value specifies fine-grained round-trip time (RTT) estimation statistics for a TCP connection. Only read-only dynamic information and read/write information are available for this enumeration value.
`TcpConnectionEstatsMaximum` The maximum possible value for the TCP_ESTATS_TYPE_STATE enumeration type. This is not a legal value for the possible type of extended statistics for a TCP connection.

Remarks

The TCP_ESTATS_TYPE enumeration is defined on Windows Vista and later.

The GetPerTcp6ConnectionEStats and GetPerTcp6ConnectionEStats functions are designed to use TCP to diagnose performance problems in both the network and the application. If a network based application is performing poorly, TCP can determine if the bottleneck is in the sender, the receiver or the network itself. If the bottleneck is in the network, TCP can provide specific information about its nature.

The GetPerTcp6ConnectionEStats and GetPerTcp6ConnectionEStats functions are used to retrieve extended statistics for a TCP connection based on the type of extended statistics specified using one of values from the TCP_ESTATS_TYPE enumeration type. The collection of extended statistics on a TCP connection are enabled and disabled using calls to the SetPerTcp6ConnectionEStats and SetPerTcpConnectionEStats functions where the type of extended statistics specified is one of values from the TCP_ESTATS_TYPE enumeration type.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	tcpestats.h

TCP_ESTATS_TYPE enumeration (tcpestats.h)

Syntax

Constants

Remarks

Requirements

See also

Feedback

Feedback

Additional resources