info

package

v0.2.0 Latest Latest Go to latest Published: Feb 2, 2024 License: GPL-3.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/OpenFogStack/celestial

Links

Open Source Insights

Documentation ¶

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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"`
	Delay     uint32     `json:"delay,omitempty"`
	Bandwidth uint64     `json:"bandwidth,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"`
	Delay     uint32     `json:"delay,omitempty"`
	Bandwidth uint64     `json:"bandwidth,omitempty"`
}

type Shell ¶

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

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL