MqttSessionExample.swift

Go to the documentation of this file.

import Foundation
 
/**
 * MqttSession usage example for Swift
 * Demonstrates working with MQTT session for publishing position data
 */
class MqttSessionExample: NSObject, NCMqttSessionListener {
    private var sdk: NCNavigineSdk?
    private var locationManager: NCLocationManager?
    private var navigationManager: NCNavigationManager?
    private var mqttSession: NCMqttSession?
 
    override init() {
        super.init()
        initializeSdk()
    }
 
    /**
     * Initialize SDK and get managers
     */
    private func initializeSdk() {
        do {
            // [swift_NavigineSdk_getInstance]
            // Get SDK instance
            sdk = NCNavigineSdk.getInstance()
            // [swift_NavigineSdk_getInstance]
 
            // [swift_NavigineSdk_setUserHash]
            // Set user hash
            sdk?.setUserHash("USER-HASH-HERE")
            // [swift_NavigineSdk_setUserHash]
 
            // [swift_NavigineSdk_setServer]
            // Set server URL (optional)
            sdk?.setServer("https://custom.navigine.com")
            // [swift_NavigineSdk_setServer]
 
            // [swift_NavigineSdk_getLocationManager]
            // Get LocationManager for working with locations
            locationManager = sdk?.getLocationManager()
            // [swift_NavigineSdk_getLocationManager]
 
            // [swift_NavigineSdk_getNavigationManager]
            // Get NavigationManager for working with navigation
            navigationManager = sdk?.getNavigationManager(locationManager)
            // [swift_NavigineSdk_getNavigationManager]
 
            // [swift_NavigineSdk_getMqttSession]
            // Create MQTT session for publishing position data
            mqttSession = sdk?.getMqttSession(navigationManager)
            // [swift_NavigineSdk_getMqttSession]
 
            if mqttSession != nil {
                print("MqttSession successfully initialized")
            }
        } catch {
            print("Error initializing SDK: \‍(error)")
        }
    }
 
    /**
     * Demonstrate MqttSession methods
     */
    func demonstrateMqttSessionMethods() {
        guard let session = mqttSession else {
            print("MqttSession not initialized")
            return
        }
 
        // [swift_MqttSession_addListener]
        // Add MQTT session listener
        session.addListener(self)
        // [swift_MqttSession_addListener]
 
        // [swift_MqttSession_setSubTopic]
        // Set MQTT sub-topic for publishing position data
        // Final topic will be "navigine/mobile/positions/" + subTopic + "/" + deviceId
        session.setSubTopic("location1")
        // [swift_MqttSession_setSubTopic]
 
        // [swift_MqttSession_connect]
        // Connect to MQTT broker
        // Server: MQTT broker hostname or IP address
        // Port: MQTT broker port (typically 1883 for non-SSL, 8883 for SSL)
        // Username: MQTT broker username for authentication
        // Password: MQTT broker password for authentication
        session.connect("mqtt.example.com", port: 1883, username: "username", password: "password")
        // [swift_MqttSession_connect]
 
        // Wait for connection
        Thread.sleep(forTimeInterval: 2.0)
 
        // [swift_MqttSession_publish]
        // Publish a custom message to a specific MQTT topic
        // The message will be sent asynchronously and the result will be notified through listener callbacks
        let customTopic = "custom/device/status"
        let customMessage = "{\"status\": \"online\", \"timestamp\": \‍(Int(Date().timeIntervalSince1970 * 1000))}"
        session.publish(topic: customTopic, message: customMessage)
        // [swift_MqttSession_publish]
    }
 
    /**
     * Demonstrate MQTT session with different configurations
     */
    func demonstrateMqttSessionConfigurations() {
        guard let session = mqttSession else {
            print("MqttSession not initialized")
            return
        }
 
        print("=== MQTT Session Configurations ===")
 
        // Example 1: Connect with default port
        // [swift_MqttSession_setSubTopic]
        // Set sub-topic. Final topic will be "navigine/mobile/positions/location1/{deviceId}"
        session.setSubTopic("location1")
        // [swift_MqttSession_setSubTopic]
        // [swift_MqttSession_connect]
        // Connect to MQTT broker with default port 1883
        session.connect("mqtt.example.com", port: 1883, username: "user", password: "pass")
        // [swift_MqttSession_connect]
 
        // Wait a bit
        Thread.sleep(forTimeInterval: 1.0)
 
        // Disconnect before reconnecting with different config
        // [swift_MqttSession_disconnect]
        // Disconnect from MQTT broker
        session.disconnect()
        // [swift_MqttSession_disconnect]
 
        // Example 2: Connect with SSL port
        // [swift_MqttSession_setSubTopic]
        // Set sub-topic. Final topic will be "navigine/mobile/positions/building-a/{deviceId}"
        session.setSubTopic("building-a")
        // [swift_MqttSession_setSubTopic]
        // [swift_MqttSession_connect]
        // Connect to MQTT broker with SSL port 8883
        session.connect("mqtt-secure.example.com", port: 8883, username: "user", password: "pass")
        // [swift_MqttSession_connect]
 
        // Wait a bit
        Thread.sleep(forTimeInterval: 1.0)
 
        // Example 3: Connect with different sub-topic
        // [swift_MqttSession_setSubTopic]
        // Set different sub-topic. Final topic will be "navigine/mobile/positions/floor_2/{deviceId}"
        session.setSubTopic("floor_2")
        // [swift_MqttSession_setSubTopic]
        // [swift_MqttSession_connect]
        // Connect to MQTT broker
        session.connect("mqtt.example.com", port: 1883, username: "user", password: "pass")
        // [swift_MqttSession_connect]
    }
 
    /**
     * Demonstrate listener management
     */
    func demonstrateListenerManagement() {
        guard let session = mqttSession else {
            print("MqttSession not initialized")
            return
        }
 
        print("=== Listener Management ===")
 
        // Create listener objects
        let listener1 = MqttSessionListenerImpl(name: "Listener 1")
        let listener2 = MqttSessionListenerImpl(name: "Listener 2")
 
        // [swift_MqttSession_addListener]
        // Add first listener
        session.addListener(listener1)
        // [swift_MqttSession_addListener]
 
        // [swift_MqttSession_addListener]
        // Add second listener
        session.addListener(listener2)
        // [swift_MqttSession_addListener]
 
        // Connect to trigger callbacks
        // [swift_MqttSession_setSubTopic]
        session.setSubTopic("location1")
        // [swift_MqttSession_setSubTopic]
        // [swift_MqttSession_connect]
        session.connect("mqtt.example.com", port: 1883, username: "user", password: "pass")
        // [swift_MqttSession_connect]
 
        // Wait for connection
        Thread.sleep(forTimeInterval: 2.0)
 
        // [swift_MqttSession_publish]
        // Publish custom messages to different topics
        session.publish(topic: "custom/events", message: "{\"event\": \"user_action\"}")
        session.publish(topic: "custom/logs", message: "Application started")
        // [swift_MqttSession_publish]
 
        // Wait for messages to be published
        Thread.sleep(forTimeInterval: 1.0)
 
        // [swift_MqttSession_removeListener]
        // Remove first listener
        session.removeListener(listener1)
        // [swift_MqttSession_removeListener]
 
        // [swift_MqttSession_removeListener]
        // Remove second listener
        session.removeListener(listener2)
        // [swift_MqttSession_removeListener]
    }
 
    /**
     * Clean up resources
     */
    func cleanup() {
        if let session = mqttSession {
            // [swift_MqttSession_removeListener]
            // Remove MQTT session listener
            session.removeListener(self)
            // [swift_MqttSession_removeListener]
 
            // [swift_MqttSession_disconnect]
            // Disconnect from MQTT broker
            session.disconnect()
            // [swift_MqttSession_disconnect]
        }
    }
 
    /**
     * Main demonstration method
     */
    func runExample() {
        print("=== MqttSession Example ===")
 
        demonstrateMqttSessionMethods()
        demonstrateMqttSessionConfigurations()
        demonstrateListenerManagement()
 
        // Wait a bit for connection events
        Thread.sleep(forTimeInterval: 3.0)
 
        cleanup()
        print("=== Example completed ===")
    }
}
 
// MARK: - NCMqttSessionListener
 
extension MqttSessionExample {
    // [swift_MqttSessionListener_onConnected]
    func onConnected() {
        print("MQTT session connected successfully")
    }
    // [swift_MqttSessionListener_onConnected]
 
    // [swift_MqttSessionListener_onError]
    func onError(_ error: Error?) {
        if let error = error {
            print("MQTT session error: \‍(error.localizedDescription)")
        }
    }
    // [swift_MqttSessionListener_onError]
 
    // [swift_MqttSessionListener_onMessagePublished]
    func onMessagePublished() {
        print("Message published successfully")
    }
    // [swift_MqttSessionListener_onMessagePublished]
}
 
/**
 * Helper class for multiple listeners
 */
class MqttSessionListenerImpl: NSObject, NCMqttSessionListener {
    let name: String
 
    init(name: String) {
        self.name = name
    }
 
    func onConnected() {
        print("\‍(name): Connected")
    }
 
    func onError(_ error: Error?) {
        if let error = error {
            print("\‍(name): Error - \‍(error.localizedDescription)")
        }
    }
 
    func onMessagePublished() {
        print("\‍(name): Message published")
    }
}
 
/**
 * Function to run the example
 */
func main() {
    let example = MqttSessionExample()
    example.runExample()
}
 
// Run the example
main()