protocol

Documentation

Overview

protcol package provides packages with various communication protocols support that fulfils Protocol interface

Index

• Variables
• type Protocol
• type Transaction
• type TransactionType
  • func (t TransactionType) String() string

Variables

var (
	ErrCommandNotFound = errors.New("command not found")
	ErrParamNotFound   = errors.New("parameter not found")
	ErrWrongSetVal     = errors.New("could not set")
)

Types

type Protocol

type Protocol interface {
	Decode(data []byte) ([]Transaction, error)
	Encode(txs []Transaction) ([]byte, error)
	Trigger(cmdName string) Transaction
}

type Transaction

type Transaction struct {
	Typ         TransactionType
	CommandName string
	Payload     map[string]any
}

type TransactionType

type TransactionType int

const (
	TxUnknown TransactionType = iota

	TxGetParam
	TxSetParam

	TxMismatch
)

func (TransactionType) String

func (t TransactionType) String() string