Skip to content
This repository was archived by the owner on Jun 10, 2022. It is now read-only.

Commit a0bc97e

Browse files
authored
Merge pull request #195 from simPod/sort-properties
Sort properties in config documentation
2 parents f8c204f + 5412abf commit a0bc97e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/Configure.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,32 @@ Kafka-php Configuration
33

44
| Property | C/P | Range | Default | Desc |
55
| -- | -- | -- | -- | -- |
6+
| brokerVersion | C/P | 0.8.0 | 0.10.1.0 | User supplied broker version |
67
| clientId | C/P | | kafka-php | This is a user supplied identifier for the client application |
7-
| brokerVersion | C/P | 大于 0.8.0 | 0.10.1.0 | User supplied broker version |
8-
| metadataBrokerList | C/P | | | Kafka Broker server list |
98
| messageMaxBytes | C/P | 1000 .. 1000000000 | 1000000 | Maximum transmit message size. |
10-
| metadataRequestTimeoutMs | C/P | 10 .. 900000 | 60000 | Non-topic request timeout in milliseconds. This is for metadata requests, etc. |
11-
| metadataRefreshIntervalMs | C/P | 10 .. 3600000 | 300000 | Topic metadata refresh interval in milliseconds. The metadata is automatically refreshed on error and connect. Use -1 to disable the intervalled refresh. |
9+
| metadataBrokerList | C/P | | | Kafka Broker server list |
1210
| metadataMaxAgeMs | C/P | 1 .. 86400000 | -1 | Metadata cache max age. Defaults to metadata.refresh.interval.ms * 3 |
11+
| metadataRefreshIntervalMs | C/P | 10 .. 3600000 | 300000 | Topic metadata refresh interval in milliseconds. The metadata is automatically refreshed on error and connect. Use -1 to disable the intervalled refresh. |
12+
| metadataRequestTimeoutMs | C/P | 10 .. 900000 | 60000 | Non-topic request timeout in milliseconds. This is for metadata requests, etc. |
1313
| sslEnable | C/P | true/false | false | Whether enable ssl connect or not |
14+
| sslCafile | C/P | | | Location of Certificate Authority file on local filesystem which should be used with the verify_peer context option to authenticate the identity of the remote peer.|
1415
| sslLocalCert | C/P | File path | | Path to local certificate file on filesystem. |
1516
| sslLocalPk | C/P | File path | | Path to local private key file on filesystem in case of separate files for certificate (local_cert) and private key. |
16-
| sslVerifyPeer | C/P | true/false | false | Require verification of SSL certificate used. |
1717
| sslPassphrase | C/P | | | Passphrase with which your local_cert file was encoded. |
18-
| sslCafile | C/P | | | Location of Certificate Authority file on local filesystem which should be used with the verify_peer context option to authenticate the identity of the remote peer.|
1918
| sslPeerName | C/P | | | Peer name to be used. If this value is not set, then the name is guessed based on the hostname used when opening the stream. |
19+
| sslVerifyPeer | C/P | true/false | false | Require verification of SSL certificate used. |
20+
| offsetReset | C | latest,earliest | latest | Action to take when there is no initial offset in offset store or the desired offset is out of range |
2021
| groupId | C | | | Client group id string. All clients sharing the same group.id belong to the same group. |
22+
| maxBytes | C | | 65536 | Maximum bytes to fetch. |
23+
| maxWaitTime | C | | 100 | Maximum time in ms to wait for the response |
2124
| sessionTimeout | C | 1 .. 3600000 | 30000 | Client group session and failure detection timeout. |
2225
| rebalanceTimeout | C | 1 .. 3600000 | 30000 | rebalance join wait timeout |
2326
| topics | C | | | Want consumer topics |
24-
| offsetReset | C | latest,earliest | latest | Action to take when there is no initial offset in offset store or the desired offset is out of range |
25-
| maxBytes | C | | 65536 | Maximum bytes to fetch. |
26-
| maxWaitTime | C | | 100 | Maximum time in ms to wait for the response |
27-
| requiredAck | P | -1 .. 1000 | 1 | This field indicates how many acknowledgements the leader broker must receive from ISR brokers before responding to the request: 0=Broker does not send any response/ack to client, 1=Only the leader broker will need to ack the message, -1 or all=broker will block until message is committed by all in sync replicas (ISRs) or broker\'s in.sync.replicas setting before sending response. |
28-
| timeout | P | 1 .. 900000 | 5000 | Producer request timeout |
2927
| isAsyn | P | true, false | false | Whether to use asynchronous production messages |
30-
| requestTimeout | P | 1 .. 900000 | 6000 | The total timeout of the production message, which must be greater than the timeout config parameter |
3128
| produceInterval | P | 1 .. 900000 | 100 | The time interval at which requests for production messages are executed when the message is produced asynchronously |
29+
| requestTimeout | P | 1 .. 900000 | 6000 | The total timeout of the production message, which must be greater than the timeout config parameter |
30+
| requiredAck | P | -1 .. 1000 | 1 | This field indicates how many acknowledgements the leader broker must receive from ISR brokers before responding to the request: 0=Broker does not send any response/ack to client, 1=Only the leader broker will need to ack the message, -1 or all=broker will block until message is committed by all in sync replicas (ISRs) or broker\'s in.sync.replicas setting before sending response. |
31+
| timeout | P | 1 .. 900000 | 5000 | Producer request timeout |
3232

3333
#### Note
3434

0 commit comments

Comments
 (0)