package route

Import Path
	vendor/golang.org/x/net/route (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	      address.go
	      binary.go
	      interface.go
	      interface_classic.go
	      interface_multicast.go
	      message.go
	   #d route.go
		Package route provides basic functions for the manipulation of
		packet routing facilities on BSD variants.

		The package supports any version of Darwin, any version of
		DragonFly BSD, FreeBSD 7 and above, NetBSD 6 and above, and OpenBSD
		5.6 and above.

	      route_classic.go
	      sys.go
	      sys_darwin.go
	      syscall_go1_12_darwin.go
	      zsys_darwin.go
	      empty.s
Package-Level Type Names (total 20, in which 16 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Addr (interface)
		An Addr represents an address associated with packet routing.

		Methods (only one, which is exported)
			( T) Family() int
				Family returns an address family.

		Implemented By (at least 4, all are exported)
			*DefaultAddr
			*Inet4Addr
			*Inet6Addr
			*LinkAddr
		As Outputs Of (at least 6, none are exported)
			/* 6+ unexporteds ... *//* 6+ unexporteds: */
			func parseAddrs(attrs uint, fn func(int, []byte) (int, Addr, error), b []byte) ([]Addr, error)
			func parseDefaultAddr(b []byte) (Addr, error)
			func parseInetAddr(af int, b []byte) (Addr, error)
			func parseKernelInetAddr(af int, b []byte) (int, Addr, error)
			func parseKernelLinkAddr(_ int, b []byte) (int, Addr, error)
			func parseLinkAddr(b []byte) (Addr, error)
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func addrsSpace(as []Addr) int
			func marshalAddrs(b []byte, as []Addr) (uint, error)

	 type DefaultAddr (struct)
		A DefaultAddr represents an address of various operating
		system-specific features.

		Fields (total 2, in which 1 are exported)
			Raw []byte
				// raw format of address

			/* one unexported ... *//* one unexported: */
			af int
		Methods (total 3, in which 1 are exported)
			(*T) Family() int
				Family implements the Family method of Addr interface.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) lenAndSpace() (int, int)
			(*T) marshal(b []byte) (int, error)
		Implements (at least one exported)
			*T : Addr

	 type Inet4Addr (struct)
		An Inet4Addr represents an internet address for IPv4.

		Fields (only one, which is exported)
			IP [4]byte
				// IP address

		Methods (total 3, in which 1 are exported)
			(*T) Family() int
				Family implements the Family method of Addr interface.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) lenAndSpace() (int, int)
			(*T) marshal(b []byte) (int, error)
		Implements (at least one exported)
			*T : Addr

	 type Inet6Addr (struct)
		An Inet6Addr represents an internet address for IPv6.

		Fields (total 2, both are exported)
			IP [16]byte
				// IP address

			ZoneID int
				// zone identifier

		Methods (total 3, in which 1 are exported)
			(*T) Family() int
				Family implements the Family method of Addr interface.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) lenAndSpace() (int, int)
			(*T) marshal(b []byte) (int, error)
		Implements (at least one exported)
			*T : Addr

	 type InterfaceAddrMessage (struct)
		An InterfaceAddrMessage represents an interface address message.

		Fields (total 6, in which 5 are exported)
			Addrs []Addr
				// addresses

			Flags int
				// interface flags

			Index int
				// interface index

			Type int
				// message type

			Version int
				// message version

			/* one unexported ... *//* one unexported: */
			raw []byte
				// raw message

		Methods (only one, which is exported)
			(*T) Sys() []Sys
				Sys implements the Sys method of Message interface.

		Implements (at least one exported)
			*T : Message

	 type InterfaceAnnounceMessage (struct)
		An InterfaceAnnounceMessage represents an interface announcement
		message.

		Fields (total 6, in which 5 are exported)
			Index int
				// interface index

			Name string
				// interface name

			Type int
				// message type

			Version int
				// message version

			What int
				// what type of announcement

			/* one unexported ... *//* one unexported: */
			raw []byte
				// raw message

		Methods (only one, which is exported)
			(*T) Sys() []Sys
				Sys implements the Sys method of Message interface.

		Implements (at least one exported)
			*T : Message

	 type InterfaceMessage (struct)
		An InterfaceMessage represents an interface message.

		Fields (total 8, in which 6 are exported)
			Addrs []Addr
				// addresses

			Flags int
				// interface flags

			Index int
				// interface index

			Name string
				// interface name

			Type int
				// message type

			Version int
				// message version

			/* 2 unexporteds ... *//* 2 unexporteds: */
			extOff int
				// offset of header extension

			raw []byte
				// raw message

		Methods (only one, which is exported)
			(*T) Sys() []Sys
				Sys implements the Sys method of Message interface.

		Implements (at least one exported)
			*T : Message

	 type InterfaceMetrics (struct)
		InterfaceMetrics represents interface metrics.

		Fields (total 2, both are exported)
			MTU int
				// maximum transmission unit

			Type int
				// interface type

		Methods (only one, which is exported)
			(*T) SysType() SysType
				SysType implements the SysType method of Sys interface.

		Implements (at least one exported)
			*T : Sys

	 type InterfaceMulticastAddrMessage (struct)
		An InterfaceMulticastAddrMessage represents an interface multicast
		address message.

		Fields (total 6, in which 5 are exported)
			Addrs []Addr
				// addresses

			Flags int
				// interface flags

			Index int
				// interface index

			Type int
				// message type

			Version int
				// message version

			/* one unexported ... *//* one unexported: */
			raw []byte
				// raw message

		Methods (only one, which is exported)
			(*T) Sys() []Sys
				Sys implements the Sys method of Message interface.

		Implements (at least one exported)
			*T : Message

	 type LinkAddr (struct)
		A LinkAddr represents a link-layer address.

		Fields (total 3, all are exported)
			Addr []byte
				// link-layer address when attached

			Index int
				// interface index when attached

			Name string
				// interface name when attached

		Methods (total 3, in which 1 are exported)
			(*T) Family() int
				Family implements the Family method of Addr interface.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) lenAndSpace() (int, int)
			(*T) marshal(b []byte) (int, error)
		Implements (at least one exported)
			*T : Addr

	 type Message (interface)
		A Message represents a routing message.

		Methods (only one, which is exported)
			( T) Sys() []Sys
				Sys returns operating system-specific information.

		Implemented By (at least 5, all are exported)
			*InterfaceAddrMessage
			*InterfaceAnnounceMessage
			*InterfaceMessage
			*InterfaceMulticastAddrMessage
			*RouteMessage
		As Outputs Of (at least 2, in which 1 are exported)
			func ParseRIB(typ RIBType, b []byte) ([]Message, error)
			/* at least one unexported ... *//* at least one unexported: */
			func net.interfaceMessages(ifindex int) ([]Message, error)

	 type RIBType int (basic type)
		A RIBType represents a type of routing information base.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( T) parseable() bool
		As Inputs Of (at least 2, both are exported)
			func FetchRIB(af int, typ RIBType, arg int) ([]byte, error)
			func ParseRIB(typ RIBType, b []byte) ([]Message, error)
		As Types Of (total 2, both are exported)
			const RIBTypeInterface
			const RIBTypeRoute

	 type RouteMessage (struct)
		A RouteMessage represents a message conveying an address prefix, a
		nexthop address and an output interface.

		Unlike other messages, this message can be used to query adjacency
		information for the given address prefix, to add a new route, and
		to delete or modify the existing route from the routing information
		base inside the kernel by writing and reading route messages on a
		routing socket.

		For the manipulation of routing information, the route message must
		contain appropriate fields that include:

			Version       = <must be specified>
			Type          = <must be specified>
			Flags         = <must be specified>
			Index         = <must be specified if necessary>
			ID            = <must be specified>
			Seq           = <must be specified>
			Addrs         = <must be specified>

		The Type field specifies a type of manipulation, the Flags field
		specifies a class of target information and the Addrs field
		specifies target information like the following:

			route.RouteMessage{
				Version: RTM_VERSION,
				Type: RTM_GET,
				Flags: RTF_UP | RTF_HOST,
				ID: uintptr(os.Getpid()),
				Seq: 1,
				Addrs: []route.Addrs{
					RTAX_DST: &route.Inet4Addr{ ... },
					RTAX_IFP: &route.LinkAddr{ ... },
					RTAX_BRD: &route.Inet4Addr{ ... },
				},
			}

		The values for the above fields depend on the implementation of
		each operating system.

		The Err field on a response message contains an error value on the
		requested operation. If non-nil, the requested operation is failed.

		Fields (total 10, in which 8 are exported)
			Addrs []Addr
				// addresses

			Err error
				// error on requested operation

			Flags int
				// route flags

			ID uintptr
				// sender's identifier; usually process ID

			Index int
				// interface index when attached

			Seq int
				// sequence number

			Type int
				// message type

			Version int
				// message version

			/* 2 unexporteds ... *//* 2 unexporteds: */
			extOff int
				// offset of header extension

			raw []byte
				// raw message

		Methods (total 3, in which 2 are exported)
			(*T) Marshal() ([]byte, error)
				Marshal returns the binary encoding of m.

			(*T) Sys() []Sys
				Sys implements the Sys method of Message interface.

			/* one unexported ... *//* one unexported: */
			(*T) marshal() ([]byte, error)
		Implements (at least one exported)
			*T : Message

	 type RouteMetrics (struct)
		RouteMetrics represents route metrics.

		Fields (only one, which is exported)
			PathMTU int
				// path maximum transmission unit

		Methods (only one, which is exported)
			(*T) SysType() SysType
				SysType implements the SysType method of Sys interface.

		Implements (at least one exported)
			*T : Sys

	 type Sys (interface)
		A Sys reprensents operating system-specific information.

		Methods (only one, which is exported)
			( T) SysType() SysType
				SysType returns a type of operating system-specific
				information.

		Implemented By (at least 2, both are exported)
			*InterfaceMetrics
			*RouteMetrics
		As Outputs Of (at least 6, all are exported)
			func (*InterfaceAddrMessage).Sys() []Sys
			func (*InterfaceAnnounceMessage).Sys() []Sys
			func (*InterfaceMessage).Sys() []Sys
			func (*InterfaceMulticastAddrMessage).Sys() []Sys
			func Message.Sys() []Sys
			func (*RouteMessage).Sys() []Sys

	 type SysType int (basic type)
		A SysType represents a type of operating system-specific
		information.

		As Outputs Of (at least 3, all are exported)
			func (*InterfaceMetrics).SysType() SysType
			func (*RouteMetrics).SysType() SysType
			func Sys.SysType() SysType
		As Types Of (total 2, both are exported)
			const SysMetrics
			const SysStats

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type binaryBigEndian (struct)

		Methods (total 5, all are exported)
			( T) PutUint16(b []byte, v uint16)
			( T) PutUint32(b []byte, v uint32)
			( T) Uint16(b []byte) uint16
			( T) Uint32(b []byte) uint32
			( T) Uint64(b []byte) uint64
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 T : binaryByteOrder
			 T : vendor/golang.org/x/sys/cpu.byteOrder
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var bigEndian

	 type binaryByteOrder (interface)

		Methods (total 5, all are exported)
			( T) PutUint16([]byte, uint16)
			( T) PutUint32([]byte, uint32)
			( T) Uint16([]byte) uint16
			( T) Uint32([]byte) uint32
			( T) Uint64([]byte) uint64
		Implemented By (at least 5, in which 1 are exported)
			 encoding/binary.ByteOrder (interface)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			 binaryBigEndian
			 binaryLittleEndian
			 encoding/binary.bigEndian
			 encoding/binary.littleEndian
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 T : vendor/golang.org/x/sys/cpu.byteOrder
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var nativeEndian

	 type binaryLittleEndian (struct)

		Methods (total 5, all are exported)
			( T) PutUint16(b []byte, v uint16)
			( T) PutUint32(b []byte, v uint32)
			( T) Uint16(b []byte) uint16
			( T) Uint32(b []byte) uint32
			( T) Uint64(b []byte) uint64
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 T : binaryByteOrder
			 T : vendor/golang.org/x/sys/cpu.byteOrder
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var littleEndian

	 type wireFormat (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			bodyOff int
				// offset of message body

			extOff int
				// offset of header extension

			parse func(RIBType, []byte) (Message, error)
		Methods (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) parseInterfaceAddrMessage(_ RIBType, b []byte) (Message, error)
			(*T) parseInterfaceMessage(_ RIBType, b []byte) (Message, error)
			(*T) parseInterfaceMulticastAddrMessage(_ RIBType, b []byte) (Message, error)
			(*T) parseRouteMessage(typ RIBType, b []byte) (Message, error)
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func probeRoutingStack() (int, map[int]*wireFormat)


Package-Level Functions (total 14, in which 2 are exported)

	 func FetchRIB(af int, typ RIBType, arg int) ([]byte, error)
		FetchRIB fetches a routing information base from the operating
		system.

		The provided af must be an address family.

		The provided arg must be a RIBType-specific argument.
		When RIBType is related to routes, arg might be a set of route
		flags. When RIBType is related to network interfaces, arg might be
		an interface index or a set of interface flags. In most cases, zero
		means a wildcard.

	 func ParseRIB(typ RIBType, b []byte) ([]Message, error)
		ParseRIB parses b as a routing information base and returns a list
		of routing messages.

	/* 12 unexporteds ... *//* 12 unexporteds: */
	 func addrsSpace(as []Addr) int
	 func init()
	 func marshalAddrs(b []byte, as []Addr) (uint, error)
		marshalAddrs marshals as and returns a bitmap indicating which
		address is stored in b.

	 func parseAddrs(attrs uint, fn func(int, []byte) (int, Addr, error), b []byte) ([]Addr, error)
	 func parseDefaultAddr(b []byte) (Addr, error)
	 func parseInetAddr(af int, b []byte) (Addr, error)
		parseInetAddr parses b as an internet address for IPv4 or IPv6.

	 func parseKernelInetAddr(af int, b []byte) (int, Addr, error)
		parseKernelInetAddr parses b as an internet address in conventional
		BSD kernel form.

	 func parseKernelLinkAddr(_ int, b []byte) (int, Addr, error)
		parseKernelLinkAddr parses b as a link-layer address in
		conventional BSD kernel form.

	 func parseLinkAddr(b []byte) (Addr, error)
	 func probeRoutingStack() (int, map[int]*wireFormat)
	 func roundup(l int) int
	 func sysctl(mib []int32, old *byte, oldlen *uintptr, new *byte, newlen uintptr) error
Package-Level Variables (total 12, none are exported)

	/* 12 unexporteds ... *//* 12 unexporteds: */
	  var bigEndian binaryBigEndian
	  var errInvalidAddr error
	  var errInvalidMessage error
	  var errMessageMismatch error
	  var errMessageTooShort error
	  var errShortBuffer error
	  var errUnsupportedMessage error
	  var kernelAlign int
	  var littleEndian binaryLittleEndian
	  var nativeEndian binaryByteOrder
	  var rtmVersion byte
	  var wireFormats map[int]*wireFormat
Package-Level Constants (total 79, in which 4 are exported)

	const RIBTypeInterface RIBType = 3
	const RIBTypeRoute RIBType = 1
	const SysMetrics SysType = 0
	const SysStats SysType = 1
	/* 75 unexporteds ... *//* 75 unexporteds: */
	const sizeofIfaMsghdrDarwin15 = 20
	const sizeofIfData64Darwin15 = 128
	const sizeofIfDataDarwin15 = 96
	const sizeofIfmaMsghdr2Darwin15 = 20
	const sizeofIfmaMsghdrDarwin15 = 16
	const sizeofIfMsghdr2Darwin15 = 160
	const sizeofIfMsghdrDarwin15 = 112
	const sizeofRtMetricsDarwin15 = 56
	const sizeofRtMsghdr2Darwin15 = 92
	const sizeofRtMsghdrDarwin15 = 92
	const sizeofSockaddrInet = 16
	const sizeofSockaddrInet6 = 28
	const sizeofSockaddrStorage = 128
	const sysAF_INET = 2
	const sysAF_INET6 = 30
	const sysAF_LINK = 18
	const sysAF_ROUTE = 17
	const sysAF_UNSPEC = 0
	const sysCTL_DEBUG = 5
	const sysCTL_HW = 6
	const sysCTL_KERN = 1
	const sysCTL_MACHDEP = 7
	const sysCTL_MAXID = 9
	const sysCTL_MAXNAME = 12
	const sysCTL_NET = 4
	const sysCTL_UNSPEC = 0
	const sysCTL_USER = 8
	const sysCTL_VFS = 3
	const sysCTL_VM = 2
	const sysNET_RT_DUMP = 1
	const sysNET_RT_DUMP2 = 7
	const sysNET_RT_FLAGS = 2
	const sysNET_RT_IFLIST = 3
	const sysNET_RT_IFLIST2 = 6
	const sysNET_RT_MAXID = 10
	const sysNET_RT_STAT = 4
	const sysNET_RT_TRASH = 5
	const sysRTA_AUTHOR = 64
	const sysRTA_BRD = 128
	const sysRTA_DST = 1
	const sysRTA_GATEWAY = 2
	const sysRTA_GENMASK = 8
	const sysRTA_IFA = 32
	const sysRTA_IFP = 16
	const sysRTA_NETMASK = 4
	const sysRTAX_AUTHOR = 6
	const sysRTAX_BRD = 7
	const sysRTAX_DST = 0
	const sysRTAX_GATEWAY = 1
	const sysRTAX_GENMASK = 3
	const sysRTAX_IFA = 5
	const sysRTAX_IFP = 4
	const sysRTAX_MAX = 8
	const sysRTAX_NETMASK = 2
	const sysRTM_ADD = 1
	const sysRTM_CHANGE = 3
	const sysRTM_DELADDR = 13
	const sysRTM_DELETE = 2
	const sysRTM_DELMADDR = 16
	const sysRTM_GET = 4
	const sysRTM_GET2 = 20
	const sysRTM_IFINFO = 14
	const sysRTM_IFINFO2 = 18
	const sysRTM_LOCK = 8
	const sysRTM_LOSING = 5
	const sysRTM_MISS = 7
	const sysRTM_NEWADDR = 12
	const sysRTM_NEWMADDR = 15
	const sysRTM_NEWMADDR2 = 19
	const sysRTM_OLDADD = 9
	const sysRTM_OLDDEL = 10
	const sysRTM_REDIRECT = 6
	const sysRTM_RESOLVE = 11
	const sysRTM_VERSION = 5
	const sysSOCK_RAW = 3

The pages are generated with Golds v0.4.2. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.