Package com.plccom.mqtt.client
Class MqttConnectedContext
- java.lang.Object
-
- com.plccom.mqtt.client.MqttConnectedContext
-
public final class MqttConnectedContext extends Object
Context delivered to high-level client connection callbacks.The context contains the MQTT details that are known after CONNACK has been accepted. It is immutable so application callbacks can safely keep it after the callback method returns.
-
-
Constructor Summary
Constructors Constructor Description MqttConnectedContext(String clientId, PlccomMqttProtocolVersion requestedProtocolVersion, PlccomMqttProtocolVersion negotiatedProtocolVersion, boolean sessionPresent)Creates an immutable connected-context value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringclientId()Returns the MQTT Client Identifier used by the connection.PlccomMqttProtocolVersionnegotiatedProtocolVersion()Returns the concrete protocol version accepted by the broker.PlccomMqttProtocolVersionrequestedProtocolVersion()Returns the requested protocol selection.booleansessionPresent()Returns whether the broker reported an existing session.
-
-
-
Constructor Detail
-
MqttConnectedContext
public MqttConnectedContext(String clientId, PlccomMqttProtocolVersion requestedProtocolVersion, PlccomMqttProtocolVersion negotiatedProtocolVersion, boolean sessionPresent)
Creates an immutable connected-context value.- Parameters:
clientId- MQTT Client Identifier used by the connectionrequestedProtocolVersion- version requested by the caller, possiblyPlccomMqttProtocolVersion.AUTOnegotiatedProtocolVersion- concrete MQTT version accepted by the brokersessionPresent-truewhen CONNACK reported an existing session- Throws:
NullPointerException- ifclientId,requestedProtocolVersionornegotiatedProtocolVersionisnull
-
-
Method Detail
-
clientId
public String clientId()
Returns the MQTT Client Identifier used by the connection.- Returns:
- MQTT Client Identifier
-
requestedProtocolVersion
public PlccomMqttProtocolVersion requestedProtocolVersion()
Returns the requested protocol selection.- Returns:
- requested MQTT version, possibly
PlccomMqttProtocolVersion.AUTO
-
negotiatedProtocolVersion
public PlccomMqttProtocolVersion negotiatedProtocolVersion()
Returns the concrete protocol version accepted by the broker.- Returns:
- negotiated MQTT version
-
sessionPresent
public boolean sessionPresent()
Returns whether the broker reported an existing session.- Returns:
truewhen CONNACK Session Present was set
-
-