Skip to content

API docs describe keepalive incorrectly #621

Open
@ElmerLastdrager

Description

In the API docs, the description of the keepalive value is wrong. It currently states:

keepalive the number of seconds after which the broker should send a PING message to the client if no other messages have been exchanged in that time.

This should read:

keepalive the number of seconds after which the client should send a PING message to the broker if no other messages have been exchanged in that time.

Relevant lines:
https://github.com/eclipse/mosquitto/blob/46630e7325a82644be1a6fef00ef30bbd52c7ef6/lib/mosquitto.h#L337
https://github.com/eclipse/mosquitto/blob/46630e7325a82644be1a6fef00ef30bbd52c7ef6/lib/mosquitto.h#L365
https://github.com/eclipse/mosquitto/blob/46630e7325a82644be1a6fef00ef30bbd52c7ef6/lib/mosquitto.h#L398
https://github.com/eclipse/mosquitto/blob/46630e7325a82644be1a6fef00ef30bbd52c7ef6/lib/mosquitto.h#L433
https://github.com/eclipse/mosquitto/blob/46630e7325a82644be1a6fef00ef30bbd52c7ef6/lib/mosquitto.h#L469

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions