node

Documentation

Overview

package node contains generic node types and functions

Index

• Constants
• func GatherEnvironmentData() ([]byte, logging.Result)
• type Build
  • func (b Build) String() string
• type NodeType
• type Status
  • func (s Status) String() string

Constants

const (
	StatusUnitialised Status = iota
	StatusPending
	StatusReady
	StatusUnknown

	NodeIEC    NodeType = "IEC"
	NodeClient NodeType = "client"
	NodeDevice NodeType = "device"
)

Functions

func GatherEnvironmentData

func GatherEnvironmentData() ([]byte, logging.Result)

GatherEnvironmentData gathers data about the local environment and returns it as a base 64 encoded byte array

Types

type Build

type Build struct {
	Version      string `json:"version"`
	Date         string `json:"date"`
	UTCTime      string `json:"utc_time"`
	Platform     string `json:"platform"`
	Number       string `json:"number"`
	TrustedAgent *struct {
		Version  string `json:"version"`
		Date     string `json:"date"`
		UTCTime  string `json:"utc_time"`
		Platform string `json:"platform"`
		Number   string `json:"number"`
	} `json:"trusted_agent,omitempty"`
}

Build holds build information about the node

func (Build) String

func (b Build) String() string

String defines a print formatter for the Build information

type NodeType

type NodeType string

NodeType is an enum to identify the type of node in question

type Status

type Status int

Status is an enum returned by a Status request

func (Status) String

func (s Status) String() string

String converts a Status into a string