Skip to content

Commit 0cefa7e

Browse files
committed
[doc][skip ci] update doc.
1 parent 6b4bbb2 commit 0cefa7e

File tree

2 files changed

+48
-10
lines changed

2 files changed

+48
-10
lines changed

docs/bundle/config_reference.md

+44-7
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ enqueue:
2121
connection_timeout: 1
2222
buffer_size: 1000
2323
lazy: true
24-
25-
# Should be true if you want to use secure connections. False by default
2624
ssl_on: false
2725
rabbitmq_stomp:
2826
host: localhost
@@ -34,6 +32,7 @@ enqueue:
3432
connection_timeout: 1
3533
buffer_size: 1000
3634
lazy: true
35+
ssl_on: false
3736

3837
# The option tells whether RabbitMQ broker has management plugin installed or not
3938
management_plugin_installed: false
@@ -42,7 +41,7 @@ enqueue:
4241
# The option tells whether RabbitMQ broker has delay plugin installed or not
4342
delay_plugin_installed: false
4443
amqp:
45-
driver: ~ # One of "ext"; "lib"; "bunny"
44+
driver: ~
4645

4746
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
4847
dsn: ~
@@ -106,7 +105,7 @@ enqueue:
106105
# Path to local private key file on filesystem in case of separate files for certificate (local_cert) and private key. A string.
107106
ssl_key: ~
108107
rabbitmq_amqp:
109-
driver: ~ # One of "ext"; "lib"; "bunny"
108+
driver: ~
110109

111110
# The connection to AMQP broker set as a string. Other parameters could be used as defaults
112111
dsn: ~
@@ -190,18 +189,27 @@ enqueue:
190189
polling_interval: 100
191190
redis:
192191

192+
# The redis connection given as DSN. For example redis://host:port?vendor=predis
193+
dsn: ~
194+
193195
# can be a host, or the path to a unix domain socket
194-
host: ~ # Required
196+
host: ~
195197
port: ~
196198

197199
# The library used internally to interact with Redis server
198-
vendor: ~ # One of "phpredis"; "predis", Required
200+
vendor: ~ # One of "phpredis"; "predis"; "custom"
201+
202+
# A custom redis service id, used with vendor true only
203+
redis: ~
199204

200205
# bool, Whether it use single persisted connection or open a new one for every context
201206
persisted: false
202207

203208
# the connection will be performed as later as possible, if the option set to true
204209
lazy: true
210+
211+
# Database index to select when connected.
212+
database: 0
205213
dbal:
206214

207215
# The Doctrine DBAL DSN. Other parameters are ignored if set
@@ -229,6 +237,7 @@ enqueue:
229237

230238
# the connection will be performed as later as possible, if the option set to true
231239
lazy: true
240+
endpoint: null
232241
gps:
233242

234243
# The connection to Google Pub/Sub broker set as a string. Other parameters are ignored if set
@@ -248,8 +257,36 @@ enqueue:
248257

249258
# The connection will be performed as later as possible, if the option set to true
250259
lazy: true
260+
rdkafka:
261+
262+
# The kafka DSN. Other parameters are ignored if set
263+
dsn: ~
264+
265+
# The kafka global configuration properties
266+
global: []
267+
268+
# The kafka topic configuration properties
269+
topic: []
270+
271+
# Delivery report callback
272+
dr_msg_cb: ~
273+
274+
# Error callback
275+
error_cb: ~
276+
277+
# Called after consumer group has been rebalanced
278+
rebalance_cb: ~
279+
280+
# Which partitioner to use
281+
partitioner: ~ # One of "RD_KAFKA_MSG_PARTITIONER_RANDOM"; "RD_KAFKA_MSG_PARTITIONER_CONSISTENT"
282+
283+
# Logging level (syslog(3) levels)
284+
log_level: ~
285+
286+
# Commit asynchronous
287+
commit_async: false
251288
client:
252-
traceable_producer: false
289+
traceable_producer: true
253290
prefix: enqueue
254291
app_name: app
255292
router_topic: default

docs/client/supported_brokers.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,24 @@ Here's the list of transports supported by Enqueue Client:
1313
| Redis | [enqueue/gps](../transport/redis.md) | redis: |
1414
| Amazon SQS | [enqueue/sqs](../transport/sqs.md) | sqs: |
1515
| STOMP, RabbitMQ | [enqueue/stomp](../transport/stomp.md) | stomp: |
16+
| Kafka | [enqueue/stomp](../transport/kafka.md) | kafka: |
1617
| Null | [enqueue/null](../transport/null.md) | null: |
1718

1819
Here's the list of protocols and Client features supported by them
1920

2021
| Protocol | Priority | Delay | Expiration | Setup broker | Message bus |
2122
|:--------------:|:--------:|:--------:|:----------:|:------------:|:-----------:|
2223
| AMQP | No | No | Yes | Yes | Yes |
23-
| RabbitMQ AMQP | Yes | Yes* | Yes | Yes | Yes |
24+
| RabbitMQ AMQP | Yes | Yes | Yes | Yes | Yes |
2425
| STOMP | No | No | Yes | No | Yes** |
25-
| RabbitMQ STOMP | Yes | Yes* | Yes | Yes*** | Yes** |
26+
| RabbitMQ STOMP | Yes | Yes | Yes | Yes*** | Yes** |
2627
| Filesystem | No | No | No | Yes | No |
2728
| Redis | No | No | No | Not needed | No |
2829
| Doctrine DBAL | Yes | Yes | No | Yes | No |
2930
| Amazon SQS | No | Yes | No | Yes | Not impl |
31+
| Kafka | No | No | No | Yes | No |
3032
| Google PubSub | Not impl | Not impl | Not impl | Yes | Not impl |
3133

32-
* \* Possible if a RabbitMQ delay plugin is installed.
3334
* \*\* Possible if topics (exchanges) are configured on broker side manually.
3435
* \*\*\* Possible if RabbitMQ Management Plugin is installed.
3536

0 commit comments

Comments
 (0)