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

Closes a session.

Releases all resources associated with the given session_id. After calling this function, the session_id must not be used again.

Parameters

• session_id : The session identifier returned by open/1.

@spec declare_publisher(session_id :: id(), String.t(), publisher_opts()) ::
  {:ok, publisher_id :: Zenohex.Publisher.id()} | {:error, reason :: term()}

Declares a publisher associated with the given session and key_expr.

Parameters

• session_id: Identifier of the session returned by open/0 or open/1.
• key_expr: Key expression to publish under.
• opts: Options for configuring the publisher.

@spec declare_querier(session_id :: id(), String.t(), querier_opts()) ::
  {:ok, querier_id :: Zenohex.Querier.id()} | {:error, reason :: term()}

Declares a reusable querier associated with the given session and key_expr.

Unlike get/4, which performs a one-shot query, a querier keeps the declaration alive and can execute multiple Zenohex.Querier.get/3 calls with different per-request options.

Parameters

• session_id: Identifier of the session returned by open/0 or open/1.
• key_expr: Key expression to query under.
• opts: Options for configuring the reusable querier.

@spec declare_queryable(session_id :: id(), String.t(), pid(), queryable_opts()) ::
  {:ok, queryable_id :: Zenohex.Queryable.id()} | {:error, reason :: term()}

Declares a queryable for the specified key_expr.

Parameters

• session_id: Identifier of the session returned by open/0 or open/1.
• key_expr: Key expression that the queryable will handle.
• pid: Process to receive query messages. Defaults to the calling process.
  • Messages are delivered as Zenohex.Query
• opts: Options for configuring the queryable.

@spec declare_subscriber(session_id :: id(), String.t(), pid(), subscriber_opts()) ::
  {:ok, subscriber_id :: Zenohex.Subscriber.id()} | {:error, reason :: term()}

Declares a subscriber for the specified key_expr.

Parameters

• session_id: Identifier of the session returned by open/0 or open/1.
• key_expr: Key expression to subscribe to.
• pid: Process to receive subscription messages. Defaults to the calling process.
  • Messages are delivered as Zenohex.Sample.
• opts: Options for configuring the subscriber.

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

Deletes data matching the given key_expr.

Parameters

• session_id : The session identifier returned by open/0 or open/1.
• key_expr : The key expression to delete.
• opts : Options for the delete operation.

Examples

iex> {:ok, session_id} = Zenohex.Session.open()
iex> Zenohex.Session.delete(session_id, "key/expr")
:ok

@spec get(session_id :: id(), String.t(), non_neg_integer(), get_opts()) ::
  {:ok, [Zenohex.Sample.t() | Zenohex.Query.ReplyError.t()]}
  | {:error, :timeout}
  | {:error, reason :: term()}

Query data with the given selector.

Parameters

• session_id : The session identifier returned by open/0 or open/1.
• selector : The selector to query.
• timeout : Timeout in milliseconds to wait for query replies.
• opts : Options for the get operation.

Examples

iex> {:ok, session_id} = Zenohex.Session.open()
iex> Zenohex.Session.get(session_id, "key/expr")
{:ok, [%Zenohex.Sample{}]}

@spec info(session_id :: id()) ::
  {:ok, Zenohex.Session.Info.t()} | {:error, reason :: term()}

Get information about the zenoh Session.

Parameters

• session_id : The session identifier returned by open/0 or open/1.

Examples

iex> {:ok, session_id} = Zenohex.Session.open()
iex> {:ok, %Zenohex.Session.Info{}} = Zenohex.Session.info(session_id)

@spec new_timestamp(session_id :: id()) ::
  {:ok, zenoh_timestamp_string()} | {:error, reason :: term()}

New zenoh timestamp string associated with the given session.

Parameters

• session_id : The session identifier returned by open/0 or open/1.

Examples

iex> {:ok, session_id} = Zenohex.Session.open()
iex> {:ok, zenoh_timestamp} = Zenohex.Session.new_timestamp(session_id)
iex> [timestamp, zenoh_id_string] = String.split(zenoh_timestamp, "/")
iex> {:ok, %DateTime{}, 0} = DateTime.from_iso8601(timestamp)

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

Opens a session using Zenoh default config.

Internally opens a session via open/1, using Zenohex.Config.default/0.

@spec open(String.t() | map()) ::
  {:ok, session_id :: id()} | {:error, reason :: term()}

Opens a session with the given configuration.

You can pass either:

• a JSON5 string (JSON is supported as a subset of JSON5), or
• an Elixir map.

When a map is provided, it is first normalized and validated via Zenohex.ConfigMap.merge/2, then encoded to JSON and passed to the NIF.

Parameters

• config : A JSON5 string or Elixir map representing the Zenoh configuration.

Examples

iex> {:ok, session_id} =
...> File.read!("test/support/fixtures/DEFAULT_CONFIG.json5") |>
...> Zenohex.Session.open()

iex> {:ok, session_id} = Zenohex.ConfigMap.default() |> Zenohex.Session.open()

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

Publishes a payload to the given key_expr within an open session.

This function sends a value (as a binary) to the specified key expression.

Parameters

• session_id : The session identifier returned by open/0 or open/1.
• key_expr : The key expression to publish to.
• payload : The value to publish, as a binary.
• opts : Options for the publish operation.

Examples

iex> {:ok, session_id} = Zenohex.Session.open()
iex> Zenohex.Session.put(session_id, "key/expr", "payload")
:ok