package route

Import Path
	vendor/golang.org/x/net/route (on golang.org and 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
	    route_classic.go
	    sys.go
	    sys_darwin.go
	    syscall_go1_12_darwin.go
	    zsys_darwin.go
	    empty.s

Exported Type Names

	 type Addr (interface)
		An Addr represents an address associated with packet routing.

		One Exported Method
			 (T) Family() int
		Implemented By (4+)
			*DefaultAddr
			*Inet4Addr
			*Inet6Addr
			*LinkAddr
	 type DefaultAddr (struct)
		A DefaultAddr represents an address of various operating
		system-specific features.

		One Exported Field
			Raw []byte
		One Exported Method
			(*T) Family() int
		Implements (1+)
			*T : Addr
	 type Inet4Addr (struct)
		An Inet4Addr represents an internet address for IPv4.

		One Exported Field
			IP [4]byte
		One Exported Method
			(*T) Family() int
		Implements (1+)
			*T : Addr
	 type Inet6Addr (struct)
		An Inet6Addr represents an internet address for IPv6.

		Exported Fields (2)
			IP [16]byte
			ZoneID int
		One Exported Method
			(*T) Family() int
		Implements (1+)
			*T : Addr
	 type InterfaceAddrMessage (struct)
		An InterfaceAddrMessage represents an interface address message.

		Exported Fields (5)
			Addrs []Addr
			Flags int
			Index int
			Type int
			Version int
		One Exported Method
			(*T) Sys() []Sys
		Implements (1+)
			*T : Message
	 type InterfaceAnnounceMessage (struct)
		An InterfaceAnnounceMessage represents an interface announcement
		message.

		Exported Fields (5)
			Index int
			Name string
			Type int
			Version int
			What int
		One Exported Method
			(*T) Sys() []Sys
		Implements (1+)
			*T : Message
	 type InterfaceMessage (struct)
		An InterfaceMessage represents an interface message.

		Exported Fields (6)
			Addrs []Addr
			Flags int
			Index int
			Name string
			Type int
			Version int
		One Exported Method
			(*T) Sys() []Sys
		Implements (1+)
			*T : Message
	 type InterfaceMetrics (struct)
		InterfaceMetrics represents interface metrics.

		Exported Fields (2)
			MTU int
			Type int
		One Exported Method
			(*T) SysType() SysType
		Implements (1+)
			*T : Sys
	 type InterfaceMulticastAddrMessage (struct)
		An InterfaceMulticastAddrMessage represents an interface multicast
		address message.

		Exported Fields (5)
			Addrs []Addr
			Flags int
			Index int
			Type int
			Version int
		One Exported Method
			(*T) Sys() []Sys
		Implements (1+)
			*T : Message
	 type LinkAddr (struct)
		A LinkAddr represents a link-layer address.

		Exported Fields (3)
			Addr []byte
			Index int
			Name string
		One Exported Method
			(*T) Family() int
		Implements (1+)
			*T : Addr
	 type Message (interface)
		A Message represents a routing message.

		One Exported Method
			 (T) Sys() []Sys
		Implemented By (5+)
			*InterfaceAddrMessage
			*InterfaceAnnounceMessage
			*InterfaceMessage
			*InterfaceMulticastAddrMessage
			*RouteMessage
		As Outputs Of (1+)
			func ParseRIB(typ RIBType, b []byte) ([]Message, error)
	 type RIBType int
		A RIBType represents a type of routing information base.

		As Inputs Of (2+)
			func FetchRIB(af int, typ RIBType, arg int) ([]byte, error)
			func ParseRIB(typ RIBType, b []byte) ([]Message, error)
		As Types Of (2+)
			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.

		Exported Fields (8)
			Addrs []Addr
			Err error
			Flags int
			ID uintptr
			Index int
			Seq int
			Type int
			Version int
		Exported Methods (2)
			(*T) Marshal() ([]byte, error)
			(*T) Sys() []Sys
		Implements (1+)
			*T : Message
	 type RouteMetrics (struct)
		RouteMetrics represents route metrics.

		One Exported Field
			PathMTU int
		One Exported Method
			(*T) SysType() SysType
		Implements (1+)
			*T : Sys
	 type Sys (interface)
		A Sys reprensents operating system-specific information.

		One Exported Method
			 (T) SysType() SysType
		Implemented By (2+)
			*InterfaceMetrics
			*RouteMetrics
		As Outputs Of (6+)
			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
		A SysType represents a type of operating system-specific
		information.

		As Outputs Of (3+)
			func (*InterfaceMetrics).SysType() SysType
			func (*RouteMetrics).SysType() SysType
			func Sys.SysType() SysType
		As Types Of (2+)
			const SysMetrics
			const SysStats
Exported Values

	 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.
	const RIBTypeInterface RIBType = 3
	const RIBTypeRoute RIBType = 1
	const SysMetrics SysType = 0
	const SysStats SysType = 1

The pages are generated with Golds v0.1.6. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project and 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.