Skip to content

Commit 44974d8

Browse files
committed
documentation: add description of the queue settings
Follows up #85
1 parent 22beecb commit 44974d8

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ align="right">
2525
* [Using the queue module](#using-the-queue-module)
2626
* [Initialization](#initialization)
2727
* [Creating a new queue](#creating-a-new-queue)
28+
* [Set queue settings](#set-queue-settings)
2829
* [Putting a task in a queue](#putting-a-task-in-a-queue)
2930
* [Taking a task from the queue ("consuming")](#taking-a-task-from-the-queue-consuming)
3031
* [Acknowledging the completion of a task](#acknowledging-the-completion-of-a-task)
@@ -357,6 +358,18 @@ created.
357358

358359
Example: `queue.create_tube('list_of_sites', 'fifo', {temporary = true})`
359360

361+
## Set queue settings
362+
363+
```lua
364+
queue.set_settings({options})
365+
```
366+
367+
Set queue settings.
368+
In case of failure, an error will be thrown.
369+
Available `options`:
370+
`ttr` - time to release in seconds. The time after which, if there is no active
371+
connection in the session, it will be released with all its tasks.
372+
360373
## Putting a task in a queue
361374

362375
To insert a new task into a queue, use:

0 commit comments

Comments
 (0)