mir

Documentation

Index

• Constants
• type Mir
  • func Connect(name string, target string) (*Mir, error)
  • func (m *Mir) Device() *deviceRoutes
  • func (m *Mir) Disconnect() error
  • func (m *Mir) Event() *eventRoutes
  • func (m Mir) GetInstanceName() string
  • func (m *Mir) Server() *serverRoutes
• type Msg
  • func (m Msg) GetOrigin() string
  • func (m Msg) GetOriginalTriggerId() string
• type ProtoCmdDesc
• type SendDeviceCommandRequestProto
• type SendDeviceConfigRequestJson
• type SendDeviceConfigRequestProto

Constants

const (
	HeaderRequestEnconding = "request-encoding"
	HeaderContentEncoding  = "content-encoding"
	HeaderOriginalTrigger  = "original-trigger"
	HeaderOrigin           = "origin"
	HeaderZstdEncoding     = "zstd"
)

Types

type Mir

type Mir struct {
	Bus *nats.Conn

	LockStore distributed_lock.DistributedLockStore
	// contains filtered or unexported fields
}

Expose Mir specific functions and domain Publicly expose nats io connection for custom usage

func Connect

func Connect(name string, target string) (*Mir, error)

Establish connection to the Mir server This will enable communication to and from the device To properly close the connection, call the Close() function

func (*Mir) Device

func (m *Mir) Device() *deviceRoutes

Access all device routes

func (*Mir) Disconnect

func (m *Mir) Disconnect() error

Close the connection to the Mir server Release all resources and stop all go routines

func (*Mir) Event

func (m *Mir) Event() *eventRoutes

Access all server routes

func (Mir) GetInstanceName

func (m Mir) GetInstanceName() string

func (*Mir) Server

func (m *Mir) Server() *serverRoutes

Access all server routes

type Msg

type Msg struct {
	*nats.Msg
}

func (Msg) GetOrigin

func (m Msg) GetOrigin() string

ServerId that triggered the event

func (Msg) GetOriginalTriggerId

func (m Msg) GetOriginalTriggerId() string

Mainly present for Events Represent the serverId that made the request trigger

type ProtoCmdDesc

type ProtoCmdDesc struct {
	Name    string
	Payload []byte
}

type SendDeviceCommandRequestProto

type SendDeviceCommandRequestProto struct {
	Targets       *core_apiv1.Targets
	Command       proto.Message
	DryRun        bool
	NoValidation  bool
	RefreshSchema bool
	ForcePush     bool
	TimeoutSec    uint32
}

type SendDeviceConfigRequestJson

type SendDeviceConfigRequestJson struct {
	Targets           *core_apiv1.Targets
	CommandName       string
	CommandPayload    any
	DryRun            bool
	RefreshSchema     bool
	ForcePush         bool
	SendOnlyDifferent bool
}

type SendDeviceConfigRequestProto

type SendDeviceConfigRequestProto struct {
	Targets           *core_apiv1.Targets
	Command           proto.Message
	DryRun            bool
	RefreshSchema     bool
	ForcePush         bool
	SendOnlyDifferent bool
}