Struct zenoh::Zenoh

pub struct Zenoh { /* fields omitted */ }

The zenoh client API.

Implementations

impl Zenoh

pub async fn new(config: ConfigProperties) -> ZResult<Zenoh>

Creates a zenoh API, establishing a zenoh-net session with discovered peers and/or routers.

Arguments

• config - The ConfigProperties for the zenoh session

Examples

use zenoh::*;

let zenoh = Zenoh::new(net::config::default()).await.unwrap();

Configuration Properties

ConfigProperties are a set of key/value (u64/String) pairs. Constants for the accepted keys can be found in the config module. Multiple values are coma separated.

Examples

use zenoh::*;

let mut config = net::config::peer();
config.insert(net::config::ZN_LOCAL_ROUTING_KEY, "false".to_string());
config.insert(net::config::ZN_PEER_KEY, "tcp/10.10.10.10:7447,tcp/11.11.11.11:7447".to_string());

let zenoh = Zenoh::new(config).await.unwrap();

ConfigProperties can be built set of key/value (String/String) set of Properties.

Examples

use zenoh::*;

let mut config = Properties::default();
config.insert("local_routing".to_string(), "false".to_string());
config.insert("peer".to_string(), "tcp/10.10.10.10:7447,tcp/11.11.11.11:7447".to_string());

let zenoh = Zenoh::new(config.into()).await.unwrap();

pub fn session(&self) -> &Session

Returns the zenoh-net Session used by this zenoh session. This is for advanced use cases requiring fine usage of the zenoh-net API.

pub async fn router_pid<'_>(&'_ self) -> Option<String>

Returns the PeerId of the zenoh router this zenoh API is connected to (if any).
This calls Session::info() and returns the first router pid from the ZN_INFO_ROUTER_PID_KEY property.

pub async fn workspace<'_, '_>(
    &'_ self,
    prefix: Option<Path>
) -> ZResult<Workspace<'_>>

Creates a Workspace with an optional Path as prefix.
All relative Path or Selector used with this Workspace will be relative to the specified prefix. Not specifying a prefix is equivalent to specifying "/" as prefix, meaning in this case that all relative paths/selectors will be prependend with "/".

Examples

use zenoh::*;
use std::convert::TryInto;

let zenoh = Zenoh::new(net::config::default()).await.unwrap();
let workspace = zenoh.workspace(Some("/demo/example".try_into().unwrap())).await.unwrap();
// The following it equivalent to a PUT on "/demo/example/hello".
workspace.put(
    &"hello".try_into().unwrap(),
    "Hello World!".into()
).await.unwrap();

pub async fn close(self) -> ZResult<()>

Closes the zenoh API and the associated zenoh-net session.

Note that on drop, the zenoh-net session is also automatically closed. But you may want to use this function to handle errors or close the session synchronously.

Examples

use zenoh::*;

let zenoh = Zenoh::new(net::config::default()).await.unwrap();
zenoh.close();