jetstream v0.0.1-pre1 Jetstream.Stream

Link to this section Summary

Link to this section Types

Link to this type

stream_response()

Specs

stream_response() :: %{
  state: stream_state(),
  config: t(),
  created: DateTime.t()
}
Link to this type

stream_state()

Specs

stream_state() :: %{
  bytes: non_neg_integer(),
  consumer_count: non_neg_integer(),
  first_seq: non_neg_integer(),
  first_ts: DateTime.t(),
  last_seq: non_neg_integer(),
  last_ts: DateTime.t(),
  messages: non_neg_integer()
}

Specs

streams() :: %{
  limit: non_neg_integer(),
  offset: non_neg_integer(),
  streams: [binary()],
  total: non_neg_integer()
}

Specs

t() :: %Jetstream.Stream{
  discard: :old | :new,
  max_age: integer(),
  max_bytes: integer(),
  max_consumers: integer(),
  max_msg_size: integer(),
  max_msgs: integer(),
  name: binary(),
  num_replicas: pos_integer(),
  retention: :limits | :workqueue | :interest,
  storage: :file | :memory,
  subjects: [binary()]
}

Link to this section Functions

Link to this function

create(conn, stream)

Specs

create(GenServer.t(), t()) :: {:ok, stream_response()} | {:error, any()}

create a new stream, please see https://github.com/nats-io/jetstream#streams for details on supported arguments

Link to this function

delete(conn, stream_name)

Specs

delete(GenServer.t(), binary()) :: :ok | {:error, any()}
Link to this function

info(conn, stream_name)

Specs

info(GenServer.t(), binary()) :: {:ok, stream_response()} | {:error, any()}
Link to this function

list(conn, params \\ [])

Specs

list(GenServer.t(), [{:offset, non_neg_integer()}]) ::
  {:ok, streams()} | {:error, term()}