Zenohex.Publisher (Zenohex v0.7.1)

Interface for publishing data via native Zenoh publishers.

This module provides functions to send data using a previously declared publisher and to undeclare it when no longer needed.

Summary

delete_opts()

id()

put_opts()

Sends a kind: :delete sample using the specified publisher.

Sends a kind: :put sample with binary payload using the specified publisher.

undeclare(id)

Undeclares the publisher identified by the given ID.

@type delete_opts() :: [
  attachment: binary() | nil,
  timestamp: Zenohex.Session.zenoh_timestamp_string()
]

@type id() :: reference()

@type put_opts() :: [
  attachment: binary() | nil,
  encoding: String.t(),
  timestamp: Zenohex.Session.zenoh_timestamp_string()
]

@spec delete(id(), delete_opts()) :: :ok | {:error, reason :: term()}

Sends a kind: :delete sample using the specified publisher.

@spec put(id(), binary(), put_opts()) :: :ok | {:error, reason :: term()}

Sends a kind: :put sample with binary payload using the specified publisher.

@spec undeclare(id()) :: :ok | {:error, reason :: term()}

Undeclares the publisher identified by the given ID.