Workspace

public class Workspace

A Workspace to operate on Zenoh.

Constructors

Workspace

protected Workspace(Path path, Session session, ExecutorService threadPool)

Methods

get

public Collection<Data> get(Selector selector)

Get a selection of path/value from Zenoh.

Parameters:

• selector – the Selector expressing the selection.

Throws:

• ZException – if get failed.

Returns:

a collection of path/value.

put

public void put(Path path, Value value)

Put a path/value into Zenoh.

Parameters:

• path – the Path. Can be absolute or relative to the workspace.
• value – the Value.

Throws:

• ZException – if put failed.

put

public void put(Path path, String value)

Put a path/String into Zenoh.

Parameters:

• path – the Path. Can be absolute or relative to the workspace.
• value – the value java.lang.String.

Throws:

• ZException – if put failed.

put

public void put(Path path, long value)

Put a path/integer into Zenoh.

Parameters:

• path – the Path. Can be absolute or relative to the workspace.
• value – the integer value as a long

Throws:

• ZException – if put failed.

put

public void put(Path path, double value)

Put a path/float into Zenoh.

Parameters:

• path – the Path. Can be absolute or relative to the workspace.
• value – the float value as a double.

Throws:

• ZException – if put failed.

put

public void put(Path path, ByteBuffer value)

Put a path/ByteBuffer into Zenoh using the RAW encoding.

Parameters:

• path – the Path. Can be absolute or relative to the workspace.
• value – the ByteBuffer.

Throws:

• ZException – if put failed.

registerEval

public void registerEval(Path path, Eval eval)

Registers an evaluation function under the provided Path. The function will be evaluated in a dedicated thread, and thus may call any other Workspace operation.

Parameters:

• path – the Path where the function can be triggered using get(Selector)
• eval – the evaluation function

Throws:

• ZException – if registration failed.

remove

public void remove(Path path)

Remove a path/value from Zenoh.

Parameters:

• path – the Path to be removed. Can be absolute or relative to the workspace.

Throws:

• ZException – if remove failed.

subscribe

public SubscriptionId subscribe(Selector selector, Listener listener)

Subscribe to a selection of path/value from Zenoh.

Parameters:

• selector – the Selector expressing the selection.
• listener – the Listener that will be called for each change of a path/value matching the selection.

Throws:

• ZException – if subscribe failed.

Returns:

a SubscriptionId.

unregisterEval

public void unregisterEval(Path path)

Unregister a previously registered evaluation function.

Parameters:

• path – the Path where the function has been registered

Throws:

• ZException – if unregistration failed.

unsubscribe

public void unsubscribe(SubscriptionId subid)

Unregisters a previous subscription.

Parameters:

• subid – the SubscriptionId to unregister

Throws:

• ZException – if unsusbscribe failed.

update

public void update(Path path, Value value)

Update a path/value into Zenoh.

Parameters:

• path – the Path. Can be absolute or relative to the workspace.
• value – a delta to be applied on the existing value.

Throws:

• ZException – if update failed.