boost::mqtt5::mqtt_client::keep

boost::mqtt5::mqtt_client::keep_alive

Assign the maximum time interval that is permitted to elapse between two transmissions from the Client.

Synopsis

boost::mqtt5::mqtt_client&
keep_alive(
    uint16_t seconds);

Description

A non-zero value initiates a process of sending a PINGREQ packet every seconds. If this function is not invoked, the Client assumes a Keep Alive interval of 60 seconds.

Parameters

Name	Description
`seconds`	Time interval in seconds.

Remarks

If the Server sends a Server Keep Alive, the Client will send a PINGREQ packet every Server Keep Alive seconds.

Attention

This function has no effect while the Client is running. Call it before async_run, or after cancel or async_disconnect and before invoking async_run again.