Skip to content

Commit

Permalink
docs: add constructor
Browse files Browse the repository at this point in the history
  • Loading branch information
Rotzbua authored and 256dpi committed Mar 13, 2024
1 parent 6d7d51e commit a1ae6d3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,17 @@ void loop() {
## API
Create the object with:
```c++
MQTTClient()
MQTTClient(int bufSize)
MQTTClient(int readBufSize, int writeBufSize)
```

- `MQTTClient` has two buffers. One for read and one for write. Default buffer size is 128 bytes. In summary are 256 bytes are used for buffers.
- The `bufSize` option sets `readBufSize` and `writeBufSize` to the same value.

Initialize the object using the hostname of the broker, the brokers port (default: `1883`) and the underlying Client class for network transport:

```c++
Expand Down

0 comments on commit a1ae6d3

Please sign in to comment.