Skip to content

Commit f87e5a8

Browse files
committed
polish README
1 parent 190a008 commit f87e5a8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@ If MQTT JMeter plugin is installed successfully, then open JMeter and below 3 MQ
3636

3737
This section includes basic connection settings.
3838

39-
- **Server name or IP**: The server install with MQTT server, it can be either IP address or server name. The default value is 127.0.0.1. **DO NOT** add protocol (e,g tcp:// or ssl:// etc) before server name or IP address!
39+
- **Server name or IP**: The server install with MQTT server, it can be either IP address or server name. The default value is 127.0.0.1. **DO NOT** add protocol (e.g. tcp:// or ssl://) before server name or IP address!
4040

4141
- **Port number**: The port that opens by MQTT server, the default value is 1883 for TCP protocol, and normally 8883 for SSL protocol.
4242

43-
- **MQTT version**: The MQTT version, default is 3.1, and another option is 3.1.1. E,g, sometimes the version is probably required for establish connection to [Azure IoTHub](https://github.com/emqtt/mqtt-jmeter/issues/21).
43+
- **MQTT version**: The MQTT version, default is 3.1, and another option is 3.1.1. Sometimes the version is probably required for establish connection to [Azure IoTHub](https://github.com/emqtt/mqtt-jmeter/issues/21).
4444

4545
- **Timeout(s)**: The connection timeout seconds while connecting to MQTT server. The default is 10 seconds.
4646

4747
### MQTT Protocol
4848

4949
The sampler supports for 2 protocols, TCP and SSL. For the SSL protocol, it includes normal SSL and dual SSL authentication.
5050

51-
If **'Dual SSL authentication'** is checked, please follow 'Certification files for SSL/TLS connections' at end of this doc configure client SSL configuration.
51+
If **'Dual SSL authentication'** is checked, please follow 'Certification files for SSL/TLS connections' at end of this doc to set the client SSL configuration.
5252

5353
![protocol_setting](screenshots/protocol_setting.png)
5454

@@ -62,11 +62,11 @@ User can configure MQTT server with user name & password authentication, refer t
6262

6363
### Connection options
6464

65-
- **ClientId**: The client id, the plugin will add generated uuid after the prefix to identify the client if keep 'Add random client id suffix' selected. Default value is 'conn_'. If 'Add random client id suffix' is not selected, then the text of 'ClientId' will be passed as 'clientId' of current connection.
65+
- **ClientId**: Identification of the client. (Default value is 'conn_'.) If 'Add random client id suffix' is selected, JMeter plugin will append generated uuid as suffix to represent the client, otherwise, the text of 'ClientId' will be passed as 'clientId' of current connection.
6666

6767
- **Keep alive(s)**: Ping packet send interval in seconds. Default value is 300, which means each connection sends a ping packet to MQTT server every 5 minutes.
6868

69-
- **Connection keep time(s)**: The value is for setting the connection elapsed time after successfully established MQTT connection. The default value is 1800 seconds, which means that the connection will be alive within 30 minutes.
69+
- **Connection keep time(s)**: The value is to set the connection elapsed time after successfully establishing MQTT connection. The default value is 1800 seconds, which means that the connection will be alive within 30 minutes.
7070

7171
- **Connect attampt max**: The maximum number of reconnect attempts before an error is reported back to the client on the first attempt by the client to connect to a server. Set to -1 to use unlimited attempts. Defaults to 0.
7272

0 commit comments

Comments
 (0)