tele

Documentation

Index

• Constants
• func New() tele_api.Teler
• func NewWithTransporter(trans Transporter) tele_api.Teler
• type CommandCallback
• type FromRoboMessage
• type Transporter

Constants

const (
	DefaultNetworkTimeout = 30 * time.Second
)

Functions

func New

func New() tele_api.Teler

func NewWithTransporter

func NewWithTransporter(trans Transporter) tele_api.Teler

Types

type CommandCallback

type CommandCallback func(context.Context, []byte) bool

type FromRoboMessage

type FromRoboMessage tele_api.FromRoboMessage

type Transporter

type Transporter interface {
	Init(ctx context.Context, log *log2.Log, teleConfig tele_config.Config, onCommand CommandCallback, messageForRobot CommandCallback) error
	SendState(payload []byte) bool
	SendTelemetry(payload []byte) bool
	SendCommandResponse(topicSuffix string, payload []byte) bool
	SendFromRobot(payload []byte)
	CloseTele()
	RoboConnected() bool
}

Transporter Tele transport contract: - Init fails only with invalid config, ignores network errors - Send* deliver (with retries) within timeout or fail; success includes ack from receiver - hide "connection" concept from upstream API or errors; transport delivers messages at least once - application may start without network available - assume worst network quality: packet loss, reorder, duplicates, corruption