From 58d6962f9f101995eac1e85ff4551ccf02fe4623 Mon Sep 17 00:00:00 2001 From: Ask Solem Date: Fri, 28 Jan 2011 22:46:32 +0100 Subject: Rendered documentation for Github Pages. --- reference/kombu.messaging.html | 133 ++------------------------------------ reference/kombu.utils.compat.html | 2 +- 2 files changed, 6 insertions(+), 129 deletions(-) (limited to 'reference') diff --git a/reference/kombu.messaging.html b/reference/kombu.messaging.html index efd54360..98edfb9c 100644 --- a/reference/kombu.messaging.html +++ b/reference/kombu.messaging.html @@ -95,9 +95,10 @@ compression.
  • auto_declare – Automatically declare the exchange at instantiation. Default is True.
  • on_return – Callback to call for undeliverable messages, -when the mandatory or imediate arguments to +when the mandatory or immediate arguments to publish() is used. This callback needs the following -signature: (exception, exchange, routing_key, message).
    • +signature: (exception, exchange, routing_key, message). +Note that the producer needs to drain events to use this feature. @@ -112,131 +113,7 @@ signature: (exception, exchange, routing_key, message).
    exchange
    -

    An Exchange declaration.

    - --- - - - -
    Parameters: -
    -
    -
    -name
    -

    Name of the exchange. Default is no name (the default exchange).

    -
    - -
    -
    -type
    -

    AMQP defines four default exchange types (routing algorithms) that -covers most of the common messaging use cases. An AMQP broker can -also define additional exchange types, so see your broker -manual for more information about available exchange types.

    -
    -
      -

    • direct (default)

      -
      -

      Direct match between the routing key in the message, and the -routing criteria used when a queue is bound to this exchange.

      -
      -
      • -

    • topic

      -
      -

      Wildcard match between the routing key and the routing pattern -specified in the exchange/queue binding. The routing key is -treated as zero or more words delimited by ”.” and -supports special wildcard characters. “*” matches a -single word and “#” matches zero or more words.

      -
      -
      • -

    • fanout

      -
      -

      Queues are bound to this exchange with no arguments. Hence any -message sent to this exchange will be forwarded to all queues -bound to this exchange.

      -
      -
      • -

    • headers

      -
      -

      Queues are bound to this exchange with a table of arguments -containing headers and values (optional). A special argument -named “x-match” determines the matching algorithm, where -“all” implies an AND (all pairs must match) and -“any” implies OR (at least one pair must match).

      -

      arguments is used to specify the arguments.

      -
      -
      • -
    -

    This description of AMQP exchange types was shamelessly stolen -from the blog post AMQP in 10 minutes: Part 4 by -Rajith Attapattu. This article is recommended reading.

    -
    -
    - -
    -
    -channel
    -

    The channel the exchange is bound to (if bound).

    -
    - -
    -
    -durable
    -

    Durable exchanges remain active when a server restarts. Non-durable -exchanges (transient exchanges) are purged when a server restarts. -Default is True.

    -
    - -
    -
    -auto_delete
    -

    If set, the exchange is deleted when all queues have finished -using it. Default is False.

    -
    - -
    -
    -delivery_mode
    -

    The default delivery mode used for messages. The value is an integer, -or alias string.

    -
    -
      -

    • 1 or “transient”

      -
      -

      The message is transient. Which means it is stored in -memory only, and is lost if the server dies or restarts.

      -
      -
      • -
    • -
      2 or “persistent” (default)
      -

      The message is persistent. Which means the message is -stored both in-memory, and on disk, and therefore -preserved if the server dies or restarts.

      -
      -
      -
      • -
    -
    -

    The default value is 2 (persistent).

    -
    - -
    -
    -arguments
    -

    Additional arguments to specify when the exchange is declared.

    -
    - +

    Default exchange.

    @@ -292,7 +169,7 @@ is set to T Parameters:
    • body – Message body.
    • routing_key – Message routing key.
      • -
    • delivery_mode – See delivery_mode.
      • +
    • delivery_mode – See delivery_mode.
    • mandatory – Currently not supported.
    • immediate – Currently not supported.
    • priority – Message priority. A number between 0 and 9.
      • diff --git a/reference/kombu.utils.compat.html b/reference/kombu.utils.compat.html index d6989c3a..86b42726 100644 --- a/reference/kombu.utils.compat.html +++ b/reference/kombu.utils.compat.html @@ -104,7 +104,7 @@ and values equal to v (which defaults to None).

      -pop(key, default=<object object at 0x102a539b0>)
      +pop(key, default=<object object at 0x1022308d0>)
      -- cgit v1.2.1