Skip to content

Commit

Permalink
chore: updated default wathdogTimeout and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kaandesu committed Jun 22, 2024
1 parent 4ed0146 commit f2f3287
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<p align="center">
<a href="https://www.npmjs.com/package/vue-paho-mqtt">
<img src="https://img.shields.io/npm/v/vue-paho-mqtt?style=for-the-badge" alt="npm version">
</a>
</a>
<a href="https://github.com/kaandesu/vue-paho-mqtt/actions/workflows/build.yml">
<img src="https://img.shields.io/github/actions/workflow/status/kaandesu/vue-paho-mqtt/build.yml?style=for-the-badge" alt="build status">
</a>
Expand All @@ -18,10 +18,10 @@
</a>
<a href="https://github.com/kaandesu/vue-paho-mqtt/pulls">
<img src="https://img.shields.io/github/issues-pr/kaandesu/vue-paho-mqtt?style=for-the-badge" alt="pr">
</a>
</a>
<a href="https://github.com/kaandesu/vue-paho-mqtt/commits/master" alt="Commit Activity">
<img src="https://img.shields.io/github/commit-activity/m/kaandesu/vue-paho-mqtt?style=for-the-badge" />
</a>
</a>
</p>

The `vue-paho-mqtt` plugin provides a convenient way to use the [Eclipse Paho MQTT JavaScript client](https://www.eclipse.org/paho/clients/js/) with Vue 3.
Expand Down Expand Up @@ -196,7 +196,7 @@ You can configure the MQTT client by passing an object with the following option

- `enableMainTopic` (`boolean`, default: `true`) - Enables usage of the main topic.

- `watchdogTimeout` (`number`, default: `2000`) - The time in milliseconds to wait for a connection to the broker before timing out.
- `watchdogTimeout` (`number`, default: `30000`) - The time in milliseconds to wait for a connection to the broker before timing out.

- `reconnectTimeout` (`number`, default: `5000`) - The time in milliseconds to wait before attempting to reconnect to the broker after a disconnection.

Expand Down Expand Up @@ -342,7 +342,7 @@ const result = await $mqtt.connect();
| `onConnectionLost` | disconnected or connection lost connection | responseObject: {errorCode: number} |
| `onMessageArrived` | message arrived from one of the subscribed topics | message: {payloadString: string;destinationName: string;} |
#### Custom Callback Usage example:
#### Custom Callback Usage example
```ts
$mqtt.connect({
Expand Down Expand Up @@ -994,8 +994,8 @@ This project is created and actively maintained by [kaandesu](https://github.com
| Maintainer | E-Mail | Twitter |
| --------------------------------------- | ------------------------------------------ | --------------------------------------------- |
| [kaandesu](https://github.com/kaandesu) | [email protected] | - |
| [EgeOnder](https://github.com/EgeOnder) | [email protected] | [@EgeOnder23](https://twitter.com/EgeOnder23) |
| [kaandesu](https://github.com/kaandesu) | <[email protected]> | - |
| [EgeOnder](https://github.com/EgeOnder) | <[email protected]> | [@EgeOnder23](https://twitter.com/EgeOnder23) |
## Changelog
Expand Down
2 changes: 1 addition & 1 deletion src/pahoMqttPlugin/config/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const defaultMqttOptions: MqttOptions = {
clientId: `ClientId-${Math.random() * 9999}`,
mainTopic: 'vue-paho-mqtt-test',
enableMainTopic: true,
watchdogTimeout: 2000,
watchdogTimeout: 30000,
reconnectTimeout: 5000,
keepAliveInterval: 60000,
cleanSession: true,
Expand Down
9 changes: 7 additions & 2 deletions src/pahoMqttPlugin/utils/connectClient.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { createClient } from '~/config/client';
import { getMqttOptions } from '~/config/options';
import { defaultMqttOptions } from '~/config/constants';
import { onConnectCallback } from '~/functions/onConnect';
import { onConnectionLostCallback } from '~/functions/onConnectionLost';
import { onFailureCallback } from '~/functions/onFailure';
Expand Down Expand Up @@ -64,8 +65,12 @@ export const connectClient = ({
userName: MqttOptions.username,
password: MqttOptions.password,
useSSL: MqttOptions.useSSL,
timeout: (MqttOptions.watchdogTimeout || 30000) / 1000,
keepAliveInterval: (MqttOptions.keepAliveInterval || 60000) / 1000,
timeout:
(MqttOptions.watchdogTimeout || defaultMqttOptions.watchdogTimeout!) /
1000,
keepAliveInterval:
(MqttOptions.keepAliveInterval ||
defaultMqttOptions.keepAliveInterval!) / 1000,
cleanSession: MqttOptions.cleanSession,
uris: [
`wss://${MqttOptions.host}:${MqttOptions.port}${MqttOptions.path}`,
Expand Down

0 comments on commit f2f3287

Please sign in to comment.