Categorygithub.com/atolab/yaks-go
modulepackage
0.3.0
Repository: https://github.com/atolab/yaks-go.git
Documentation: pkg.go.dev

# README

Documentation Status GoReport Status

yaks-go

The YAKS API binding for Go.

# Packages

No description provided by the author

# Functions

Login establishes a session with the Yaks instance reachable via provided Zenoh locator.
NewPath returns a new Path from the string p, if it's a valid path specification.
NewPropertiesValue returns a new PropertiesValue.
NewRawValue returns a new RawValue.
NewSelector returns a new Selector from the string s, if it's a valid path specification.
NewStringValue returns a new StringValue.
RegisterValueDecoder registers a ValueDecoder function with it's Encoding.

# Constants

Known encodings.
Known encodings.
PropPassword is the "password" property key.
PropUser is the "user" property key.
PUT represents a change made by a put on Yaks.
Known encodings.
REMOVE represents a change made by a remove on Yaks.
Known encodings.
Known encodings.
UPDATE represents a change made by an update on Yaks.

# Structs

Admin represents the admin interface to operate on Yaks.
Change represents a change made on a path/value in Yaks.
Entry
Entry is a Path + Value + Timestamp tuple.
Path is a path in Yaks.
PropertiesValue is a PROPERTIES value (i.e.
RawValue is a RAW value (i.e.
Selector is a selector in Yaks.
StringValue is a STRING value (i.e.
Workspace represents a workspace to operate on Yaks.
Yaks is Yaks.
YError reports an error that occurred in Yaks, possibly caused by an error in Zenoh.

# Interfaces

Value represents a value stored by Yaks.

# Type aliases

ChangeKind is a kind of change.
Encoding is the encoding kind of a Value.
Eval defines the callback function that has to be registered for evals.
Listener defines the callback function that has to be registered for subscriptions.
Properties is a (string,string) map.
SubscriptionID identifies a Yaks subscription.
Timestamp is a Zenoh Timestamp.
ValueDecoder is a decoder for a Value.