southbound

Documentation

Overview

Package southbound contains utilities to interact with Stratum devices via gNMI and P4Runtime

Index

• type Host
• type HostDiscovery
  • func NewGNMIHostDiscovery() HostDiscovery
• type HostListener
• type HostReport
• type IngressLinkDiscovery
  • func NewGNMILinkDiscovery() IngressLinkDiscovery
• type IngressLinkListener
• type Link
• type LinkReport
• type PortDiscovery
  • func NewGNMIPortDiscovery() PortDiscovery
• type PortStatusListener

Types

type Host

type Host struct {
	MAC        string
	IP         string
	Port       uint32
	CreateTime uint64
}

Host is a simple representation of a host network interface discovered by the ONOS lite

type HostDiscovery

type HostDiscovery interface {
	GetHosts(object *topo.Object, listener HostListener) (*HostReport, error)
}

HostDiscovery is an abstraction of an entity capable of discovering hosts

func NewGNMIHostDiscovery

func NewGNMIHostDiscovery() HostDiscovery

NewGNMIHostDiscovery returns new host discovery based on gNMI

type HostListener

type HostListener interface {
	HostAdded(host *Host, agentID string)
	HostDeleted(host *Host, agentID string)
}

HostListener is an abstraction of an entity capable of handling host changes

type HostReport

type HostReport struct {
	AgentID string
	Hosts   map[string]*Host
}

HostReport provides results of a host query against the host local agent

type IngressLinkDiscovery

type IngressLinkDiscovery interface {
	GetIngressLinks(object *topo.Object, listener IngressLinkListener) (*LinkReport, error)
}

IngressLinkDiscovery is an abstraction of an entity capable of discovering ingress links

func NewGNMILinkDiscovery

func NewGNMILinkDiscovery() IngressLinkDiscovery

NewGNMILinkDiscovery returns new ingress link discovery based on gNMI

type IngressLinkListener

type IngressLinkListener interface {
	LinkAdded(link *Link)
	LinkDeleted(link *Link)
}

IngressLinkListener is an abstraction of an entity capable of handling ingress link changes

type Link

type Link struct {
	IngressDevice string
	IngressPort   uint32
	EgressDevice  string
	EgressPort    uint32
	CreateTime    uint64
}

Link holds information about an ingress link

type LinkReport

type LinkReport struct {
	AgentID string
	Links   map[uint32]*Link
}

LinkReport provides results of a link query against the link local agent

type PortDiscovery

type PortDiscovery interface {
	GetPorts(object *topo.Object, listener PortStatusListener) (map[string]*topo.Port, error)
}

PortDiscovery is an abstraction of an entity capable of discovering device ports

func NewGNMIPortDiscovery

func NewGNMIPortDiscovery() PortDiscovery

NewGNMIPortDiscovery returns new port discovery based on gNMI

type PortStatusListener

type PortStatusListener interface {
	HandlePortStatus(object *topo.Object, port *topo.Port)
}

PortStatusListener is an abstraction of an entity capable of handling port status updates