Skip to content

Commit 08882b6

Browse files
committed
readme: add description of new methods
1 parent f75d2fc commit 08882b6

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ align="right">
3737
* [Kicking a number of tasks](#kicking-a-number-of-tasks)
3838
* [Deleting a task](#deleting-a-task)
3939
* [Dropping a queue](#dropping-a-queue)
40+
* [Releasing all taken tasks](#releasing-all-taken-tasks)
4041
* [Getting statistics](#getting-statistics)
4142
* [Implementation details](#implementation-details)
4243
* [Queue drivers](#queue-drivers)
@@ -625,6 +626,14 @@ Reverse the effect of a `create` request.
625626
Effect: remove the tuple from the `_queue` space,
626627
and drop the space associated with the queue.
627628

629+
## Releasing all taken tasks
630+
631+
```lua
632+
queue.tube.tube_name:release_all()
633+
```
634+
635+
Forcibly returns all taken tasks to a ready state.
636+
628637
## Getting statistics
629638

630639
```lua
@@ -707,9 +716,11 @@ Driver class must implement the following API:
707716
* a callback to notify the main queue framework on a task state change
708717
(`on_task_change`)
709718
* options of the queue (a Lua table)
710-
1. `create_space` - creates the supporting space. The arguments are:
719+
2. `create_space` - creates the supporting space. The arguments are:
711720
* space name
712721
* space options
722+
3. `start` - starts the driver fibers, if any.
723+
4. `stop` - stops the driver fibers, if any.
713724

714725
To sum up, when the user creates a new queue, the queue framework
715726
passes the request to the driver, asking it to create a space to

0 commit comments

Comments
 (0)