Skip to content

Commit 12e270c

Browse files
author
Juuso Mäyränen
committed
Update docs
1 parent f7ef5fd commit 12e270c

File tree

1 file changed

+42
-6
lines changed

1 file changed

+42
-6
lines changed

docs/index.asciidoc

+42-6
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,14 @@ Redis allows for the renaming or disabling of commands in its protocol, see: ht
8484
===== `data_type`
8585

8686
* This is a required setting.
87-
* Value can be any of: `list`, `channel`, `pattern_channel`
87+
* Value can be any of: `list`, `pattern_list`, `channel`, `pattern_channel`
8888
* There is no default value for this setting.
8989

9090
Specify either list or channel. If `data_type` is `list`, then we will BLPOP the
91-
key. If `data_type` is `channel`, then we will SUBSCRIBE to the key.
92-
If `data_type` is `pattern_channel`, then we will PSUBSCRIBE to the key.
91+
key. If `data_type` is `pattern_list`, then we will spawn a number of worker
92+
threads that will LPOP from keys matching that pattern. If `data_type` is
93+
`channel`, then we will SUBSCRIBE to the key. If `data_type` is
94+
`pattern_channel`, then we will PSUBSCRIBE to the key.
9395

9496
[id="plugins-{type}s-{plugin}-db"]
9597
===== `db`
@@ -125,6 +127,7 @@ The unix socket path of your Redis server.
125127

126128
The name of a Redis list or channel.
127129

130+
128131
[id="plugins-{type}s-{plugin}-password"]
129132
===== `password`
130133

@@ -133,6 +136,37 @@ The name of a Redis list or channel.
133136

134137
Password to authenticate with. There is no authentication by default.
135138

139+
140+
[id="plugins-{type}s-{plugin}-pattern_list_max_items"]
141+
===== `pattern_list_max_items`
142+
143+
* Value type is <<number,number>>
144+
* Default value is `1000`
145+
146+
Maximum number of items for a single worker thread to process when `data_type` is `pattern_list`.
147+
After the list is empty or this number of items have been processed, the thread will exit and a
148+
new one will be started if there are non-empty lists matching the pattern without a consumer.
149+
150+
151+
[id="plugins-{type}s-{plugin}-pattern_list_threadpool_sleep"]
152+
===== `pattern_list_threadpool_sleep`
153+
154+
* Value type is <<number,number>>
155+
* Default value is `0.2`
156+
157+
Time to sleep in main loop after checking if more threads can/need to be spawned.
158+
Applies to `data_type` is `pattern_list`
159+
160+
161+
[id="plugins-{type}s-{plugin}-pattern_list_threads"]
162+
===== `pattern_list_threads`
163+
164+
* Value type is <<number,number>>
165+
* Default value is `20`
166+
167+
Maximum number of worker threads to spawn when using `data_type` `pattern_list`.
168+
169+
136170
[id="plugins-{type}s-{plugin}-port"]
137171
===== `port`
138172

@@ -141,8 +175,9 @@ Password to authenticate with. There is no authentication by default.
141175

142176
The port to connect on.
143177

178+
144179
[id="plugins-{type}s-{plugin}-ssl"]
145-
===== `ssl`
180+
===== `ssl`
146181

147182
* Value type is <<boolean,boolean>>
148183
* Default value is `false`
@@ -157,7 +192,6 @@ Enable SSL support.
157192
* Default value is `1`
158193

159194

160-
161195
[id="plugins-{type}s-{plugin}-timeout"]
162196
===== `timeout`
163197

@@ -166,7 +200,9 @@ Enable SSL support.
166200

167201
Initial connection timeout in seconds.
168202

203+
204+
169205
[id="plugins-{type}s-{plugin}-common-options"]
170206
include::{include_path}/{type}.asciidoc[]
171207

172-
:default_codec!:
208+
:default_codec!:

0 commit comments

Comments
 (0)