# Kombu v0.1.0 - Table of Contents

> Elixir port of the Python Celery Kombu messaging library with byte-for-byte wire-format and Redis transport compatibility.

## Pages

- [Kombu for Elixir](readme.md)
- [LICENSE](license.md)

## Modules

- [Kombu](Kombu.md): Top-level facade for the Kombu messaging library for Elixir.
- [Kombu.Binding](Kombu.Binding.md): Represents a queue or exchange binding (`kombu.entity.binding`).

- [Kombu.Broadcast](Kombu.Broadcast.md): Convenience module for creating broadcast queues (`kombu.common.Broadcast`).
- [Kombu.Channel](Kombu.Channel.md): Unified dispatch interface for Kombu channels (Virtual, Memory, Redis, or test mocks).
- [Kombu.Clocks](Kombu.Clocks.md): Logical clocks and synchronization matching `kombu.clocks`.

- [Kombu.Clocks.LamportClock](Kombu.Clocks.LamportClock.md): Lamport logical clock backed by `:atomics` for lock-free thread/process safety
(`kombu.clocks.LamportClock`).

- [Kombu.Clocks.Timetuple](Kombu.Clocks.Timetuple.md): Event clock tuple (`kombu.clocks.timetuple`).

- [Kombu.Common](Kombu.Common.md): Common Kombu utilities (`kombu.common`), including `maybe_declare/3`,
`send_reply/5`, `collect_replies/4`, `drain_consumer/2`, `itermessages/4`,
`eventloop/2`, and `Kombu.Common.QoS`.

- [Kombu.Common.QoS](Kombu.Common.QoS.md): Process-safe manager for incrementing/decrementing a channel's `prefetch_count`
(`kombu.common.QoS`).

- [Kombu.Compression](Kombu.Compression.md): Message compression and decompression registry matching `kombu.compression`.
- [Kombu.Connection](Kombu.Connection.md): Broker connection (`kombu.Connection`), managing transport resolution, URL parsing,
multi-URL failover (`round-robin` / `shuffle`), lazy connection & default channel creation,
and operation retry (`ensure_connection/2`, `ensure/4`, `autoretry/3`).

- [Kombu.Consumer](Kombu.Consumer.md): Message Consumer (`kombu.Consumer`).
- [Kombu.ConsumerServer](Kombu.ConsumerServer.md): OTP GenServer behavior and base implementation mirroring Python Kombu's
`ConsumerMixin` and `ConsumerProducerMixin`.
- [Kombu.Exceptions](Kombu.Exceptions.md): Exception hierarchy for Kombu, matching Python `kombu.exceptions`.

- [Kombu.Exchange](Kombu.Exchange.md): An Exchange declaration (`kombu.entity.Exchange`).

- [Kombu.Matcher](Kombu.Matcher.md): Pattern matching registry matching `kombu.matcher`.
Supports `glob` (default) and `pcre` matchers.

- [Kombu.Message](Kombu.Message.md): Base class for received messages (`kombu.message.Message` and `kombu.transport.virtual.base.Message`).

- [Kombu.Pidbox](Kombu.Pidbox.md): Generic process mailbox and node routing matching `kombu.pidbox`.
Used by Celery remote control commands (`broadcast`, `inspect`, `ping`, etc.).

- [Kombu.Pidbox.Mailbox](Kombu.Pidbox.Mailbox.md): Process Mailbox (`kombu.pidbox.Mailbox`).

- [Kombu.Pidbox.Node](Kombu.Pidbox.Node.md): Mailbox node routing and command dispatcher (`kombu.pidbox.Node`).

- [Kombu.Pools](Kombu.Pools.md): Connection, Channel, and Producer pools (`kombu.pools`).

- [Kombu.Pools.ChannelPool](Kombu.Pools.ChannelPool.md): Pool of channels (`kombu.connection.ChannelPool`).

- [Kombu.Pools.ConnectionPool](Kombu.Pools.ConnectionPool.md): Pool of `%Kombu.Connection{}` instances (`kombu.connection.ConnectionPool`).

- [Kombu.Pools.ProducerPool](Kombu.Pools.ProducerPool.md): Pool of `%Kombu.Producer{}` instances (`kombu.pools.ProducerPool`).

- [Kombu.Producer](Kombu.Producer.md): Message Producer (`kombu.Producer`).
- [Kombu.Queue](Kombu.Queue.md): A Queue declaration (`kombu.entity.Queue`).

- [Kombu.Resource](Kombu.Resource.md): Generic LIFO resource pool (`kombu.resource.Resource`).

- [Kombu.Serialization](Kombu.Serialization.md): Serializer registry and message payload encoding/decoding matching `kombu.serialization`.

- [Kombu.Simple](Kombu.Simple.md): Simple messaging interface providing `SimpleQueue` (persistent queues)
and `SimpleBuffer` (ephemeral queues).

- [Kombu.Simple.SimpleBuffer](Kombu.Simple.SimpleBuffer.md): Simple API for ephemeral queues.
- [Kombu.Simple.SimpleQueue](Kombu.Simple.SimpleQueue.md): Simple API for persistent queues.
- [Kombu.Transport](Kombu.Transport.md): Transport behaviour and transport alias resolution (`kombu.transport`).

- [Kombu.Transport.Memory](Kombu.Transport.Memory.md): In-memory virtual transport (`kombu.transport.memory`), supporting `direct`,
`topic`, and `fanout` exchanges.

- [Kombu.Transport.Memory.Channel](Kombu.Transport.Memory.Channel.md): In-memory virtual channel process (`kombu.transport.memory.Channel`).

- [Kombu.Transport.Memory.Store](Kombu.Transport.Memory.Store.md): Shared state store for the in-memory transport, holding the `%BrokerState{}`
and in-memory `:queue` queues.

- [Kombu.Transport.Redis](Kombu.Transport.Redis.md): Redis transport (`kombu.transport.redis.Transport`).
- [Kombu.Transport.Redis.Channel](Kombu.Transport.Redis.Channel.md): Redis virtual channel (`kombu.transport.redis.Channel`).
- [Kombu.Transport.Redis.LuaScripts](Kombu.Transport.Redis.LuaScripts.md): Lua scripts used by the Redis transport (`kombu.transport.redis`) for atomic
binding deadline tracking and sweeping of expired queue bindings.

- [Kombu.Transport.Redis.Poller](Kombu.Transport.Redis.Poller.md): Multi-channel event poller for Redis (`kombu.transport.redis.MultiChannelPoller`).
- [Kombu.Transport.Redis.PrefixedClient](Kombu.Transport.Redis.PrefixedClient.md): Redis client wrapper (`kombu.transport.redis.PrefixedStrictRedis` &
`PrefixedRedisPubSub`) that transparently applies `global_keyprefix` to keys,
pipelines, Lua script keys, `BRPOP` keys, and Pub/Sub patterns/channels.

- [Kombu.Transport.Redis.PublishBatch](Kombu.Transport.Redis.PublishBatch.md): Batched Redis publisher (`kombu.transport.redis.PublishBatch`).
- [Kombu.Transport.Redis.QoS](Kombu.Transport.Redis.QoS.md): Redis Ack Emulation (`kombu.transport.redis.QoS`).
- [Kombu.Transport.Virtual.BrokerState](Kombu.Transport.Virtual.BrokerState.md): Holds virtual broker exchanges, bindings, and queue indices
(`kombu.transport.virtual.base.BrokerState`).

- [Kombu.Transport.Virtual.Channel](Kombu.Transport.Virtual.Channel.md): Shared virtual channel operations (`kombu.transport.virtual.base.Channel`).
- [Kombu.Transport.Virtual.Exchange](Kombu.Transport.Virtual.Exchange.md): Virtual AMQ Exchange type implementations (`direct`, `topic`, `fanout`),
ported from `kombu.transport.virtual.exchange`.

- [Kombu.Transport.Virtual.Exchange.Direct](Kombu.Transport.Virtual.Exchange.Direct.md): Direct exchange routing based on exact routing key matches.

- [Kombu.Transport.Virtual.Exchange.Fanout](Kombu.Transport.Virtual.Exchange.Fanout.md): Fanout exchange broadcasting messages to all bound queues.

- [Kombu.Transport.Virtual.Exchange.Topic](Kombu.Transport.Virtual.Exchange.Topic.md): Topic exchange routing based on dot-separated words with `*` and `#` wildcards.

- [Kombu.Transport.Virtual.QoS](Kombu.Transport.Virtual.QoS.md): Virtual channel Quality of Service (`kombu.transport.virtual.base.QoS`).
Manages `prefetch_count` limits and unacknowledged message tracking/restoration.

- [Kombu.Utils.JSON](Kombu.Utils.JSON.md): Extended JSON serialization utilities matching `kombu.utils.json`.
- [Kombu.Utils.JSON.Bytes](Kombu.Utils.JSON.Bytes.md): Explicit wrapper for raw bytes when a UTF-8 binary should be tagged as `{"__type__": "bytes"}`.

- [Kombu.Utils.Limits](Kombu.Utils.Limits.md): Token bucket rate limiting matching `kombu.utils.limits`.

- [Kombu.Utils.Limits.TokenBucket](Kombu.Utils.Limits.TokenBucket.md): Token Bucket rate limiter (`kombu.utils.limits.TokenBucket`).

- [Kombu.Utils.Retry](Kombu.Utils.Retry.md): Functional utilities, LRU cache, and retry helpers matching `kombu.utils.functional`
and `kombu.utils.time`.

- [Kombu.Utils.Retry.LRUCache](Kombu.Utils.Retry.LRUCache.md): Least-Recently-Used (LRU) bounded cache (`kombu.utils.functional.LRUCache`).

- [Kombu.Utils.Scheduling](Kombu.Utils.Scheduling.md): Scheduling and resource cycling utilities matching `kombu.utils.scheduling`.

- [Kombu.Utils.Scheduling.Cycle](Kombu.Utils.Scheduling.Cycle.md): Polling cycle implementation supporting `:round_robin`, `:priority`, and `:sorted`
(`kombu.utils.scheduling.round_robin_cycle`, `priority_cycle`, `sorted_cycle`).

- [Kombu.Utils.Scheduling.FairCycle](Kombu.Utils.Scheduling.FairCycle.md): Cycle fairly between resources (`kombu.utils.scheduling.FairCycle`).

- [Kombu.Utils.URL](Kombu.Utils.URL.md): URL parsing and sanitization utilities matching `kombu.utils.url`.

- [Kombu.Utils.URL.Parts](Kombu.Utils.URL.Parts.md): Struct representing parsed URL components (`kombu.utils.url.urlparts`).

- [Kombu.Utils.UUID](Kombu.Utils.UUID.md): UUID generation and representation utilities, matching `kombu.utils.uuid`
and `kombu.common.oid_from`.

- Exceptions
  - [Kombu.BatchPublishError](Kombu.BatchPublishError.md)
  - [Kombu.ChannelError](Kombu.ChannelError.md)
  - [Kombu.ChannelLimitExceeded](Kombu.ChannelLimitExceeded.md)
  - [Kombu.ChannelLimitExceededError](Kombu.ChannelLimitExceededError.md)
  - [Kombu.ConnectionError](Kombu.ConnectionError.md)
  - [Kombu.ConnectionLimitExceeded](Kombu.ConnectionLimitExceeded.md)
  - [Kombu.ConnectionLimitExceededError](Kombu.ConnectionLimitExceededError.md)
  - [Kombu.ContentDisallowedError](Kombu.ContentDisallowedError.md)
  - [Kombu.DecodeError](Kombu.DecodeError.md)
  - [Kombu.Empty](Kombu.Empty.md)
  - [Kombu.EncodeError](Kombu.EncodeError.md)
  - [Kombu.Exceptions.DisallowedSerializerError](Kombu.Exceptions.DisallowedSerializerError.md)
  - [Kombu.InconsistencyError](Kombu.InconsistencyError.md)
  - [Kombu.KombuError](Kombu.KombuError.md)
  - [Kombu.LimitExceeded](Kombu.LimitExceeded.md)
  - [Kombu.LimitExceededError](Kombu.LimitExceededError.md)
  - [Kombu.MatcherNotInstalledError](Kombu.MatcherNotInstalledError.md)
  - [Kombu.MessageStateError](Kombu.MessageStateError.md)
  - [Kombu.NotBoundError](Kombu.NotBoundError.md)
  - [Kombu.NotEquivalentError](Kombu.NotEquivalentError.md)
  - [Kombu.NotImplementedError](Kombu.NotImplementedError.md)
  - [Kombu.OperationalError](Kombu.OperationalError.md)
  - [Kombu.ResourceError](Kombu.ResourceError.md)
  - [Kombu.SerializationError](Kombu.SerializationError.md)
  - [Kombu.SerializerNotInstalledError](Kombu.SerializerNotInstalledError.md)
  - [Kombu.TimeoutError](Kombu.TimeoutError.md)
  - [Kombu.VersionMismatchError](Kombu.VersionMismatchError.md)