routing

Documentation

Index

• type Route
  • func DefaultRoute(ctx context.Context) (*Route, error)
  • func GetRoute(ctx context.Context, routedNet *net.IPNet) (*Route, error)
  • func GetRoutingTable(ctx context.Context) ([]*Route, error)
  • func (r *Route) AddStatic(ctx context.Context) (err error)
  • func (r *Route) RemoveStatic(ctx context.Context) (err error)
  • func (r *Route) Routes(ip net.IP) bool
  • func (r *Route) String() string
• type Table
  • func OpenTable(ctx context.Context) (Table, error)

Types

type Route

type Route struct {
	LocalIP   net.IP
	RoutedNet *net.IPNet
	Interface *net.Interface
	Gateway   net.IP
	Default   bool
}

func DefaultRoute

func DefaultRoute(ctx context.Context) (*Route, error)

func GetRoute

func GetRoute(ctx context.Context, routedNet *net.IPNet) (*Route, error)

func GetRoutingTable

func GetRoutingTable(ctx context.Context) ([]*Route, error)

GetRoutingTable will return a list of Route objects created from the current routing table.

func (*Route) AddStatic

func (r *Route) AddStatic(ctx context.Context) (err error)

AddStatic adds a specific route. This can be used to prevent certain IP addresses from being routed to the route's interface.

func (*Route) RemoveStatic

func (r *Route) RemoveStatic(ctx context.Context) (err error)

RemoveStatic removes a specific route added via AddStatic.

func (*Route) Routes

func (r *Route) Routes(ip net.IP) bool

func (*Route) String

func (r *Route) String() string

type Table

type Table interface {
	// Add adds a route to the routing table
	Add(ctx context.Context, r *Route) error
	// Remove removes a route from the routing table
	Remove(ctx context.Context, r *Route) error
	// Close closes the routing table
	Close(ctx context.Context) error
}

func OpenTable

func OpenTable(ctx context.Context) (Table, error)