protocol

Documentation

Index

• Constants
• type Envelope
• type Headers
• type TopicAction
• type TopicChannel
• type TopicCriterion

Constants

const Group = "things"

Group is a representation of the topic group things

const TopicErrorsFormat = "unknown/unknown/" + string(Group) + "/%s/" + string(Errors)

TopicErrorsFormat is a representation of the topic error format

Types

type Envelope

type Envelope struct {
	Topic     string      `json:"topic"`
	Headers   Headers     `json:"headers"`
	Path      string      `json:"path"`
	Value     interface{} `json:"value,omitempty"`
	Status    int         `json:"status,omitempty"`
	Revision  int         `json:"revision,omitempty"`
	Timestamp string      `json:"timestamp,omitempty"`
}

Envelope represents the content of the messages

type Headers

type Headers interface {
	GetCorrelationID() string
	IsResponseRequired() bool
	GetChannel() string
	IsDryRun() bool
	GetOrigin() string
	GetOriginator() string
	GetETag() string
	GetIfMatch() string
	GetIfNoneMatch() string
	GetReplyTarget() int64
	GetReplyTo() string
	GetVersion() int64
	GetContentType() string
	GetGeneric(id string) interface{}
	ToMap() map[string]interface{}
}

Headers represents the headers in the protocol messages

type TopicAction

type TopicAction string

TopicAction is a representation of the defined topic action options

const (
	ActionCreate   TopicAction = "create"
	ActionCreated  TopicAction = "created"
	ActionModify   TopicAction = "modify"
	ActionModified TopicAction = "modified"
	ActionDelete   TopicAction = "delete"
	ActionDeleted  TopicAction = "deleted"
	ActionRetrieve TopicAction = "retrieve"
)

contants for the supported topic action options

type TopicChannel

type TopicChannel string

TopicChannel is a representation of the defined topic channel options

const (
	Twin TopicChannel = "twin"
	Live TopicChannel = "live"
)

constants for the supported topic channel options

type TopicCriterion

type TopicCriterion string

TopicCriterion is a representation of the defined topic creation options

const (
	Commands TopicCriterion = "commands"
	Events   TopicCriterion = "events"
	Search   TopicCriterion = "search"
	Messages TopicCriterion = "messages"
	Errors   TopicCriterion = "errors"
)

constants for the supported topic creation options