Package com.plccom.mqtt.client
Class MqttUnsubscribeResult
- java.lang.Object
-
- com.plccom.mqtt.OperationResult
-
- com.plccom.mqtt.client.MqttUnsubscribeResult
-
public final class MqttUnsubscribeResult extends OperationResult
Result of a high-level client unsubscribe operation.The MQTT protocol acknowledgement is validated by the client before this result is returned. This result focuses on the application view: which Topic Filter was handled and whether this particular call sent an UNSUBSCRIBE request or merely observed that the handle was already inactive.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.plccom.mqtt.OperationResult
OperationResult.eQuality
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetTopicFilter()Returns the Topic Filter that was unsubscribed or already inactive.booleanisRequestSent()Returns whether this high-level call sent an UNSUBSCRIBE request through the underlying client.-
Methods inherited from class com.plccom.mqtt.OperationResult
getInnerException, getMessage, getMessage, getQuality, getResultCode, isGood, setInnerException, setMessage, setResult, setResult, setResult, toString
-
-
-
-
Method Detail
-
getTopicFilter
public String getTopicFilter()
Returns the Topic Filter that was unsubscribed or already inactive.- Returns:
- MQTT Topic Filter associated with the unsubscribe operation
-
isRequestSent
public boolean isRequestSent()
Returns whether this high-level call sent an UNSUBSCRIBE request through the underlying client.A value of
falsemeans the high-level handle was already inactive before the call. It does not indicate a broker-side protocol failure. Operative unsubscribe failures are reported through this result's PLCcom quality and inner exception.- Returns:
trueif an UNSUBSCRIBE request was sent, otherwisefalse
-
-