Retain property

Gets or sets the retain flag of the application message. Read/write. Boolean.

Syntax

msg

.

Retain

where

msg

- is an MQTTMessage object created by the MQTTFactory object's method

CreateApplicationMessage

.

Default value

If this property is omitted, it will use its default value, which is

False

, meaning the server must not store the message as a retained message and must not remove or replace any existing retained messages.