Skip to content

Commit 8e43605

Browse files
committed
Update documentation to cover sync queue
1 parent 68805a7 commit 8e43605

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

docs/configuration.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Configure the Bundle
22
====================
33

44
The bundle allows you to specify different Message Queue providers - however,
5-
Amazon AWS and IronMQ are the only ones currently supported.
5+
Amazon AWS and IronMQ are the only ones currently supported. Blocking, synchronous queues
6+
are also supported through the ``sync`` driver to aid development and debugging.
67

78
We are actively looking to add more and would be more than happy to accept contributions.
89

@@ -22,6 +23,7 @@ For specific instructions on how to configure each provider, please view their d
2223

2324
aws-provider
2425
iron-mq-provider
26+
sync-provider
2527

2628
Caching
2729
-------
@@ -113,7 +115,7 @@ A working configuration would look like the following
113115
project_id: YOUR_IRONMQ_PROJECT_ID_HERE
114116
queues:
115117
my_queue_key:
116-
provider: ironmq #or aws
118+
provider: ironmq #or aws or sync
117119
options:
118120
queue_name: my_actual_queue_name
119121
push_notifications: true

docs/sync-provider.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Sync Provider
2+
-------------
3+
4+
The sync provider immediately dispatches and resolves queued events. It is not intended
5+
for production use but instead to support local development, debugging and testing
6+
of queue-based code paths.
7+
8+
Configuration
9+
^^^^^^^^^^^^^
10+
11+
To use the sync queue, set the ``provider`` of a given queue to ``sync``. No further
12+
configuration is necessary.
13+
14+
.. code-block:: yaml
15+
16+
#app/config_dev.yml
17+
18+
uecode_qpush:
19+
queues:
20+
my_queue_name:
21+
provider: sync

0 commit comments

Comments
 (0)