agent

Documentation

Overview

Package agent contains messages for all agents rather than controllers.

All these structures are expected to be used with a SimpleHub that doesn't seralize, hence no serialization directives.

Index

• Constants
• type StartStopResponse
• type Status
• type Units

Constants

const StartUnitResponseTopic = "unit.start.response"

StartUnitResponseTopic is the topic to respond to a start request. The payload is the StartStopResponse type below.

const StartUnitTopic = "unit.start"

StartUnitTopic is used to request one or more units to start. The payload for a StartUnitTopic is the Units structure.

const StopUnitResponseTopic = "unit.stop.response"

StopUnitResponseTopic is the topic to respond to a stop request. The payload is the StartStopResponse type below.

const StopUnitTopic = "unit.stop"

StopUnitTopic is used to request one or more units to stop. The payload for a StopUnitTopic is the Units structure.

const UnitStatusResponseTopic = "unit.status.response"

UnitStatusResponseTopic is the topic to respond to a status request. The payload is the Status type below.

const UnitStatusTopic = "unit.status"

UnitStatusTopic is used to request the current status for the units. There is no payload for this request.

Types

type StartStopResponse

type StartStopResponse map[string]interface{}

StartStopResponse returns a map of the requested unit names, and whether they were stopped, started, or not found.

type Status

type Status map[string]interface{}

Status is a map of unit name to the status value. An interface{} value is returned to allow for simple expansion later. The output of the status is expected to just show a nice string representation of the map.

type Units

type Units struct {
	Names []string
}

Units provides a way to request start or stop multiple units.