info

Documentation

Index

• func Start(port uint64, o *orchestrator.Orchestrator) error
• type Constellation
• type Identifier
• type Node
• type Path
• type Segment
• type Shell

Functions

func Start

func Start(port uint64, o *orchestrator.Orchestrator) error

Start starts our information server that provides information about the constellation.

Types

type Constellation

type Constellation struct {
	Shells         []Shell `json:"shells"`
	Groundstations []Node  `json:"groundstations"`
}

Constellation is returned by `/info`.

type Identifier

type Identifier struct {
	Shell uint8  `json:"shell"`
	ID    uint32 `json:"id"`
	Name  string `json:"name,omitempty"`
}

type Node

type Node struct {
	Type       string     `json:"type"`
	Active     bool       `json:"active"`
	Identifier Identifier `json:"identifier"`
}

Node is returned by `/self`, `/gst/{name}` and `/shell/{group}/{id}`.

type Path

type Path struct {
	Source        Identifier `json:"source"`
	Target        Identifier `json:"target"`
	DelayUs       uint32     `json:"delay_us,omitempty"`
	BandwidthKbps uint64     `json:"bandwidth_kbits,omitempty"`
	Blocked       bool       `json:"blocked,omitempty"`
	Segments      []Segment  `json:"segments"`
}

Path is returned by `/path/{source_group}/{source_id}/{target_group}/{target_id}`.

type Segment

type Segment struct {
	Source        Identifier `json:"source"`
	Target        Identifier `json:"target"`
	DelayUs       uint32     `json:"delay_us,omitempty"`
	BandwidthKbps uint64     `json:"bandwidth_kbps,omitempty"`
}

type Shell

type Shell struct {
	Sats []Node `json:"sats"`
}

Shell is returned by `/shell/{group}`.