docs: improve doc comments for the ConnectionState fields (#3901)

This commit is contained in:
Marten Seemann
2023-06-15 10:03:36 +03:00
committed by GitHub
parent 30527c58c2
commit 85764da3b6

View File

@@ -336,7 +336,13 @@ type ClientHelloInfo struct {
// ConnectionState records basic details about a QUIC connection
type ConnectionState struct {
TLS handshake.ConnectionState
// TLS contains information about the TLS connection state, incl. the tls.ConnectionState.
TLS handshake.ConnectionState
// SupportsDatagrams says if support for QUIC datagrams (RFC 9221) was negotiated.
// This requires both nodes to support and enable the datagram extensions (via Config.EnableDatagrams).
// If datagram support was negotiated, datagrams can be sent and received using the
// SendMessage and ReceiveMessage methods on the Connection.
SupportsDatagrams bool
Version VersionNumber
// Version is the QUIC version of the QUIC connection.
Version VersionNumber
}