package tcpinfo

Import Path
	github.com/mikioh/tcpinfo (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	  d doc.go
		Package tcpinfo implements encoding and decoding of TCP-level
		socket options regarding connection information.
		
		The Transmission Control Protocol (TCP) is defined in RFC 793.
		TCP Selective Acknowledgment Options is defined in RFC 2018.
		Management Information Base for the Transmission Control Protocol
		(TCP) is defined in RFC 4022.
		TCP Congestion Control is defined in RFC 5681.
		Computing TCP's Retransmission Timer is described in RFC 6298.
		TCP Options and Maximum Segment Size (MSS) is defined in RFC 6691.
		Shared Use of Experimental TCP Options is defined in RFC 6994.
		TCP Extensions for High Performance is defined in RFC 7323.
		
		NOTE: Older Linux kernels may not support extended TCP statistics
		described in RFC 4898.

	    option.go
	    sys.go
	    sys_linux.go
	    tcp.go
	    zsys_2_6_10_linux.go
	    zsys_3_19_linux.go
	    zsys_linux.go
Code Examples

	Info
		package main
		
		import (
			"encoding/json"
			"fmt"
			"log"
			"net"
		
			"github.com/mikioh/tcp"
			"github.com/mikioh/tcpinfo"
		)
		
		func main() {
			c, err := net.Dial("tcp", "golang.org:80")
			if err != nil {
				log.Fatal(err)
			}
			defer c.Close()
		
			tc, err := tcp.NewConn(c)
			if err != nil {
				log.Fatal(err)
			}
			var o tcpinfo.Info
			var b [256]byte
			i, err := tc.Option(o.Level(), o.Name(), b[:])
			if err != nil {
				log.Fatal(err)
			}
			txt, err := json.Marshal(i)
			if err != nil {
				log.Fatal(err)
			}
			fmt.Println(string(txt))
		}


Package-Level Type Names (total 19)

	/* sort by: alphabet | popularity */
	 type BBRInfo (struct)
		A BBRInfo represents Bottleneck Bandwidth and Round-trip
		propagation time-based congestion control information.

		Fields (total 4)
			CongWindowGain uint
				// congestion window gain shifted left 8 bits

			MaxBW uint64
				// maximum-filtered bandwidth in bps

			MinRTT time.Duration
				// minimum-filtered round-trip time

			PacingGain uint
				// pacing gain shifted left 8 bits

		Methods (only one)
			(*BBRInfo) Algorithm() string
				Algorithm implements the Algorithm method of CCAlgorithmInfo
				interface.

		Implements (at least one exported)
			*BBRInfo : CCAlgorithmInfo

	 type CAState int (basic type)
		A CAState represents a state of congestion avoidance.

		Methods (only one)
			( CAState) String() string
		Implements (at least 2)
			 CAState : expvar.Var
			 CAState : fmt.Stringer
		As Types Of (total 5)
			const CACWR
			const CADisorder
			const CALoss
			const CAOpen
			const CARecovery

	 type CCAlgorithm string (basic type)
		A CCAlgorithm represents a name of congestion control algorithm.
		
		Only supported on Linux.

		Methods (total 3)
			( CCAlgorithm) Level() int
				Level implements the Level method of tcpopt.Option interface.

			( CCAlgorithm) Marshal() ([]byte, error)
				Marshal implements the Marshal method of tcpopt.Option interface.

			( CCAlgorithm) Name() int
				Name implements the Name method of tcpopt.Option interface.

		Implements (at least 3)
			 CCAlgorithm : github.com/mikioh/tcpopt.Option
			 CCAlgorithm : github.com/gogo/protobuf/proto.Marshaler
			 CCAlgorithm : github.com/golang/protobuf/proto.Marshaler

	 type CCAlgorithmInfo (interface)
		A CCAlgorithmInfo represents congestion control algorithm
		information.
		
		Only supported on Linux.

		Methods (only one)
			( CCAlgorithmInfo) Algorithm() string
		Implemented By (at least 3)
			*BBRInfo
			*DCTCPInfo
			*VegasInfo
		As Outputs Of (at least one exported)
			func ParseCCAlgorithmInfo(name string, b []byte) (CCAlgorithmInfo, error)

	 type CCInfo (struct)
		A CCInfo represents raw information of congestion control
		algorithm.
		
		Only supported on Linux.

		Fields (only one)
			Raw []byte
		Methods (total 3)
			(*CCInfo) Level() int
				Level implements the Level method of tcpopt.Option interface.

			(*CCInfo) Marshal() ([]byte, error)
				Marshal implements the Marshal method of tcpopt.Option interface.

			(*CCInfo) Name() int
				Name implements the Name method of tcpopt.Option interface.

		Implements (at least 3)
			*CCInfo : github.com/mikioh/tcpopt.Option
			*CCInfo : github.com/gogo/protobuf/proto.Marshaler
			*CCInfo : github.com/golang/protobuf/proto.Marshaler

	 type CEState int (basic type)
		A CEState represents a state of ECN congestion encountered (CE)
		codepoint.

	 type CongestionControl (struct)
		A CongestionControl represents congestion control information.

		Fields (total 4)
			ReceiverSSThreshold uint
				// slow start threshold for receiver in bytes [Linux only]

			SenderSSThreshold uint
				// slow start threshold for sender in bytes or # of segments

			SenderWindowBytes uint
				// congestion window for sender in bytes [Darwin and FreeBSD]

			SenderWindowSegs uint
				// congestion window for sender in # of segments [Linux and NetBSD]


	 type DCTCPInfo (struct)
		A DCTCPInfo represents Datacenter TCP congestion control
		information.

		Fields (total 5)
			Alpha uint
				// fraction of bytes sent

			CEState CEState
				// state of ECN CE codepoint

			ECNAckedBytes uint
				// # of acked bytes with ECN

			Enabled bool
			TotalAckedBytes uint
				// total # of acked bytes

		Methods (only one)
			(*DCTCPInfo) Algorithm() string
				Algorithm implements the Algorithm method of CCAlgorithmInfo
				interface.

		Implements (at least one exported)
			*DCTCPInfo : CCAlgorithmInfo

	 type FlowControl (struct)
		A FlowControl represents flow control information.

		Fields (only one)
			ReceiverWindow uint
				// advertised receiver window in bytes


	 type Info (struct)
		An Info represents connection information.
		
		Only supported on Darwin, FreeBSD, Linux and NetBSD.

		Fields (total 15)
			ATO time.Duration
				// delayed acknowledgement timeout [Linux only]

			CongestionControl *CongestionControl
				// congestion control information

			FlowControl *FlowControl
				// flow control information

			LastAckReceived time.Duration
				// since last ack received [Linux only]

			LastDataReceived time.Duration
				// since last data received [FreeBSD and Linux]

			LastDataSent time.Duration
				// since last data sent [Linux only]

			Options []Option
				// requesting options

			PeerOptions []Option
				// options requested from peer

			RTO time.Duration
				// retransmission timeout

			RTT time.Duration
				// round-trip time

			RTTVar time.Duration
				// round-trip time variation

			ReceiverMSS MaxSegSize
				// maximum segment size for receiver in bytes

			SenderMSS MaxSegSize
				// maximum segment size for sender in bytes

			State State
				// connection state

			Sys *SysInfo
				// platform-specific information

		Methods (total 4)
			(*Info) Level() int
				Level implements the Level method of tcpopt.Option interface.

			(*Info) Marshal() ([]byte, error)
				Marshal implements the Marshal method of tcpopt.Option interface.

			(*Info) MarshalJSON() ([]byte, error)
				MarshalJSON implements the MarshalJSON method of json.Marshaler
				interface.

			(*Info) Name() int
				Name implements the Name method of tcpopt.Option interface.

		Implements (at least 5)
			*Info : github.com/mikioh/tcpopt.Option
			*Info : github.com/goccy/go-json.Marshaler
			*Info : github.com/gogo/protobuf/proto.Marshaler
			*Info : github.com/golang/protobuf/proto.Marshaler
			*Info : encoding/json.Marshaler

	 type MaxSegSize uint (basic type)
		A MaxSegSize represents a maxiumum segment size option.

		Methods (only one)
			( MaxSegSize) Kind() OptionKind
				Kind returns an option kind field.

		Implements (at least one exported)
			 MaxSegSize : Option

	 type Option (interface)
		An Option represents an option.

		Methods (only one)
			( Option) Kind() OptionKind
		Implemented By (at least 4)
			 MaxSegSize
			 SACKPermitted
			 Timestamps
			 WindowScale

	 type OptionKind int (basic type)
		An OptionKind represents an option kind.

		Methods (only one)
			( OptionKind) String() string
		Implements (at least 2)
			 OptionKind : expvar.Var
			 OptionKind : fmt.Stringer
		As Outputs Of (at least 5)
			func MaxSegSize.Kind() OptionKind
			func Option.Kind() OptionKind
			func SACKPermitted.Kind() OptionKind
			func Timestamps.Kind() OptionKind
			func WindowScale.Kind() OptionKind
		As Types Of (total 4)
			const KindMaxSegSize
			const KindSACKPermitted
			const KindTimestamps
			const KindWindowScale

	 type SACKPermitted bool (basic type)
		A SACKPermitted reports whether a selective acknowledgment
		permitted option is enabled.

		Methods (only one)
			( SACKPermitted) Kind() OptionKind
				Kind returns an option kind field.

		Implements (at least one exported)
			 SACKPermitted : Option

	 type State int (basic type)
		A State represents a state of connection.

		Methods (only one)
			( State) String() string
		Implements (at least 2)
			 State : expvar.Var
			 State : fmt.Stringer
		As Types Of (total 12)
			const Closed
			const CloseWait
			const Closing
			const Established
			const FinWait1
			const FinWait2
			const LastAck
			const Listen
			const SynReceived
			const SynSent
			const TimeWait
			const Unknown

	 type SysInfo (struct)
		A SysInfo represents platform-specific information.

		Fields (total 23)
			AdvertisedMSS MaxSegSize
				// advertised maximum segment size

			Backoffs uint
				// # of times retransmission backoff timer invoked

			CAState CAState
				// state of congestion avoidance

			DataSegsIn uint
				// # of segments received containing a positive length data segment

			DataSegsOut uint
				// # of segments sent containing a positive length data segment

			ForwardAckSegs uint
				// # of forward ack segments in transmission queue

			LostSegs uint
				// # of lost segments

			MinRTT time.Duration
				// current measured minimum RTT; zero means not available

			NotSentBytes uint
				// # of bytes not sent yet

			PacingRate uint64
				// pacing rate

			PathMTU uint
				// path maximum transmission unit

			ReceiverRTT time.Duration
				// current RTT for receiver

			ReorderedSegs uint
				// # of reordered segments allowed

			RetransSegs uint
				// # of retransmitting segments in transmission queue

			Retransmissions uint
				// # of retranmissions on timeout invoked

			SackedSegs uint
				// # of sack'd segments

			SegsIn uint
				// # of segments received

			SegsOut uint
				// # of segments sent

			ThruBytesAcked uint64
				// # of bytes for which cumulative acknowledgments have been received

			ThruBytesReceived uint64
				// # of bytes for which cumulative acknowledgments have been sent

			TotalRetransSegs uint
				// # of retransmitted segments

			UnackedSegs uint
				// # of unack'd segments

			WindowOrKeepAliveProbes uint
				// # of window or keep alive probes sent


	 type Timestamps bool (basic type)
		A Timestamps reports whether a timestamps option is enabled.

		Methods (only one)
			( Timestamps) Kind() OptionKind
				Kind returns an option kind field.

		Implements (at least one exported)
			 Timestamps : Option

	 type VegasInfo (struct)
		A VegasInfo represents Vegas congestion control information.

		Fields (total 4)
			Enabled bool
			MinRTT time.Duration
				// minimum round-trip time

			RTT time.Duration
				// round-trip time

			RoundTrips uint
				// # of round-trips

		Methods (only one)
			(*VegasInfo) Algorithm() string
				Algorithm implements the Algorithm method of CCAlgorithmInfo
				interface.

		Implements (at least one exported)
			*VegasInfo : CCAlgorithmInfo

	 type WindowScale int (basic type)
		A WindowScale represents a windows scale option.

		Methods (only one)
			( WindowScale) Kind() OptionKind
				Kind returns an option kind field.

		Implements (at least one exported)
			 WindowScale : Option


Package-Level Functions (only one)

	 func ParseCCAlgorithmInfo(name string, b []byte) (CCAlgorithmInfo, error)
		ParseCCAlgorithmInfo parses congestion control algorithm
		information.
		
		Only supported on Linux.


Package-Level Constants (total 21)

	const CACWR CAState = 2
	const CADisorder CAState = 1
	const CALoss CAState = 4
	const CAOpen CAState = 0
	const CARecovery CAState = 3
	const Closed State = 1
	const CloseWait State = 8
	const Closing State = 10
	const Established State = 5
	const FinWait1 State = 6
	const FinWait2 State = 7
	const KindMaxSegSize OptionKind = 2
	const KindSACKPermitted OptionKind = 4
	const KindTimestamps OptionKind = 8
	const KindWindowScale OptionKind = 3
	const LastAck State = 9
	const Listen State = 2
	const SynReceived State = 4
	const SynSent State = 3
	const TimeWait State = 11
	const Unknown State = 0

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.