KubeMQ.PollRequest (kubemq v1.0.1)

Copy Markdown View Source

Request parameters for polling queue messages via the Stream API.

Fields

  • channel (String.t()) — Queue channel to poll from.
  • max_items (pos_integer()) — Maximum number of messages to receive. Default: 1.
  • wait_timeout (pos_integer()) — How long to wait for messages in milliseconds. Default: 5_000.
  • auto_ack (boolean()) — Automatically acknowledge messages on receive. Default: false.

Summary

Types

t()

Functions

new(opts \\ [])

Types

t()

@type t() :: %KubeMQ.PollRequest{
  auto_ack: boolean(),
  channel: String.t(),
  max_items: pos_integer(),
  wait_timeout: pos_integer()
}

Functions

new(opts \\ [])

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