Admin¶
-
public class
Admin
¶ The zenoh administration class.
Methods¶
addBackend¶
-
public void
addBackend
(String beid, Properties properties)¶ Add a backend in the connected zenoh router (i.e. the one you are directly connected to).
Parameters: - beid – the backend identifier.
- properties – the properties for backend initialization.
Throws: - ZException – if an error occurs.
addBackend¶
-
public void
addBackend
(String beid, Properties properties, String zid)¶ Add a backend in the specified zenoh router, not necessarily the one you are connected to.
Parameters: - beid – the backend identifier.
- properties – the properties for backend initialization.
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
addStorage¶
-
public void
addStorage
(String stid, Properties properties)¶ Add a storage in the connected zenoh router, using an automatically chosen backend.
Parameters: - stid – the storage identifier
- properties – the properties for storage initialization.
Throws: - ZException – if an error occurs.
addStorage¶
-
public void
addStorage
(String stid, Properties properties, String zid)¶ Add a storage in the specified zenoh router, using an automatically chosen backend.
Parameters: - stid – the storage identifier
- properties – the properties for storage initialization.
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
addStorageOnBackend¶
-
public void
addStorageOnBackend
(String stid, Properties properties, String backend)¶ Add a storage in the connected zenoh router, using the specified backend.
Parameters: - stid – the storage identifier.
- properties – the properties for storage initialization.
- backend – the identifier of the backend to use for the storage.
Throws: - ZException – if an error occurs.
addStorageOnBackend¶
-
public void
addStorageOnBackend
(String stid, Properties properties, String backend, String zid)¶ Add a storage in the specified zenoh router, using the specified backend.
Parameters: - stid – the storage identifier.
- properties – the properties for storage initialization.
- backend – the identifier of the backend to use for the storage.
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
getBackend¶
-
public Properties
getBackend
(String beid)¶ Get a backend’s properties from the connected zenoh router (i.e. the one you are directly connected to).
Parameters: - beid – the backend identifier
Throws: - ZException – if an error occurs.
Returns: the backend properties
getBackend¶
-
public Properties
getBackend
(String beid, String zid)¶ Get a backend’s properties from the specified zenoh router, not necessarily the one you are connected to.
Parameters: - beid – the backend identifier
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
Returns: the backend properties
getBackends¶
-
public Map<String, Properties>
getBackends
()¶ Get all the backends from the connected zenoh router (i.e. the one you are directly connected to).
Throws: - ZException – if an error occurs.
Returns: a map of the backends properties, indexed by the backends identifiers.
getBackends¶
-
public Map<String, Properties>
getBackends
(String zid)¶ Get all the backends from the specified zenoh router, not necessarily the one you are connected to.
Parameters: - zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
Returns: a map of the backends properties, indexed by the backends identifiers.
getStorage¶
-
public Properties
getStorage
(String stid)¶ Get a storage’s properties from the connected zenoh router.
Parameters: - stid – the storage identifier
Throws: - ZException – if an error occurs.
Returns: the storage properties
getStorage¶
-
public Properties
getStorage
(String stid, String zid)¶ Get a storage’s properties from the specified zenoh router.
Parameters: - stid – the storage identifier
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
Returns: the storage properties
getStorages¶
-
public Map<String, Properties>
getStorages
()¶ Get all the storages from the connected zenoh router.
Throws: - ZException – if an error occurs.
Returns: a map of the storages properties, indexed by the storages identifiers.
getStorages¶
-
public Map<String, Properties>
getStorages
(String zid)¶ Get all the storages from the specified zenoh router.
Parameters: - zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
Returns: a map of the storages properties, indexed by the storages identifiers.
getStoragesFromBackend¶
-
public Map<String, Properties>
getStoragesFromBackend
(String backend)¶ Get all the storages from the specified backend within the connected zenoh router.
Parameters: - backend – the backend identifier.
Throws: - ZException – if an error occurs.
Returns: a map of the storages properties, indexed by the storages identifiers.
getStoragesFromBackend¶
-
public Map<String, Properties>
getStoragesFromBackend
(String backend, String zid)¶ Get all the storages from the specified backend within the specified zenoh router.
Parameters: - backend – the backend identifier.
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
Returns: a map of the storages properties, indexed by the storages identifiers.
removeBackend¶
-
public void
removeBackend
(String beid)¶ Remove a backend from the connected zenoh router (i.e. the one you are directly connected to).
Parameters: - beid – the backend identifier.
Throws: - ZException – if an error occurs.
removeBackend¶
-
public void
removeBackend
(String beid, String zid)¶ Remove a backend from the specified zenoh router, not necessarily the one you are connected to.
Parameters: - beid – the backend identifier.
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.
removeStorage¶
-
public void
removeStorage
(String stid)¶ Remove a storage from the connected zenoh router.
Parameters: - stid – the storage identifier.
Throws: - ZException – if an error occurs.
removeStorage¶
-
public void
removeStorage
(String stid, String zid)¶ Remove a storage from the specified zenoh router.
Parameters: - stid – the storage identifier.
- zid – the zenoh router identifier.
Throws: - ZException – if an error occurs.