Interface ClientManager<T,C>

Type Parameters:
T - MQTT client type
C - MQTT connection options type (v5 or v3)
All Superinterfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.Lifecycle, MqttComponent<C>, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
All Known Implementing Classes:
AbstractMqttClientManager, Mqttv3ClientManager, Mqttv5ClientManager
public interface ClientManager<T,C> extends org.springframework.context.SmartLifecycle, MqttComponent<C>
A utility abstraction over MQTT client which can be used in any MQTT-related component without need to handle generic client callbacks, reconnects etc. Using this manager in multiple MQTT integrations will preserve a single connection.
Since:
6.0

  • Field Details

    • DEFAULT_COMPLETION_TIMEOUT

      static final long DEFAULT_COMPLETION_TIMEOUT
      The default completion timeout in milliseconds.
      See Also:

    • QUIESCENT_TIMEOUT

      static final Long QUIESCENT_TIMEOUT

    • DISCONNECT_COMPLETION_TIMEOUT

      static final long DISCONNECT_COMPLETION_TIMEOUT
      The default disconnect completion timeout in milliseconds.
      See Also:

  • Method Details

    • getClient

      @Nullable T getClient()
      Return the managed client.
      Returns:
      the managed client.

    • getUrl

      String getUrl()
      Return the managed client url.
      Returns:
      the managed client url, never null.
      Since:
      7.0

    • getClientId

      String getClientId()
      Return the managed client id.
      Returns:
      the managed client id, never null.
      Since:
      7.0

    • isManualAcks

      boolean isManualAcks()
      If manual acknowledge has to be used; false by default.
      Returns:
      true if manual acknowledge has to be used.

    • addCallback

      void addCallback(ClientManager.ConnectCallback connectCallback)
      Register a callback for the connectComplete event from the client.
      Parameters:
      connectCallback - a ClientManager.ConnectCallback to register.

    • removeCallback

      boolean removeCallback(ClientManager.ConnectCallback connectCallback)
      Remove the callback from registration.
      Parameters:
      connectCallback - a ClientManager.ConnectCallback to unregister.
      Returns:
      true if callback was removed.

    • addDefaultMessageHandler

      <M> void addDefaultMessageHandler(ClientManager.DefaultMessageHandler<M> defaultMessageHandler)
      Register a callback for the messageArrived event from the client.
      Parameters:
      defaultMessageHandler - a ClientManager.DefaultMessageHandler to register.
      Since:
      6.5.6

    • removeDefaultMessageHandler

      <M> boolean removeDefaultMessageHandler(ClientManager.DefaultMessageHandler<M> defaultMessageHandler)
      Remove the callback from registration.
      Parameters:
      defaultMessageHandler - a ClientManager.DefaultMessageHandler to unregister.
      Returns:
      true if callback was removed.
      Since:
      6.5.6

    • isConnected

      boolean isConnected()
      Return the managed clients isConnected.
      Returns:
      the managed clients isConnected.
      Since:
      6.4