ZenohexPico.
Copy Markdown
Utility functions for working with Zenoh session configurations.
This module provides helpers to obtain default configuration and retrieve or update individual config keys.
Supported values
Configuration values are strings. The following keys are supported:
| Key | Accepted values | Config default | Examples |
|---|---|---|---|
:mode | "client", "peer" | "client" | "peer" |
:connect | One or more locators | None | "tcp/192.168.1.10:7447" |
:listen | A single locator; subsequent inserts replace it | None | "tcp/0.0.0.0:7447" |
:multicast_scouting | "true", "false" | "true" | "false" |
:multicast_locator | A multicast UDP locator | "udp/224.0.0.224:7446" | "udp/224.0.0.224:7446" |
:scouting_timeout | Integer milliseconds | "1000" | "5000" |
:scouting_what | Bitmask from 0 to 7 | Not set (runtime: "3") | "7" |
:session_zid | A 128-bit UUID | None | "01234567-89ab-cdef-0123-456789abcdef" |
Multiple :connect locators are supported. Add each locator with a separate
call to insert/3:
{:ok, config} = ZenohexPico.Config.default()
{:ok, config} = ZenohexPico.Config.insert(config, :connect, "tcp/192.168.1.10:7447")
{:ok, config} = ZenohexPico.Config.insert(config, :connect, "tcp/192.168.1.20:7447")get/2 returns only the most recently configured :connect locator.
When opening a session, Zenoh Pico reads all configured :connect locators.
In client mode, it tries them from most recently configured to least recently
configured until one succeeds. In peer mode, it establishes a primary
transport, then adds the remaining locators as peers.
For developers: Only :connect supports multiple values. Zenoh Pico uses the internal _z_config_get_all function to retrieve all configured locators, but does not expose a public equivalent. Therefore, ZenohexPico does not provide an API for retrieving all configured :connect locators; get/2 returns only one locator.
The :scouting_what bitmask uses 1 for routers, 2 for peers, and
4 for clients. Combine values to discover multiple entity types; for
example, "7" discovers routers, peers, and clients.
:scouting_timeout applies only in client mode while scouting for a router.
:session_zid is optional; when it is unset, Zenoh Pico generates the
session ID.
Locator protocols depend on the Zenoh Pico features enabled at build time.
Common examples are tcp/<address>:<port> and udp/<address>:<port>.
Summary
Functions
Returns the default Zenoh configuration.
Returns the value of the configuration at key.
Inserts a configuration value at key, returning the updated config.
Types
@type key() ::
:mode
| :connect
| :listen
| :multicast_scouting
| :multicast_locator
| :scouting_timeout
| :scouting_what
| :session_zid
A supported Zenoh runtime configuration key.
@type t() :: reference()
An opaque native Zenoh configuration.
Functions
Returns the default Zenoh configuration.
Returns the value of the configuration at key.
For :connect, which supports multiple values, returns only the most
recently configured locator.
Raises ArgumentError when key is not supported.
Examples
iex> {:ok, config} = ZenohexPico.Config.default()
iex> {:ok, _value} = ZenohexPico.Config.get(config, :mode)
{:ok, "client"}
iex> {:error, _value} = ZenohexPico.Config.get(config, :connect)
{:error, :not_found}Inserts a configuration value at key, returning the updated config.
Raises ArgumentError when key is not supported.
Examples
iex> {:ok, config} = ZenohexPico.Config.default()
iex> {:error, _value} = ZenohexPico.Config.get(config, :connect)
{:error, :not_found}
iex> {:ok, config} = ZenohexPico.Config.insert(config, :connect, "tcp/localhost:7447")
iex> {:ok, _value} = ZenohexPico.Config.get(config, :connect)
{:ok, "tcp/localhost:7447"}