Module zenoh::net::config[][src]

Properties to pass to open and scout functions as configuration and associated constants.

Structs

ConfigTranscoder

A transcoder for ConfigProperties able to convert string keys to int keys and reverse.

Constants

ZN_ADD_TIMESTAMP_DEFAULT
ZN_ADD_TIMESTAMP_KEY

Indicates if data messages should be timestamped. String key : "add_timestamp". Accepted values : "true", "false". Default value : "false".

ZN_ADD_TIMESTAMP_STR
ZN_FALSE

"false"

ZN_JOIN_PUBLICATIONS_KEY
ZN_JOIN_SUBSCRIPTIONS_KEY
ZN_LINK_STATE_DEFAULT
ZN_LINK_STATE_KEY

Indicates if the link state protocol should run. String key : "link_state". Accepted values : "true", "false". Default value : "true".

ZN_LINK_STATE_STR
ZN_LISTENER_KEY

A locator to listen on. String key : "listener". Accepted values : <locator> (ex: "tcp/10.10.10.10:7447"). Default value : None. Multiple values accepted.

ZN_LISTENER_STR
ZN_LOCAL_ROUTING_DEFAULT
ZN_LOCAL_ROUTING_KEY

Indicates if local writes/queries should reach local subscribers/queryables. String key : "local_routing". Accepted values : "true", "false". Default value : "true".

ZN_MODE_DEFAULT
ZN_MODE_KEY

The library mode. String key : "mode". Accepted values : "peer", "client". Default value : "peer".

ZN_MODE_STR
ZN_MULTICAST_ADDRESS_DEFAULT
ZN_MULTICAST_ADDRESS_KEY

The multicast address and ports to use for multicast scouting. String key : "multicast_address". Accepted values : <ip address>:<port>. Default value : "224.0.0.224:7447".

ZN_MULTICAST_ADDRESS_STR
ZN_MULTICAST_INTERFACE_DEFAULT
ZN_MULTICAST_INTERFACE_KEY

The network interface to use for multicast scouting. String key : "multicast_interface". Accepted values : "auto", <ip address>, <interface name>. Default value : "auto".

ZN_MULTICAST_INTERFACE_STR
ZN_MULTICAST_SCOUTING_DEFAULT
ZN_MULTICAST_SCOUTING_KEY

Activates/Desactivates multicast scouting. String key : "multicast_scouting". Accepted values : "true", "false". Default value : "true".

ZN_MULTICAST_SCOUTING_STR
ZN_PASSWORD_KEY

The password to use for authentication. String key : "password". Accepted values : <string>. Default value : None.

ZN_PASSWORD_STR
ZN_PEER_KEY

The locator of a peer to connect to. String key : "peer". Accepted values : <locator> (ex: "tcp/10.10.10.10:7447"). Default value : None. Multiple values accepted.

ZN_PEER_STR
ZN_SCOUTING_DELAY_DEFAULT
ZN_SCOUTING_DELAY_KEY

In peer mode, the period dedicated to scouting first remote peers before doing anything else. String key : "scouting_delay". Accepted values : <float in seconds>. Default value : "0.2".

ZN_SCOUTING_DELAY_STR
ZN_SCOUTING_TIMEOUT_DEFAULT
ZN_SCOUTING_TIMEOUT_KEY

In client mode, the period dedicated to scouting a router before failing. String key : "scouting_timeout". Accepted values : <float in seconds>. Default value : "3.0".

ZN_SCOUTING_TIMEOUT_STR
ZN_TRUE

"true"

ZN_USER_KEY

The user name to use for authentication. String key : "user". Accepted values : <string>. Default value : None.

ZN_USER_PASSWORD_DICTIONARY_KEY

The file path containing the user password dictionary. String key : "user_password_dictionary". Accepted values : <file path>. Default value : None.

ZN_USER_PASSWORD_DICTIONARY_STR
ZN_USER_STR

Functions

client

Creates a default 'client' mode zenoh net Session configuration.

default

Creates a default zenoh net Session configuration.

empty

Creates an empty zenoh net Session configuration.

peer

Creates a default 'peer' mode zenoh net Session configuration.

Type Definitions

ConfigProperties

A set of Key/Value (u64/String) pairs to pass to open
to configure the zenoh-net Session.