staticinfo

Documentation

Overview

Package staticinfo contains the internal representation of the StaticInfoExtension path segment extension, and conversion from and to the corresponding protobuf representation. See also StaticInfoExtension in proto/control_plane/v1/seg_extensions.proto.

Index

• Constants
• func ToPB(si *Extension) *cppb.StaticInfoExtension
• type BandwidthInfo
• type Extension
  • func FromPB(pb *cppb.StaticInfoExtension) *Extension
• type GeoCoordinates
• type GeoInfo
• type InternalHopsInfo
• type LatencyInfo
• type LinkType
• type LinkTypeInfo

Constants

const (
	LinkTypeDirect = iota
	LinkTypeMultihop
	LinkTypeOpennet
)

Functions

func ToPB

func ToPB(si *Extension) *cppb.StaticInfoExtension

FromPB creates the protobuf representation for the staticinfo Extension.

Types

type BandwidthInfo

type BandwidthInfo struct {
	Intra map[iface.ID]uint64
	Inter map[iface.ID]uint64
}

BandwidthInfo is the internal repesentation of `bandwidth` in the StaticInfoExtension.

type Extension

type Extension struct {
	Latency      LatencyInfo
	Bandwidth    BandwidthInfo
	Geo          GeoInfo
	LinkType     LinkTypeInfo
	InternalHops InternalHopsInfo
	Note         string
}

Extension is the internal repesentation of the StaticInfoExtension path segment extension.

func FromPB

func FromPB(pb *cppb.StaticInfoExtension) *Extension

FromPB creates the staticinfo Extension from the protobuf representation.

type GeoCoordinates

type GeoCoordinates struct {
	Latitude  float32
	Longitude float32
	Address   string
}

GeoCoordinates is the internal repesentation of the GeoCoordinates in the StaticInfoExtension.

type GeoInfo

type GeoInfo map[iface.ID]GeoCoordinates

GeoInfo is the internal repesentation of `geo` in the StaticInfoExtension.

type InternalHopsInfo

type InternalHopsInfo map[iface.ID]uint32

InternalHopsInfo is the internal representation of `internal_hops` in the StaticInfoExtension.

type LatencyInfo

type LatencyInfo struct {
	Intra map[iface.ID]time.Duration
	Inter map[iface.ID]time.Duration
}

LatencyInfo is the internal repesentation of `latency` in the StaticInfoExtension.

type LinkType

type LinkType uint8

LinkType is the internal representation of the LinkType in the StaticInfoExtension. There is no UNSPECIFIED value here, as we can simply omit these from the internal map representation.

type LinkTypeInfo

type LinkTypeInfo map[iface.ID]LinkType

LinkTypeInfo is the internal representation of `link_type` in the StaticInfoExtension.