# celery v0.1.0 - Table of Contents

> Elixir port of Python's Celery distributed task queue — wire-compatible with
Python Celery (Protocol v1 & v2) and backed by Kombu and Redis for transport
and result storage.

## Pages

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

## Modules

- [Celery.Task.Definition](Celery.Task.Definition.md): Metadata and binding specification for a registered Celery task.

- Core
  - [Celery](Celery.md): Elixir port of Python's Celery distributed task queue (`celery.Celery`),
wire-compatible with Python Celery (Protocol v1 & v2) and backed by Kombu and Redis
for transport and result storage.
  - [Celery.Config](Celery.Config.md): Celery configuration structure and defaults (ported from `celery.app.defaults`).
  - [Celery.Registry](Celery.Registry.md): Task registry for Celery applications (ported from `celery.app.registry.TaskRegistry`).
  - [Celery.States](Celery.States.md): Built-in Celery task states and precedence rules (ported from `celery.states`).

- Tasks & Canvas
  - [Celery.Canvas](Celery.Canvas.md): Celery Canvas workflow primitives (`signature`, `chain`, `group`, `chord`)
compatible with Python Celery's wire protocol.

  - [Celery.Canvas.Signature](Celery.Canvas.Signature.md): Serializable task invocation signature (`celery.canvas.Signature` / `subtask`).
  - [Celery.Task](Celery.Task.md): Celery Task behaviour, `@task` attribute decorator, `deftask` macro, and runtime `self` struct
(ported from `celery.app.task.Task`).
  - [Celery.Task.Context](Celery.Task.Context.md): Task execution request context (`self.request` in Python Celery, ported from `celery.app.task.Context`).

- Worker & Protocol
  - [Celery.AMQP](Celery.AMQP.md): AMQP / Kombu task routing, queue configuration, and task message publishing
(ported from `celery.app.amqp`).

  - [Celery.Protocol](Celery.Protocol.md): Celery Task Message Protocol v1 and v2 encoder and decoder (ported from `celery.app.amqp`
and `celery.worker.request`).
  - [Celery.Tracer](Celery.Tracer.md): Task execution tracer (ported from `celery.app.trace.build_tracer`).
  - [Celery.Worker](Celery.Worker.md): Celery Worker / Consumer OTP `GenServer` (ported from `celery.worker`).
  - [Celery.Worker.Control](Celery.Worker.Control.md): Remote control and inspection commands for Celery workers over `Kombu.Pidbox`
(ported from `celery.worker.control` and `celery.app.control`).
  - [Celery.Worker.Request](Celery.Worker.Request.md): Worker task request wrapper (ported from `celery.worker.request.Request`).

- Result Store
  - [Celery.Backend.Redis](Celery.Backend.Redis.md): Redis result store backend for Celery (ported from `celery.backends.redis.RedisBackend`
and `celery.backends.base.KeyValueStoreBackend`).
  - [Celery.Result](Celery.Result.md): Task result handle (`AsyncResult` in Python Celery, ported from `celery.result.AsyncResult`).
  - [Celery.Result.GroupResult](Celery.Result.GroupResult.md): Result handle for a group of tasks (`GroupResult` in Python Celery).

- Exceptions
  - [Celery.BackendStoreError](Celery.BackendStoreError.md): An issue writing or reading from the result backend.
  - [Celery.ChordError](Celery.ChordError.md): A task part of the chord raised an exception.
  - [Celery.Error](Celery.Error.md): Base Celery error.
  - [Celery.Ignore](Celery.Ignore.md): Exception that a task may raise to ignore the task without recording a result or failure.

  - [Celery.InvalidTaskError](Celery.InvalidTaskError.md): The task has invalid arguments or options.
  - [Celery.MaxRetriesExceededError](Celery.MaxRetriesExceededError.md): The task's max_retries limit was exceeded.
  - [Celery.NotRegistered](Celery.NotRegistered.md): The task is not registered in the Celery registry.
  - [Celery.Reject](Celery.Reject.md): Exception that a task may raise to reject the message via AMQP/Kombu `reject` (`requeue: true | false`).

  - [Celery.RemoteError](Celery.RemoteError.md): Exception reconstructed from a remote task failure stored in the Redis result backend.

  - [Celery.Retry](Celery.Retry.md): Exception raised by `Celery.Task.retry/2` to signal that the task is to be retried later.

  - [Celery.TaskRevokedError](Celery.TaskRevokedError.md): The task has been revoked.
  - [Celery.TimeoutError](Celery.TimeoutError.md): The operation timed out waiting for a result or task execution.