will_message Property

The message that the server should publish in the event of an ungraceful disconnection.

Syntax

def get_will_message() -> str: ...
def set_will_message(value: str) -> None: ...

will_message = property(get_will_message, set_will_message)

Default Value

""

Remarks

This property may be set before calling connect to specify to the server a message that should be published on will_topic if the connection is closed ungracefully or lost.

The will_message will only be sent to the server when connect is called if will_topic is set. Note that in MQTTSN the clean session concept is extended to will topic and will message. The will_message can be updated with the update_will_message method.

Refer to will_topic for more information about MQTT Will functionality.