# kubemq v1.0.1 - Table of Contents

KubeMQ Elixir SDK — Kubernetes-native messaging client for events, commands, queries, and queues via gRPC

## Pages

- [KubeMQ Elixir SDK](readme.md)
- [Changelog](changelog.md)
- [Messaging Concepts](concepts.md)
- [Troubleshooting](troubleshooting.md)
- [Compatibility](compatibility.md)

## Modules

- Core
  - [KubeMQ](KubeMQ.md): KubeMQ Elixir SDK — Kubernetes-native messaging client.
  - [KubeMQ.Client](KubeMQ.Client.md): Main KubeMQ client GenServer — primary API surface for all messaging patterns.
  - [KubeMQ.Error](KubeMQ.Error.md): KubeMQ error type with error codes, retryability, and gRPC status mapping.
  - [KubeMQ.ServerInfo](KubeMQ.ServerInfo.md): Server information returned from a Ping request.
  - [KubeMQ.Subscription](KubeMQ.Subscription.md): Handle for an active subscription. Provides cancellation and status checking.

- Events
  - [KubeMQ.Event](KubeMQ.Event.md): Event message for the KubeMQ Pub/Sub pattern.
  - [KubeMQ.EventReceive](KubeMQ.EventReceive.md): Received event from a KubeMQ Pub/Sub subscription.
  - [KubeMQ.EventStreamHandle](KubeMQ.EventStreamHandle.md): Handle for streaming events via a bidirectional gRPC stream.

- Events Store
  - [KubeMQ.EventStore](KubeMQ.EventStore.md): Persistent event message for the KubeMQ Events Store pattern.
  - [KubeMQ.EventStoreReceive](KubeMQ.EventStoreReceive.md): Received event from a KubeMQ Events Store subscription.
  - [KubeMQ.EventStoreResult](KubeMQ.EventStoreResult.md): Result of sending a persistent event to KubeMQ Events Store.
  - [KubeMQ.EventStoreStreamHandle](KubeMQ.EventStoreStreamHandle.md): Handle for streaming persistent events with awaitable confirmation.

- Commands
  - [KubeMQ.Command](KubeMQ.Command.md): Command message for the KubeMQ RPC pattern.
  - [KubeMQ.CommandReceive](KubeMQ.CommandReceive.md): Received command from a KubeMQ command subscription.
  - [KubeMQ.CommandReply](KubeMQ.CommandReply.md): Reply constructed by a command subscriber to respond to a received command.
  - [KubeMQ.CommandResponse](KubeMQ.CommandResponse.md): Response received after sending a command via `KubeMQ.Client.send_command/2`.

- Queries
  - [KubeMQ.Query](KubeMQ.Query.md): Query message for the KubeMQ RPC pattern with optional response caching.
  - [KubeMQ.QueryReceive](KubeMQ.QueryReceive.md): Received query from a KubeMQ query subscription.
  - [KubeMQ.QueryReply](KubeMQ.QueryReply.md): Reply constructed by a query subscriber to respond to a received query.
  - [KubeMQ.QueryResponse](KubeMQ.QueryResponse.md): Response received after sending a query via `KubeMQ.Client.send_query/2`.

- Queues
  - [KubeMQ.PollRequest](KubeMQ.PollRequest.md): Request parameters for polling queue messages via the Stream API.
  - [KubeMQ.PollResponse](KubeMQ.PollResponse.md): Response from polling queue messages, with transaction management methods.
  - [KubeMQ.QueueAckAllResult](KubeMQ.QueueAckAllResult.md): Result of acknowledging all messages in a queue.
  - [KubeMQ.QueueAttributes](KubeMQ.QueueAttributes.md): Server-populated attributes attached to received queue messages.
  - [KubeMQ.QueueBatchResult](KubeMQ.QueueBatchResult.md): Result of sending a batch of queue messages.
  - [KubeMQ.QueueMessage](KubeMQ.QueueMessage.md): Message for the KubeMQ Queues pattern.
  - [KubeMQ.QueuePolicy](KubeMQ.QueuePolicy.md): Delivery policy for queue messages.
  - [KubeMQ.QueueReceiveResult](KubeMQ.QueueReceiveResult.md): Result of receiving messages from a queue via the Simple API.
  - [KubeMQ.QueueSendResult](KubeMQ.QueueSendResult.md): Result of sending a queue message.
  - [KubeMQ.QueueUpstreamHandle](KubeMQ.QueueUpstreamHandle.md): Handle for sending queue messages via a bidirectional upstream stream.

- Channel Management
  - [KubeMQ.ChannelInfo](KubeMQ.ChannelInfo.md): Information about a KubeMQ channel returned from list operations.

- Broadway
  - [KubeMQ.Broadway.Events](KubeMQ.Broadway.Events.md): Broadway producer for KubeMQ Events (Pub/Sub).
  - [KubeMQ.Broadway.EventsStore](KubeMQ.Broadway.EventsStore.md): Broadway producer for KubeMQ Events Store (Persistent Pub/Sub).
  - [KubeMQ.Broadway.Queues](KubeMQ.Broadway.Queues.md): Broadway producer for KubeMQ Queues.

- Authentication
  - [KubeMQ.CredentialProvider](KubeMQ.CredentialProvider.md): Behaviour for providing authentication credentials to KubeMQ.
  - [KubeMQ.StaticTokenProvider](KubeMQ.StaticTokenProvider.md): Static token credential provider for KubeMQ authentication.

- Configuration
  - [KubeMQ.Config](KubeMQ.Config.md): Configuration for KubeMQ client connections via NimbleOptions.
  - [KubeMQ.ReconnectPolicy](KubeMQ.ReconnectPolicy.md): Reconnection policy for the KubeMQ connection GenServer.
  - [KubeMQ.RetryPolicy](KubeMQ.RetryPolicy.md): Retry policy for transient gRPC errors.
  - [KubeMQ.TLS](KubeMQ.TLS.md): TLS configuration for KubeMQ gRPC connections.

