control

Documentation

Overview

Package control is a generated protocol buffer package.

It is generated from these files:

controlmessage.proto
heartbeatrequest.proto
uuid.proto

It has these top-level messages:

ControlMessage

Index

• Variables
• type ControlMessage
  • func (m *ControlMessage) GetControlType() ControlMessage_ControlType
  • func (m *ControlMessage) GetHeartbeatRequest() *HeartbeatRequest
  • func (m *ControlMessage) GetIdentifier() *UUID
  • func (m *ControlMessage) GetOrigin() string
  • func (m *ControlMessage) GetTimestamp() int64
  • func (*ControlMessage) ProtoMessage()
  • func (m *ControlMessage) Reset()
  • func (m *ControlMessage) String() string
• type ControlMessage_ControlType
  • func (x ControlMessage_ControlType) Enum() *ControlMessage_ControlType
  • func (x ControlMessage_ControlType) String() string
  • func (x *ControlMessage_ControlType) UnmarshalJSON(data []byte) error
• type HeartbeatRequest
  • func (*HeartbeatRequest) ProtoMessage()
  • func (m *HeartbeatRequest) Reset()
  • func (m *HeartbeatRequest) String() string
• type UUID
  • func (m *UUID) GetHigh() uint64
  • func (m *UUID) GetLow() uint64
  • func (*UUID) ProtoMessage()
  • func (m *UUID) Reset()
  • func (m *UUID) String() string

Variables

var ControlMessage_ControlType_name = map[int32]string{
	1: "HeartbeatRequest",
}

var ControlMessage_ControlType_value = map[string]int32{
	"HeartbeatRequest": 1,
}

Types

type ControlMessage

type ControlMessage struct {
	Origin           *string                     `protobuf:"bytes,1,req,name=origin" json:"origin,omitempty"`
	Identifier       *UUID                       `protobuf:"bytes,2,req,name=identifier" json:"identifier,omitempty"`
	Timestamp        *int64                      `protobuf:"varint,3,req,name=timestamp" json:"timestamp,omitempty"`
	ControlType      *ControlMessage_ControlType `protobuf:"varint,4,req,name=controlType,enum=control.ControlMessage_ControlType" json:"controlType,omitempty"`
	HeartbeatRequest *HeartbeatRequest           `protobuf:"bytes,5,opt,name=heartbeatRequest" json:"heartbeatRequest,omitempty"`
	XXX_unrecognized []byte                      `json:"-"`
}

/ ControlMessage wraps a control command and adds metadata.

func (*ControlMessage) GetControlType

func (m *ControlMessage) GetControlType() ControlMessage_ControlType

func (*ControlMessage) GetHeartbeatRequest

func (m *ControlMessage) GetHeartbeatRequest() *HeartbeatRequest

func (*ControlMessage) GetIdentifier

func (m *ControlMessage) GetIdentifier() *UUID

func (*ControlMessage) GetOrigin

func (m *ControlMessage) GetOrigin() string

func (*ControlMessage) GetTimestamp

func (m *ControlMessage) GetTimestamp() int64

func (*ControlMessage) ProtoMessage

func (*ControlMessage) ProtoMessage()

func (*ControlMessage) Reset

func (m *ControlMessage) Reset()

func (*ControlMessage) String

func (m *ControlMessage) String() string

type ControlMessage_ControlType

type ControlMessage_ControlType int32

/ Type of the wrapped control.

const (
	ControlMessage_HeartbeatRequest ControlMessage_ControlType = 1
)

func (ControlMessage_ControlType) Enum

func (x ControlMessage_ControlType) Enum() *ControlMessage_ControlType

func (ControlMessage_ControlType) String

func (x ControlMessage_ControlType) String() string

func (*ControlMessage_ControlType) UnmarshalJSON

func (x *ControlMessage_ControlType) UnmarshalJSON(data []byte) error

type HeartbeatRequest

type HeartbeatRequest struct {
	XXX_unrecognized []byte `json:"-"`
}

/ A HeartbeatRequest command elicits a heartbeat from a component or app. When a HeartbeatRequest is received, a Heartbeat event MUST be returned with controlMessageIdentifier set to the UUID received in the request.

func (*HeartbeatRequest) ProtoMessage

func (*HeartbeatRequest) ProtoMessage()

func (*HeartbeatRequest) Reset

func (m *HeartbeatRequest) Reset()

func (*HeartbeatRequest) String

func (m *HeartbeatRequest) String() string

type UUID

type UUID struct {
	Low              *uint64 `protobuf:"varint,1,req,name=low" json:"low,omitempty"`
	High             *uint64 `protobuf:"varint,2,req,name=high" json:"high,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}

/ Type representing a 128-bit UUID.

The bytes of the UUID should be packed in little-endian **byte** (not bit) order. For example, the UUID `f47ac10b-58cc-4372-a567-0e02b2c3d479` should be encoded as `UUID{ low: 0x7243cc580bc17af4, high: 0x79d4c3b2020e67a5 }`

func (*UUID) GetHigh

func (m *UUID) GetHigh() uint64

func (*UUID) GetLow

func (m *UUID) GetLow() uint64

func (*UUID) ProtoMessage

func (*UUID) ProtoMessage()

func (*UUID) Reset

func (m *UUID) Reset()

func (*UUID) String

func (m *UUID) String() string