wrpmetadata

README

wrpmetadata

A library to help us use and document assorted wrp metadata fields.

Documentation

Index

• type ConnectionInterface
  • func ConvertCpeInterface(iName string, model string) ConnectionInterface
  • func (ci ConnectionInterface) String() string

Types

type ConnectionInterface

type ConnectionInterface int

ConnectionInterface represents the type of network interface a CPE (Customer Premises Equipment) uses to connect to the Xmidt cloud. The CPE reports a raw interface name (e.g. "erouter0") that is then mapped to one of these canonical types.

const (
	// Unknown indicates the interface name was empty or unrecognized
	// as a known CPE interface.
	Unknown ConnectionInterface = iota

	// Cellular represents a generic cellular/mobile data connection.
	Cellular

	// CellularLte is a cellular connection known to be LTE.
	CellularLte

	// Docsis represents a Data Over Cable Service Interface
	// Specification (DOCSIS) connection.
	Docsis

	// Dsl represents a Digital Subscriber Line (DSL)connection.
	Dsl

	// Lan represents a generic LAN connection.
	Lan

	// LanEthernet represents an Ethernet-based LAN connection.
	LanEthernet

	// LanWifi represents a WiFi-based LAN connection.
	LanWifi

	// Other represents a recognized but unmapped interface name.
	Other

	// Wifi represents a direct WiFi connection.
	Wifi
)

func ConvertCpeInterface

func ConvertCpeInterface(iName string, model string) ConnectionInterface

ConvertCpeInterface maps a raw CPE network interface name and hardware model to a canonical ConnectionInterface. The interface name is the value the CPE sets in the "webpa-interface-used" metadata field (part of X-Xmidt-Metadata). The model parameter is the "hw-model" metadata value and is used to further refine the mapping (e.g. distinguishing CellularLte from Cellular).

Empty or "unknown" interface names return Unknown. Unrecognized non-empty names return Other.

func (ConnectionInterface) String

func (ci ConnectionInterface) String() string