From 87c3b7c9ce7aaf6dadef24d3a371021338ebdcf7 Mon Sep 17 00:00:00 2001 From: Ilan Steemers Date: Sun, 6 Sep 2015 16:22:06 +0200 Subject: [PATCH] docs: minor changes --- docs/brokers.rst | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/brokers.rst b/docs/brokers.rst index e8b487f..c488071 100644 --- a/docs/brokers.rst +++ b/docs/brokers.rst @@ -3,7 +3,7 @@ Brokers The broker sits between your Django instances and your Django Q cluster instances, accepting and delivering task packages. Currently we only support Redis and Disque, but support for other brokers is being worked on. -Even though `Disque `__ is still considered Alpha software, it's been gathering a lot of support and test results are positive. +Even though `Disque `__ is still considered to be in alpha, it's been gathering a lot of support and test results are positive. Clients for `Amazon SQS `__ and `IronMQ `__ are being tested. @@ -15,7 +15,7 @@ The default broker for Django Q clusters is `Redis `__. * Atomic * Does not need separate cache framework for monitoring * Can use existing `Django-Redis `__ connections through the :ref:`django_redis` setting -* Requires `Redis-py `__ as a client +* Requires `Redis-py `__ * Does not support receipts Can be configured with :ref:`redis_configuration` configuration settings or :ref:`django_redis`. @@ -26,24 +26,15 @@ Disque Unlike Redis, Disque supports message receipts which make delivery to the cluster workers guaranteed. If a task never produces a failed or successful result, it will automatically be sent to the cluster again for a retry. You can control the amount of time Disque should wait for completion of a task by configuring the :ref:`retry` setting. -* Supports receipts +* Delivery receipts * Atomic * Needs Django's `Cache framework `__ configured for monitoring * Compatible with `Tynd `__ Disque addon on `Heroku `__ * Still considered Alpha software -* Requires `Redis-py `__ as a client +* Requires `Redis-py `__ See the :ref:`disque_configuration` configuration section for more info. -Amazon SQS ----------- -*TBA* - - -Iron MQ -------- -*TBA* - Reference --------- The :class:`Broker` class is used internally to communicate with the different types of brokers.