interfaceschema

type Aggregation uint8

type CompiledInterface struct {
	// ID is the storage identifier of the interface.
	ID int64
	// Name is the reverse-domain interface name.
	Name string
	// Major and Minor are the interface version.
	Major, Minor int
	// Type discriminates datastream from properties.
	Type InterfaceType
	// Ownership states which side publishes on this interface.
	Ownership Ownership
	// Aggregation is individual or object.
	Aggregation Aggregation
	// Trie matches concrete full endpoint paths, segment-wise.
	Trie *EndpointTrie
	// ObjectLeaves maps, for object aggregation, each last-level name to its
	// mapping; nil for individual aggregation.
	ObjectLeaves map[string]*CompiledMapping
}

type CompiledMapping struct {
	// EndpointID is the storage identifier of this endpoint.
	EndpointID int64
	// ValueType drives both validation and BSON/JSON decoding.
	ValueType ValueType
	// Reliability is the MQTT QoS byte (0, 1, or 2).
	Reliability byte
	// Retention states what happens to undeliverable values.
	Retention Retention
	// Expiry is the retention expiry; 0 means never.
	Expiry time.Duration
	// ExplicitTimestamp states whether publishes carry their own timestamp.
	ExplicitTimestamp bool
	// AllowUnset permits property unset via empty payload.
	AllowUnset bool
	// DBRetentionTTL is the database TTL; 0 means no_ttl.
	DBRetentionTTL time.Duration
}

type DatabaseRetentionPolicy uint8

type EndpointIDResolver interface {
	// ResolveInterface returns the storage ID of the interface itself.
	ResolveInterface(name string, major int) (int64, error)
	// ResolveEndpoint returns the storage ID of one declared endpoint
	// pattern (for example "/%{sensor_id}/value").
	ResolveEndpoint(endpoint string) (int64, error)
}

type EndpointTrie struct {
	// contains filtered or unexported fields
}

type Interface struct {
	// Name is the reverse-domain interface name (≤ 128 characters).
	Name string
	// Major is the major version; majors coexist as distinct interfaces.
	Major int
	// Minor is the minor version; bumps must be additive (CheckMinorUpgrade).
	Minor int
	// Type discriminates datastream from properties.
	Type InterfaceType
	// Ownership states which side publishes on this interface.
	Ownership Ownership
	// Aggregation is individual or object (defaults to individual).
	Aggregation Aggregation
	// Description is the optional human-readable summary.
	Description string
	// Doc is the optional long-form documentation.
	Doc string
	// Mappings are the declared endpoints (1 to 1024 entries).
	Mappings []Mapping
}

type InterfaceType uint8

type Mapping struct {
	// Endpoint is the declared path pattern, e.g. "/%{sensor_id}/value".
	Endpoint string
	// Type is the value type of data published on this endpoint.
	Type ValueType
	// Reliability is the delivery guarantee (datastream only).
	Reliability Reliability
	// Retention states what happens to undeliverable values (datastream only).
	Retention Retention
	// Expiry is the retention expiry in seconds; 0 means never (datastream only).
	Expiry int64
	// DatabaseRetentionPolicy states whether stored values get a TTL
	// (datastream only).
	DatabaseRetentionPolicy DatabaseRetentionPolicy
	// DatabaseRetentionTTL is the database TTL in seconds; set if and only
	// if DatabaseRetentionPolicy is UseTTL (datastream only).
	DatabaseRetentionTTL int64
	// AllowUnset permits unsetting the property (properties only).
	AllowUnset bool
	// ExplicitTimestamp states whether publishes carry their own timestamp
	// (datastream only).
	ExplicitTimestamp bool
	// Description is the optional human-readable summary.
	Description string
	// Doc is the optional long-form documentation.
	Doc string
}

type Ownership uint8

type Reliability uint8

type Retention uint8

type ValueType uint8