View Source Zenohex.Query (Zenohex v0.3.0)

Documentation for Elixir.Zenohex.Query.

Structs received by a Zenohex.Queryable.recv_timeout/1.

Summary

Types

t()

Functions

finish_reply(query)

Finish reply.

reply(query, sample)

Sends a reply to this Query. User can call reply/2 multiple times to send multiple samples.

Types

t()

@type t() :: %Zenohex.Query{
  key_expr: String.t(),
  parameters: String.t(),
  reference: reference(),
  value: binary() | integer() | float() | :undefined
}

Functions

finish_reply(query)

@spec finish_reply(t()) :: :ok | {:error, reason :: any()}

Finish reply.

Warning

finish_reply/1 must be called after reply/2.

reply(query, sample)

@spec reply(t(), Zenohex.Sample.t()) :: :ok | {:error, reason :: any()}

Sends a reply to this Query. User can call reply/2 multiple times to send multiple samples.

Warning

Do not forget to call finish_reply/1 to finish the reply.