package tcpopt

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

Dependency Relation
	imports 6 packages, and imported by 2 packages

Involved Source Files

	  d doc.go
		Package tcpopt implements encoding and decoding of TCP-level socket
		options.

	    option.go
	    parse.go
	    sys.go
	    sys_linux.go
	    sys_unix.go
	    zsys_linux_generic.go
Code Examples

	Option
		package main
		
		import (
			"log"
			"net"
			"time"
		
			"github.com/mikioh/tcp"
			"github.com/mikioh/tcpopt"
		)
		
		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)
			}
			if err := tc.SetOption(tcpopt.KeepAlive(true)); err != nil {
				log.Fatal(err)
			}
			if err := tc.SetOption(tcpopt.KeepAliveIdleInterval(3 * time.Minute)); err != nil {
				log.Fatal(err)
			}
			if err := tc.SetOption(tcpopt.KeepAliveProbeInterval(30 * time.Second)); err != nil {
				log.Fatal(err)
			}
			if err := tc.SetOption(tcpopt.KeepAliveProbeCount(3)); err != nil {
				log.Fatal(err)
			}
		}


Package-Level Type Names (total 13)

	/* sort by: alphabet | popularity */
	 type Cork bool (basic type)
		Cork specifies the use of TCP_CORK or TCP_NOPUSH option.
		
		On DragonFly BSD, the caller may need to adjust the
		net.inet.tcp.disable_nopush kernel state.
		NetBSD and Windows don't support this option.

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

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

			( Cork) Name() int
				Name implements the Name method of Option interface.

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

	 type ECN bool (basic type)
		ECN specifies the use of ECN.
		
		Only Darwin supports this option.

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

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

			( ECN) Name() int
				Name implements the Name method of Option interface.

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

	 type Error int (basic type)
		Error represents an error on the socket.

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

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

			( Error) Name() int
				Name implements the Name method of Option interface.

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

	 type KeepAlive bool (basic type)
		KeepAlive specifies the use of keep alive.

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

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

			( KeepAlive) Name() int
				Name implements the Name method of Option interface.

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

	 type KeepAliveIdleInterval time.Duration (basic type)
		KeepAliveIdleInterval is the idle interval until the first probe is
		sent.
		
		OpenBSD doesn't support this option.
		See TCP_KEEPIDLE or TCP_KEEPALIVE for further information.

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

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

			( KeepAliveIdleInterval) Name() int
				Name implements the Name method of Option interface.

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

	 type KeepAliveProbeCount int (basic type)
		KeepAliveProbeCount is the number of keepalive probes should be
		repeated when the peer is not responding.
		
		OpenBSD and Windows don't support this option.
		See TCP_KEEPCNT for further information.

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

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

			( KeepAliveProbeCount) Name() int
				Name implements the Name method of Option interface.

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

	 type KeepAliveProbeInterval time.Duration (basic type)
		KeepAliveProbeInterval is the interval between keepalive probes.
		
		OpenBSD doesn't support this option.
		See TCP_KEEPINTVL for further information.

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

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

			( KeepAliveProbeInterval) Name() int
				Name implements the Name method of Option interface.

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

	 type MSS int (basic type)
		MSS specifies the maximum segment size.

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

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

			( MSS) Name() int
				Name implements the Name method of Option interface.

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

	 type NoDelay bool (basic type)
		NoDelay specifies the use of Nagle's algorithm.

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

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

			( NoDelay) Name() int
				Name implements the Name method of Option interface.

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

	 type NotSentLowWMK int (basic type)
		NotSentLowWMK specifies the amount of unsent bytes in transmission
		queue. The network poller such as kqueue or epoll doesn't report
		that the connection is writable while the amount of unsent data
		size is greater than NotSentLowWMK.
		
		Only Darwin and Linux support this option.
		See TCP_NOTSENT_LOWAT for further information.

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

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

			( NotSentLowWMK) Name() int
				Name implements the Name method of Option interface.

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

	 type Option (interface)
		An Option represents a socket option.

		Methods (total 3)
			( Option) Level() int
				Level returns the platform-specific socket option level.

			( Option) Marshal() ([]byte, error)
				Marshal returns the binary encoding of socket option.

			( Option) Name() int
				Name returns the platform-specific socket option name.

		Implemented By (at least 15)
			 Cork
			 ECN
			 Error
			 KeepAlive
			 KeepAliveIdleInterval
			 KeepAliveProbeCount
			 KeepAliveProbeInterval
			 MSS
			 NoDelay
			 NotSentLowWMK
			 ReceiveBuffer
			 SendBuffer
			 github.com/mikioh/tcpinfo.CCAlgorithm
			*github.com/mikioh/tcpinfo.CCInfo
			*github.com/mikioh/tcpinfo.Info
		Implements (at least 2)
			 Option : github.com/gogo/protobuf/proto.Marshaler
			 Option : github.com/golang/protobuf/proto.Marshaler
		As Outputs Of (at least 2)
			func Parse(level, name int, b []byte) (Option, error)
			func github.com/marten-seemann/tcp.(*Conn).Option(level, name int, b []byte) (Option, error)
		As Inputs Of (at least one exported)
			func github.com/marten-seemann/tcp.(*Conn).SetOption(o Option) error

	 type ReceiveBuffer int (basic type)
		ReceiveBuffer specifies the size of receive buffer.

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

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

			( ReceiveBuffer) Name() int
				Name implements the Name method of Option interface.

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

	 type SendBuffer int (basic type)
		SendBuffer specifies the size of send buffer.

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

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

			( SendBuffer) Name() int
				Name implements the Name method of Option interface.

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


Package-Level Functions (total 3)

	 func Parse(level, name int, b []byte) (Option, error)
		Parse parses a socket option.

	 func Register(level, name int, fn func([]byte) (Option, error))
		Register registers a socket option parser.

	 func Unregister(level, name int)
		Unregister unregisters a socket option parser.

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.