Package org.springframework.integration.mqtt.core

Interface MqttPahoClientFactory

All Known Implementing Classes:
DefaultMqttPahoClientFactory
public interface MqttPahoClientFactory
Since:
4.0
Author:
Gary Russell

  • Method Summary

    Modifier and Type Method Description
    org.eclipse.paho.client.mqttv3.IMqttAsyncClient getAsyncClientInstance​(String url, String clientId)
    Retrieve an async client instance.
    org.eclipse.paho.client.mqttv3.IMqttClient getClientInstance​(String url, String clientId)
    Retrieve a client instance.
    org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectionOptions()
    Retrieve the connection options.
    ConsumerStopAction getConsumerStopAction()
    Deprecated.
    since 5.5.17 in favor of standard MqttConnectOptions.setCleanSession(boolean).

  • Method Details

    • getClientInstance

      org.eclipse.paho.client.mqttv3.IMqttClient getClientInstance​(String url, String clientId) throws org.eclipse.paho.client.mqttv3.MqttException
      Retrieve a client instance.
      Parameters:
      url - The URL.
      clientId - The client id.
      Returns:
      The client instance.
      Throws:
      org.eclipse.paho.client.mqttv3.MqttException - Any.

    • getAsyncClientInstance

      org.eclipse.paho.client.mqttv3.IMqttAsyncClient getAsyncClientInstance​(String url, String clientId) throws org.eclipse.paho.client.mqttv3.MqttException
      Retrieve an async client instance.
      Parameters:
      url - The URL.
      clientId - The client id.
      Returns:
      The client instance.
      Throws:
      org.eclipse.paho.client.mqttv3.MqttException - Any.
      Since:
      4.1

    • getConnectionOptions

      org.eclipse.paho.client.mqttv3.MqttConnectOptions getConnectionOptions()
      Retrieve the connection options.
      Returns:
      The options.

    • getConsumerStopAction

      @Deprecated ConsumerStopAction getConsumerStopAction()
      Deprecated.
      since 5.5.17 in favor of standard MqttConnectOptions.setCleanSession(boolean). Will be removed in 6.1.0.
      Get the consumer stop action.
      Returns:
      the consumer stop action.
      Since:
      4.3