spathmeta

Documentation

Overview

Package spathmeta implements basic types for working with SCIOND paths.

Index

• type AppPath
  • func (ap *AppPath) Copy() *AppPath
  • func (ap *AppPath) Key() PathKey
• type AppPathSet
  • func NewAppPathSet(reply *sciond.PathReply) AppPathSet
  • func (aps AppPathSet) Add(entry *sciond.PathReplyEntry) *AppPath
  • func (aps AppPathSet) Copy() AppPathSet
  • func (aps AppPathSet) GetAppPath(pref PathKey) *AppPath
  • func (aps AppPathSet) String() string
• type PathKey
  • func (pk PathKey) String() string

Types

type AppPath

type AppPath struct {
	Entry *sciond.PathReplyEntry
}

AppPath contains a SCIOND path entry.

func (*AppPath) Copy

func (ap *AppPath) Copy() *AppPath

func (*AppPath) Key

func (ap *AppPath) Key() PathKey

Key returns a unique PathKey that can be used for map indexing.

type AppPathSet

type AppPathSet map[PathKey]*AppPath

AppPathSet represents a set of SCIOND path entries, keyed by AppPath.Key().

func NewAppPathSet

func NewAppPathSet(reply *sciond.PathReply) AppPathSet

NewAppPathSet creates a new set of paths from a SCIOND path reply.

func (AppPathSet) Add

func (aps AppPathSet) Add(entry *sciond.PathReplyEntry) *AppPath

Add converts the SCIOND path entry to an AppPath and adds it to the set.

func (AppPathSet) Copy

func (aps AppPathSet) Copy() AppPathSet

func (AppPathSet) GetAppPath

func (aps AppPathSet) GetAppPath(pref PathKey) *AppPath

GetAppPath returns an AppPath from the set. It first tries to find a path with key pref; if one cannot be found, an arbitrary one is returned.

func (AppPathSet) String

func (aps AppPathSet) String() string

type PathKey

type PathKey string

Helper type for pretty printing of maps using paths as keys.

func (PathKey) String

func (pk PathKey) String() string