Skip to content

Commit 1fcf24e

Browse files
Ian CraggsGerrit Code Review @ Eclipse.org
authored andcommitted
Merge "Bug: 483544 - Correct documentation regarding deletion of retained message Fixed the incorrect documentation on retained flag. Signed-off-by: James Sutton <james.sutton@uk.ibm.com>" into develop
2 parents cd8642a + f21837e commit 1fcf24e

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

  • org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3

org.eclipse.paho.client.mqttv3/src/main/java/org/eclipse/paho/client/mqttv3/MqttMessage.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ public boolean isRetained() {
112112

113113
/**
114114
* Whether or not the publish message should be retained by the messaging engine.
115-
* Sending a message with the retained set to <code>false</code> will clear the
115+
* Sending a message with retained set to <code>true</code> and with an empty
116+
* byte array as the payload e.g. <code>new byte[0]</code> will clear the
116117
* retained message from the server. The default value is <code>false</code>
117118
*
118119
* @param retained whether or not the messaging engine should retain the message.

0 commit comments

Comments
 (0)