topology

type BRInfo struct {
	Name string
	// CtrlAddrs are the local control-plane addresses.
	CtrlAddrs *TopoAddr
	// InternalAddrs are the local data-plane addresses.
	InternalAddrs *TopoBRAddr
	// IFIDs is a sorted list of the interface IDs.
	IFIDs []common.IFIDType
	// IFs is a map of interface IDs.
	IFs map[common.IFIDType]*IFInfo
}

type IDAddrMap map[string]TopoAddr

type IFInfo struct {
	// Id is the interface ID. It is unique per AS.
	Id            common.IFIDType
	BRName        string
	CtrlAddrs     *TopoAddr
	Overlay       overlay.Type
	InternalAddrs *TopoBRAddr
	Local         *TopoBRAddr
	Remote        *overlay.OverlayAddr
	RemoteIFID    common.IFIDType
	Bandwidth     int
	ISD_AS        addr.IA
	LinkType      proto.LinkType
	MTU           int
}

type IfInfoMap map[common.IFIDType]IFInfo

type OverBindAddr struct {
	PublicOverlay *overlay.OverlayAddr
	BindOverlay   *overlay.OverlayAddr
}

type Provider interface {
	// Get returns a topology. The returned topology is guaranteed to not be
	// nil.
	Get() *Topo
}

type RawAddr struct {
	Addr string
}

type RawAddrMap map[string]*RawPubBindOverlay

type RawAddrOverlay struct {
	Addr        string
	OverlayPort int `json:",omitempty"`
}

type RawAddrPort struct {
	Addr   string
	L4Port int
}

type RawAddrPortOverlay struct {
	RawAddrPort
	OverlayPort int `json:",omitempty"`
}

type RawBRAddrMap map[string]*RawOverlayBind

type RawBRInfo struct {
	InternalAddrs RawBRAddrMap
	CtrlAddr      RawAddrMap
	Interfaces    map[common.IFIDType]*RawBRIntf
}

type RawBRIntf struct {
	Overlay       string          `json:",omitempty"`
	PublicOverlay *RawAddrOverlay `json:",omitempty"`
	BindOverlay   *RawAddr        `json:",omitempty"`
	RemoteOverlay *RawAddrOverlay `json:",omitempty"`
	Bandwidth     int
	ISD_AS        string
	LinkTo        string
	MTU           int
}

type RawOverlayBind struct {
	PublicOverlay RawAddrOverlay
	BindOverlay   *RawAddr `json:",omitempty"`
}

type RawPubBindOverlay struct {
	Public RawAddrPortOverlay
	Bind   *RawAddrPort `json:",omitempty"`
}

type RawSrvInfo struct {
	Addrs RawAddrMap
}

type RawTopo struct {
	Timestamp          int64
	TimestampHuman     string
	TTL                uint32
	ISD_AS             string
	Overlay            string
	MTU                int
	Core               bool
	BorderRouters      map[string]*RawBRInfo  `json:",omitempty"`
	ZookeeperService   map[int]*RawAddrPort   `json:",omitempty"`
	BeaconService      map[string]*RawSrvInfo `json:",omitempty"`
	CertificateService map[string]*RawSrvInfo `json:",omitempty"`
	PathService        map[string]*RawSrvInfo `json:",omitempty"`
	SibraService       map[string]*RawSrvInfo `json:",omitempty"`
	RainsService       map[string]*RawSrvInfo `json:",omitempty"`
	SIG                map[string]*RawSrvInfo `json:",omitempty"`
	DiscoveryService   map[string]*RawSrvInfo `json:",omitempty"`
}

type ServiceNames []string

type Topo struct {
	Timestamp      time.Time
	TimestampHuman string // This can vary wildly in format and is only for informational purposes.
	TTL            time.Duration
	ISD_AS         addr.IA
	Overlay        overlay.Type
	MTU            int
	Core           bool

	BR      map[string]BRInfo
	BRNames []string
	// This maps Interface IDs to internal addresses. Clients use this to
	// figure out which internal BR address they have to send their traffic to
	// if they want to use a given interface.
	IFInfoMap IfInfoMap

	BS       IDAddrMap
	BSNames  ServiceNames
	CS       IDAddrMap
	CSNames  ServiceNames
	PS       IDAddrMap
	PSNames  ServiceNames
	SB       IDAddrMap
	SBNames  ServiceNames
	RS       IDAddrMap
	RSNames  ServiceNames
	DS       IDAddrMap
	DSNames  ServiceNames
	SIG      IDAddrMap
	SIGNames ServiceNames

	ZK map[int]*addr.AppAddr
}

type TopoAddr struct {
	IPv4    *pubBindAddr
	IPv6    *pubBindAddr
	Overlay overlay.Type
}

type TopoBRAddr struct {
	IPv4    *OverBindAddr
	IPv6    *OverBindAddr
	Overlay overlay.Type
}