betwixt.go

package betwixt

import (
	"time"

	"github.com/zubairhamed/canopus"
)

// LWM2MObjectType represents a LWM2M Object Type
type LWM2MObjectType uint16

// LWM2MResourceType represents a LWM2M Resource Type
type LWM2MResourceType uint16

// LWM2MObjectInstances contains instances of LWM2M Objects by Type
type LWM2MObjectInstances map[LWM2MObjectType]Object

// Event Callback
type FnEvent func()

// Event Callback for OnStartup
type FnOnStartup func()

// Event Callback for a read request
type FnOnRead func()

// Event Callback for a write request
type FnOnWrite func()

// Event Callback for an execute request
type FnOnExecute func()

// Event Callback for a register request
type FnOnRegistered func(RegisteredClient)

// Event Callback for a deregister request
type FnOnDeregistered func()

// Event Callback when an error occurs
type FnOnError func()

type OperationType byte

type EventType int

const (
	EVENT_START EventType = 0
)

// LWM2M Operation Types
type OperationCode int

const (
	OPERATION_NONE OperationCode = 0
	OPERATION_R    OperationCode = 1
	OPERATION_W    OperationCode = 2
	OPERATION_RW   OperationCode = 3
	OPERATION_E    OperationCode = 4
	OPERATION_RE   OperationCode = 5
	OPERATION_WE   OperationCode = 6
	OPERATION_RWE  OperationCode = 7
)

// Type of LWM2M value
type IdentifierType byte

const (
	IDENTIFIER_OBJECT_INSTANCE     IdentifierType = 0
	IDENTIFIER_RESOURCE_INSTANCE   IdentifierType = 1
	IDENTIFIER_RESOURCES           IdentifierType = 2
	IDENTIFIER_RESOURCE_WITH_VALUE IdentifierType = 3
)

// Binding Modes
type BindingMode string

const (
	BINDINGMODE_UDP                         BindingMode = "U"
	BINDINGMODE_UDP_WITH_QUEUE_MODE         BindingMode = "UQ"
	BINDINGMODE_SMS                         BindingMode = "S"
	BINDINGMODE_SMS_WITH_QUEUE_MODE         BindingMode = "SQ"
	BINDINGMODE_UDP_AND_SMS                 BindingMode = "US"
	BINDINGMODE_UDP_WITH_QUEUE_MODE_AND_SMS BindingMode = "UQS"
)

// Operation Types
const (
	OPERATIONTYPE_REGISTER         OperationType = 0
	OPERATIONTYPE_UPDATE           OperationType = 1
	OPERATIONTYPE_DEREGISTER       OperationType = 2
	OPERATIONTYPE_READ             OperationType = 3
	OPERATIONTYPE_DISCOVER         OperationType = 4
	OPERATIONTYPE_WRITE            OperationType = 5
	OPERATIONTYPE_WRITE_ATTRIBUTES OperationType = 6
	OPERATIONTYPE_EXECUTE          OperationType = 7
	OPERATIONTYPE_CREATE           OperationType = 8
	OPERATIONTYPE_DELETE           OperationType = 9
	OPERATIONTYPE_OBSERVE          OperationType = 10
	OPERATIONTYPE_NOTIFY           OperationType = 11
	OPERATIONTYPE_CANCEL_OBSERVE   OperationType = 12
)

// ObjectEnabler interface to handler any incoming requests from a server for a given object
type ObjectEnabler interface {
	OnRead(int, int, Lwm2mRequest) Lwm2mResponse
	OnDelete(int, Lwm2mRequest) Lwm2mResponse
	OnWrite(int, int, Lwm2mRequest) Lwm2mResponse
	OnCreate(int, int, Lwm2mRequest) Lwm2mResponse
	OnExecute(int, int, Lwm2mRequest) Lwm2mResponse
}

// ObjectSource interface representing a source consumed by a Registry to resolve and retrieve
// LWM2M object definitions
type ObjectSource interface {
	Initialize()
	GetObject(n LWM2MObjectType) ObjectDefinition
	GetObjects() map[LWM2MObjectType]ObjectDefinition
	AddObject(m ObjectDefinition, res []ResourceDefinition)
}

// Registry interface represents a source from which LWM2M object definitions can be looked up/resolved or
// stored
type Registry interface {
	GetDefinition(LWM2MObjectType) ObjectDefinition
	Register(ObjectSource)
	GetMandatory() []ObjectDefinition
	GetDefinitions() []ObjectDefinition
}

// ObjectDefinition interface defines a LWM2M Object
type ObjectDefinition interface {
	GetName() string
	GetType() LWM2MObjectType
	GetDescription() string
	SetResources([]ResourceDefinition)
	GetResources() []ResourceDefinition
	GetResource(n LWM2MResourceType) ResourceDefinition
	AllowMultiple() bool
	IsMandatory() bool
}

// ResourceDefinition interface defines a LWM2M Resource
type ResourceDefinition interface {
	GetId() LWM2MResourceType
	GetName() string
	GetDescription() string
	GetUnits() string
	GetRangeOrEnums() string
	IsMandatory() bool
	MultipleValuesAllowed() bool
	GetResourceType() ValueTypeCode
	GetOperations() OperationCode
}

// LWM2MClient interface defining a LWM2M Client
type LWM2MClient interface {
	AddObjectInstance(LWM2MObjectType, int) error
	AddObjectInstances(LWM2MObjectType, ...int)
	AddResource()
	AddObject()
	Register(string) (string, error)
	Deregister()
	Update()
	UseRegistry(Registry)
	EnableObject(LWM2MObjectType, ObjectEnabler) error
	SetEnabler(LWM2MObjectType, ObjectEnabler)
	GetRegistry() Registry
	GetEnabledObjects() map[LWM2MObjectType]Object
	GetObject(n LWM2MObjectType) Object
	Start()

	// Events
	OnStartup(FnOnStartup)
	OnRead(FnOnRead)
	OnWrite(FnOnWrite)
	OnExecute(FnOnExecute)
	OnError(FnOnError)
}

// Lwm2mRequest interface represents an incoming request from a server
type Lwm2mRequest interface {
	GetPath() string
	GetMessage() *canopus.Message
	GetOperationType() OperationType
	GetCoapRequest() canopus.CoapRequest
}

// Lwm2mResponse interface represents an outgoing response to a server
type Lwm2mResponse interface {
	GetResponseCode() canopus.CoapCode
	GetResponseValue() Value
}

// Server interface defines a LWM2M Server
type Server interface {
	UseRegistry(Registry)
	On(EventType, FnEvent)
	Start()
	GetClients() map[string]RegisteredClient
	GetClient(id string) RegisteredClient
	GetStats() ServerStatistics
	GetCoapServer() canopus.CoapServer
}

// RegisteredClient interface is an instance of a client registered on a server
type RegisteredClient interface {
	GetId() string
	GetName() string
	GetLifetime() int
	GetVersion() string
	GetBindingMode() BindingMode
	GetSmsNumber() string
	GetRegistrationDate() time.Time
	Update()
	LastUpdate() time.Time
	SetObjects(map[LWM2MObjectType]Object)
	GetObjects() map[LWM2MObjectType]Object
	GetObject(LWM2MObjectType) Object
	GetAddress() string

	ReadObject(uint16, uint16) (Value, error)
	ReadResource(object uint16, instance uint16, resource uint16) (Value, error)
	Delete(int, int)
	Execute(int, int, int)
}

// An Object interface represents an Object used on a client or Objects supported by a Registered Client on a server
// Not to be confused with ObjectDefinition, which represents the definition of an Object
type Object interface {
	AddInstance(int)
	RemoveInstance(int)
	GetInstances() []int
	GetEnabler() ObjectEnabler
	GetType() LWM2MObjectType
	GetDefinition() ObjectDefinition
	SetEnabler(ObjectEnabler)
}

// ServerStatistics Statistics recorded for the server
type ServerStatistics interface {
	IncrementCoapRequestsCount()
	GetRequestsCount() int
}