KubeMQ.QueueReceiveResult (kubemq v1.0.1)

Copy Markdown View Source

Result of receiving messages from a queue via the Simple API.

Fields

  • request_id (String.t()) — Request identifier.
  • messages ([KubeMQ.QueueMessage.t()]) — List of received messages.
  • messages_received (non_neg_integer()) — Number of messages received.
  • messages_expired (non_neg_integer()) — Number of messages that expired during the request.
  • is_peek (boolean()) — Whether this was a peek operation (messages not consumed).
  • is_error (boolean()) — Whether the receive operation failed.

  • error (String.t() | nil) — Error message if is_error is true.

Summary

Types

t()

Functions

from_transport(result)
new(opts \\ [])

Types

t()

@type t() :: %KubeMQ.QueueReceiveResult{
  error: String.t() | nil,
  is_error: boolean(),
  is_peek: boolean(),
  messages: [KubeMQ.QueueMessage.t()],
  messages_expired: non_neg_integer(),
  messages_received: non_neg_integer(),
  request_id: String.t()
}

Functions

from_transport(result)

@spec from_transport(map()) :: t()

new(opts \\ [])

@spec new(keyword()) :: t()