com.navigine.idl.java.MqttSession Class Reference

Class is used for managing MQTT session and publishing position data to MQTT broker. More...

Public Member Functions
abstract void	connect (String server, int port, String username, String password)
	Method is used to connect to MQTT broker and start publishing position data.
abstract void	setSubTopic (String subTopic)
	Method is used to set MQTT sub-topic for publishing position data. The final topic will be "navigine/mobile/positions/" + subTopic + "/" + deviceId.
abstract void	addListener (MqttSessionListener listener)
	Method is used to add MqttSessionListener class element which will notify about MQTT session connection state changes.
abstract void	removeListener (MqttSessionListener listener)
	Method is used for removing previously added MqttSessionListener class element.
abstract void	disconnect ()
	Method is used to disconnect from MQTT broker and stop publishing position data.
abstract void	publish (String topic, String message)
	Method is used to publish a custom message to a specified MQTT topic. The message will be sent asynchronously and the result will be notified through MqttSessionListener callbacks (onMessagePublished for success, onError for failure).

Detailed Description

Class is used for managing MQTT session and publishing position data to MQTT broker.

Referenced from NavigineSdk.

Definition at line 17 of file MqttSession.java.

Member Function Documentation

addListener()

abstract void com.navigine.idl.java.MqttSession.addListener ( MqttSessionListener listener )

abstract

Method is used to add MqttSessionListener class element which will notify about MQTT session connection state changes.

Note

Do not forget to remove listener if it is no longer needed!

Parameters

listener

Сorresponding MqttSessionListener class.

Java code snippet:

Kotlin code snippet:

connect()

abstract void com.navigine.idl.java.MqttSession.connect ( String server, int port, String username, String password )

abstract

Method is used to connect to MQTT broker and start publishing position data.

Parameters

server	MQTT broker server hostname or IP address.
port	MQTT broker server port.
username	MQTT broker username for authentication.
password	MQTT broker password for authentication.

Java code snippet:

Kotlin code snippet:

disconnect()

abstract void com.navigine.idl.java.MqttSession.disconnect ( )

abstract

Method is used to disconnect from MQTT broker and stop publishing position data.

Java code snippet:

Kotlin code snippet:

publish()

abstract void com.navigine.idl.java.MqttSession.publish ( String topic, String message )

abstract

Method is used to publish a custom message to a specified MQTT topic. The message will be sent asynchronously and the result will be notified through MqttSessionListener callbacks (onMessagePublished for success, onError for failure).

Note

The MQTT session must be connected before calling this method. Use connect method first.

Parameters

topic	MQTT topic to publish the message to. Can be any valid MQTT topic string.
message	Message content to publish. Can be any string (JSON, plain text, etc.).

Java code snippet:

Kotlin code snippet:

removeListener()

abstract void com.navigine.idl.java.MqttSession.removeListener ( MqttSessionListener listener )

abstract

Method is used for removing previously added MqttSessionListener class element.

Parameters

listener

Сorresponding MqttSessionListener class to remove.

Java code snippet:

Kotlin code snippet:

setSubTopic()

abstract void com.navigine.idl.java.MqttSession.setSubTopic ( String subTopic )

abstract

Method is used to set MQTT sub-topic for publishing position data. The final topic will be "navigine/mobile/positions/" + subTopic + "/" + deviceId.

Parameters

subTopic

MQTT sub-topic for publishing position data. Must match pattern [0-9a-zA-Z_-]+ and cannot be empty.

Java code snippet:

Kotlin code snippet:

---

The documentation for this class was generated from the following file:

• MqttSession.java