Skip to content

Commit 573ba54

Browse files
committed
[doc] upd config ref doc.
1 parent eca03ff commit 573ba54

File tree

1 file changed

+175
-74
lines changed

1 file changed

+175
-74
lines changed

docs/bundle/config_reference.md

Lines changed: 175 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -38,149 +38,201 @@ enqueue:
3838

3939
# The option tells whether RabbitMQ broker has delay plugin installed or not
4040
delay_plugin_installed: false
41-
amqp:
41+
amqp_ext:
4242

43-
# The connection to AMQP broker set as a string. Other parameters are ignored if set
43+
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
4444
dsn: ~
4545

4646
# The host to connect too. Note: Max 1024 characters
47-
host: localhost
47+
host: ~
4848

4949
# Port on the host.
50-
port: 5672
50+
port: ~
5151

5252
# The user name to use. Note: Max 128 characters.
53-
user: guest
53+
user: ~
5454

5555
# Password. Note: Max 128 characters.
56-
pass: guest
56+
pass: ~
5757

5858
# The virtual host on the host. Note: Max 128 characters.
59-
vhost: /
59+
vhost: ~
6060

6161
# Connection timeout. Note: 0 or greater seconds. May be fractional.
62-
connect_timeout: ~
62+
connection_timeout: ~
6363

6464
# Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
6565
read_timeout: ~
6666

6767
# Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
6868
write_timeout: ~
69-
persisted: false
70-
lazy: true
69+
70+
# How often to send heartbeat. 0 means off.
71+
heartbeat: ~
72+
persisted: ~
73+
lazy: ~
7174

7275
# The receive strategy to be used. We suggest to use basic_consume as it is more performant. Though you need AMQP extension 1.9.1 or higher
73-
receive_method: basic_get # One of "basic_get"; "basic_consume"
74-
rabbitmq_amqp:
76+
receive_method: ~ # One of "basic_get"; "basic_consume"
77+
78+
# The server will send a message in advance if it is equal to or smaller in size than the available prefetch size. May be set to zero, meaning "no specific limit"
79+
qos_prefetch_size: ~
80+
81+
# Specifies a prefetch window in terms of whole messages
82+
qos_prefetch_count: ~
83+
84+
# If "false" the QoS settings apply to the current channel only. If this field is "true", they are applied to the entire connection.
85+
qos_global: ~
86+
87+
# The options that are specific to the amqp transport you chose. For example amqp+lib have insist, keepalive, stream options. amqp+bunny has tcp_nodelay extra option.
88+
driver_options: ~
89+
rabbitmq_amqp_ext:
7590

76-
# The connection to AMQP broker set as a string. Other parameters are ignored if set
91+
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
7792
dsn: ~
7893

7994
# The host to connect too. Note: Max 1024 characters
80-
host: localhost
95+
host: ~
8196

8297
# Port on the host.
83-
port: 5672
98+
port: ~
8499

85100
# The user name to use. Note: Max 128 characters.
86-
user: guest
101+
user: ~
87102

88103
# Password. Note: Max 128 characters.
89-
pass: guest
104+
pass: ~
90105

91106
# The virtual host on the host. Note: Max 128 characters.
92-
vhost: /
107+
vhost: ~
93108

94109
# Connection timeout. Note: 0 or greater seconds. May be fractional.
95-
connect_timeout: ~
110+
connection_timeout: ~
96111

97112
# Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
98113
read_timeout: ~
99114

100115
# Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
101116
write_timeout: ~
102-
persisted: false
103-
lazy: true
117+
118+
# How often to send heartbeat. 0 means off.
119+
heartbeat: ~
120+
persisted: ~
121+
lazy: ~
104122

105123
# The receive strategy to be used. We suggest to use basic_consume as it is more performant. Though you need AMQP extension 1.9.1 or higher
106-
receive_method: basic_get # One of "basic_get"; "basic_consume"
124+
receive_method: ~ # One of "basic_get"; "basic_consume"
125+
126+
# The server will send a message in advance if it is equal to or smaller in size than the available prefetch size. May be set to zero, meaning "no specific limit"
127+
qos_prefetch_size: ~
128+
129+
# Specifies a prefetch window in terms of whole messages
130+
qos_prefetch_count: ~
131+
132+
# If "false" the QoS settings apply to the current channel only. If this field is "true", they are applied to the entire connection.
133+
qos_global: ~
134+
135+
# The options that are specific to the amqp transport you chose. For example amqp+lib have insist, keepalive, stream options. amqp+bunny has tcp_nodelay extra option.
136+
driver_options: ~
107137

108138
# The delay strategy to be used. Possible values are "dlx", "delayed_message_plugin" or service id
109139
delay_strategy: dlx
110140
amqp_lib:
111141

112-
# The connection to AMQP broker set as a string. Other parameters are ignored if set
142+
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
113143
dsn: ~
114144

115145
# The host to connect too. Note: Max 1024 characters
116-
host: localhost
146+
host: ~
117147

118148
# Port on the host.
119-
port: 5672
149+
port: ~
120150

121151
# The user name to use. Note: Max 128 characters.
122-
user: guest
152+
user: ~
123153

124154
# Password. Note: Max 128 characters.
125-
pass: guest
155+
pass: ~
126156

127157
# The virtual host on the host. Note: Max 128 characters.
128-
vhost: /
158+
vhost: ~
129159

130160
# Connection timeout. Note: 0 or greater seconds. May be fractional.
131-
connection_timeout: !!float 3
132-
read_write_timeout: !!float 3
161+
connection_timeout: ~
133162

134163
# Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
135-
read_timeout: 3
164+
read_timeout: ~
136165

137166
# Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
138-
write_timeout: 3
139-
lazy: true
140-
stream: true
141-
insist: false
142-
keepalive: false
167+
write_timeout: ~
168+
169+
# How often to send heartbeat. 0 means off.
170+
heartbeat: ~
171+
persisted: ~
172+
lazy: ~
143173

144174
# The receive strategy to be used. We suggest to use basic_consume as it is more performant. Though you need AMQP extension 1.9.1 or higher
145-
receive_method: basic_get # One of "basic_get"; "basic_consume"
146-
heartbeat: 0
175+
receive_method: ~ # One of "basic_get"; "basic_consume"
176+
177+
# The server will send a message in advance if it is equal to or smaller in size than the available prefetch size. May be set to zero, meaning "no specific limit"
178+
qos_prefetch_size: ~
179+
180+
# Specifies a prefetch window in terms of whole messages
181+
qos_prefetch_count: ~
182+
183+
# If "false" the QoS settings apply to the current channel only. If this field is "true", they are applied to the entire connection.
184+
qos_global: ~
185+
186+
# The options that are specific to the amqp transport you chose. For example amqp+lib have insist, keepalive, stream options. amqp+bunny has tcp_nodelay extra option.
187+
driver_options: ~
147188
rabbitmq_amqp_lib:
148189

149-
# The connection to AMQP broker set as a string. Other parameters are ignored if set
190+
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
150191
dsn: ~
151192

152193
# The host to connect too. Note: Max 1024 characters
153-
host: localhost
194+
host: ~
154195

155196
# Port on the host.
156-
port: 5672
197+
port: ~
157198

158199
# The user name to use. Note: Max 128 characters.
159-
user: guest
200+
user: ~
160201

161202
# Password. Note: Max 128 characters.
162-
pass: guest
203+
pass: ~
163204

164205
# The virtual host on the host. Note: Max 128 characters.
165-
vhost: /
206+
vhost: ~
166207

167208
# Connection timeout. Note: 0 or greater seconds. May be fractional.
168-
connection_timeout: !!float 3
169-
read_write_timeout: !!float 3
209+
connection_timeout: ~
170210

171211
# Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
172-
read_timeout: 3
212+
read_timeout: ~
173213

174214
# Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
175-
write_timeout: 3
176-
lazy: true
177-
stream: true
178-
insist: false
179-
keepalive: false
215+
write_timeout: ~
216+
217+
# How often to send heartbeat. 0 means off.
218+
heartbeat: ~
219+
persisted: ~
220+
lazy: ~
180221

181222
# The receive strategy to be used. We suggest to use basic_consume as it is more performant. Though you need AMQP extension 1.9.1 or higher
182-
receive_method: basic_get # One of "basic_get"; "basic_consume"
183-
heartbeat: 0
223+
receive_method: ~ # One of "basic_get"; "basic_consume"
224+
225+
# The server will send a message in advance if it is equal to or smaller in size than the available prefetch size. May be set to zero, meaning "no specific limit"
226+
qos_prefetch_size: ~
227+
228+
# Specifies a prefetch window in terms of whole messages
229+
qos_prefetch_count: ~
230+
231+
# If "false" the QoS settings apply to the current channel only. If this field is "true", they are applied to the entire connection.
232+
qos_global: ~
233+
234+
# The options that are specific to the amqp transport you chose. For example amqp+lib have insist, keepalive, stream options. amqp+bunny has tcp_nodelay extra option.
235+
driver_options: ~
184236

185237
# The delay strategy to be used. Possible values are "dlx", "delayed_message_plugin" or service id
186238
delay_strategy: dlx
@@ -197,6 +249,9 @@ enqueue:
197249

198250
# The queue files are created with this given permissions if not exist.
199251
chmod: 384
252+
253+
# How often query for new messages.
254+
polling_interval: 100
200255
redis:
201256

202257
# can be a host, or the path to a unix domain socket
@@ -240,52 +295,100 @@ enqueue:
240295
lazy: true
241296
amqp_bunny:
242297

243-
# The connection to AMQP broker set as a string. Other parameters are ignored if set
298+
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
244299
dsn: ~
245300

246301
# The host to connect too. Note: Max 1024 characters
247-
host: localhost
302+
host: ~
248303

249304
# Port on the host.
250-
port: 5672
305+
port: ~
251306

252307
# The user name to use. Note: Max 128 characters.
253-
user: guest
308+
user: ~
254309

255310
# Password. Note: Max 128 characters.
256-
pass: guest
311+
pass: ~
257312

258313
# The virtual host on the host. Note: Max 128 characters.
259-
vhost: /
260-
lazy: true
314+
vhost: ~
315+
316+
# Connection timeout. Note: 0 or greater seconds. May be fractional.
317+
connection_timeout: ~
318+
319+
# Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
320+
read_timeout: ~
321+
322+
# Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
323+
write_timeout: ~
324+
325+
# How often to send heartbeat. 0 means off.
326+
heartbeat: ~
327+
persisted: ~
328+
lazy: ~
261329

262330
# The receive strategy to be used. We suggest to use basic_consume as it is more performant. Though you need AMQP extension 1.9.1 or higher
263-
receive_method: basic_get # One of "basic_get"; "basic_consume"
264-
heartbeat: 0
331+
receive_method: ~ # One of "basic_get"; "basic_consume"
332+
333+
# The server will send a message in advance if it is equal to or smaller in size than the available prefetch size. May be set to zero, meaning "no specific limit"
334+
qos_prefetch_size: ~
335+
336+
# Specifies a prefetch window in terms of whole messages
337+
qos_prefetch_count: ~
338+
339+
# If "false" the QoS settings apply to the current channel only. If this field is "true", they are applied to the entire connection.
340+
qos_global: ~
341+
342+
# The options that are specific to the amqp transport you chose. For example amqp+lib have insist, keepalive, stream options. amqp+bunny has tcp_nodelay extra option.
343+
driver_options: ~
265344
rabbitmq_amqp_bunny:
266345

267-
# The connection to AMQP broker set as a string. Other parameters are ignored if set
346+
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
268347
dsn: ~
269348

270349
# The host to connect too. Note: Max 1024 characters
271-
host: localhost
350+
host: ~
272351

273352
# Port on the host.
274-
port: 5672
353+
port: ~
275354

276355
# The user name to use. Note: Max 128 characters.
277-
user: guest
356+
user: ~
278357

279358
# Password. Note: Max 128 characters.
280-
pass: guest
359+
pass: ~
281360

282361
# The virtual host on the host. Note: Max 128 characters.
283-
vhost: /
284-
lazy: true
362+
vhost: ~
363+
364+
# Connection timeout. Note: 0 or greater seconds. May be fractional.
365+
connection_timeout: ~
366+
367+
# Timeout in for income activity. Note: 0 or greater seconds. May be fractional.
368+
read_timeout: ~
369+
370+
# Timeout in for outcome activity. Note: 0 or greater seconds. May be fractional.
371+
write_timeout: ~
372+
373+
# How often to send heartbeat. 0 means off.
374+
heartbeat: ~
375+
persisted: ~
376+
lazy: ~
285377

286378
# The receive strategy to be used. We suggest to use basic_consume as it is more performant. Though you need AMQP extension 1.9.1 or higher
287-
receive_method: basic_get # One of "basic_get"; "basic_consume"
288-
heartbeat: 0
379+
receive_method: ~ # One of "basic_get"; "basic_consume"
380+
381+
# The server will send a message in advance if it is equal to or smaller in size than the available prefetch size. May be set to zero, meaning "no specific limit"
382+
qos_prefetch_size: ~
383+
384+
# Specifies a prefetch window in terms of whole messages
385+
qos_prefetch_count: ~
386+
387+
# If "false" the QoS settings apply to the current channel only. If this field is "true", they are applied to the entire connection.
388+
qos_global: ~
389+
390+
# The options that are specific to the amqp transport you chose. For example amqp+lib have insist, keepalive, stream options. amqp+bunny has tcp_nodelay extra option.
391+
driver_options: ~
289392

290393
# The delay strategy to be used. Possible values are "dlx", "delayed_message_plugin" or service id
291394
delay_strategy: dlx
@@ -313,8 +416,6 @@ enqueue:
313416
doctrine_clear_identity_map_extension: false
314417
signal_extension: true
315418
reply_extension: true
316-
317-
318419
```
319420
320421
[back to index](../index.md)

0 commit comments

Comments
 (0)