Skip to content

Commit

Permalink
for #1346... update documentation to make subtopic order dependency e…
Browse files Browse the repository at this point in the history
…xplicit
  • Loading branch information
petersilva committed Dec 18, 2024
1 parent 1c8cd0a commit e5716f8
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/source/Reference/sr3_options.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,9 @@ The broker option tell each component which broker to contact.
Once connected to an AMQP broker, the user needs to bind a queue
to exchanges and topics to determine the notification messages of interest.

This *subtopic* option should appear after the *broker* setting in files
for the setting to apply to a given queue.


bufSize <size> (default: 1MB)
-----------------------------
Expand Down Expand Up @@ -742,6 +745,9 @@ The queue will be written to and recovered from disk if the broker is restarted.
Note: only *persistent* messages will remain in a durable queue after a broker restart.
Persistent messages can be published by enabling the **persistent** option (it is enabled by default).

This *subtopic* option should appear after the *durable* setting in files
for the setting to apply to a given queue.

fileEvents <event,event,...>
----------------------------

Expand Down Expand Up @@ -781,6 +787,9 @@ are uptodate. If the exchange already exists, this flag can be set to False,
so no attempt to exchange the queue is made, or it´s bindings.
These options are useful on brokers that do not permit users to declare their exchanges.

This *subtopic* option should appear after the *exchangeDeclare* setting in files
for the topic bindings to apply to the given queue.



expire <duration> (default: 5m == five minutes. RECOMMEND OVERRIDING)
Expand All @@ -803,6 +812,9 @@ The default is set low because it defines how long resources on the broker will
and in early use (when default was 1 week) brokers would often get overloaded with very
long queues for left-over experiments.

This *subtopic* option should appear after the *expire* setting in files
for the topic bindings to apply to the given queue.


filename <keyword> (default:None)
-----------------------------------
Expand Down Expand Up @@ -1531,6 +1543,9 @@ optimal load sharing, the prefetch should be set as low as possible. However, o
haul links, it is necessary to raise this number, to hide round-trip latency, so a setting
of 10 or more may be needed.

This *subtopic* option should appear after the *prefetch* setting in files
for the setting to apply to a given queue.

queueBind
---------

Expand All @@ -1540,6 +1555,9 @@ are uptodate. If the queue already exists, These flags can be
set to False, so no attempt to declare the queue is made, or it´s bindings.
These options are useful on brokers that do not permit users to declare their queues.

This *subtopic* option should appear after the *queueBind* setting in files
for the setting to apply to a given queue.

queueDeclare
------------

Expand All @@ -1549,6 +1567,9 @@ are uptodate. If the queue already exists, These flags can be
set to False, so no attempt to declare the queue is made, or it´s bindings.
These options are useful on brokers that do not permit users to declare their queues.

This *subtopic* option should appear after the *queueDeclare* setting in files
for the setting to apply to a given queue.

queueName|queue|queue_name|qn
-----------------------------

Expand Down
2 changes: 1 addition & 1 deletion sarracenia/config/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ def __repr__(self) -> str:
# options that apply to queues, and so must appear before subtopic resolves queues characteristics.
#
queue_options = [ 'auto_delete', 'broker', 'durable', 'exchange', 'exchangeSuffix', 'expire', 'message_ttl', 'prefetch', \
'qos', 'queueBind', 'exchangeDeclare' ]
'qos', 'queueBind', 'queueDeclare' ]

size_options = ['accelThreshold', 'blockSize', 'bufSize', 'byteRateMax', 'fileSizeMax', 'inlineByteMax']

Expand Down

0 comments on commit e5716f8

Please sign in to comment.