インターフェース ClientManager<T,C>

型パラメーター:
T - MQTT クライアント型
C - MQTT 接続オプション型 (v5 または v3)
すべてのスーパーインターフェース:
Aware、BeanNameAware、Lifecycle、MqttComponent<C>、Phased、SmartLifecycle
すべての既知の実装クラス:
AbstractMqttClientManager、Mqttv3ClientManager、Mqttv5ClientManager
public interface ClientManager<T,C> extends SmartLifecycle, MqttComponent<C>
一般的なクライアントコールバックや再接続などを処理する必要なく、MQTT 関連のコンポーネントで使用できる MQTT クライアントのユーティリティの抽象化です。複数の MQTT 統合でこのマネージャーを使用すると、単一の接続が維持されます。
導入:
6.0
作成者:
Artem Vozhdayenko, Artem Bilan, Jiri Soucek

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    ClientManager.ConnectCallback
    クライアントからの connectComplete イベントでのカスタムコールバックの契約。

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final long
    DEFAULT_COMPLETION_TIMEOUT
    ミリ秒単位のデフォルトの完了タイムアウト。
    static final long
    DISCONNECT_COMPLETION_TIMEOUT
    ミリ秒単位のデフォルトの切断完了タイムアウト。

    インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

    DEFAULT_PHASE

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    addCallback(ClientManager.ConnectCallback connectCallback)
    クライアントからの connectComplete イベントのコールバックを登録します。
    T
    getClient()
    管理対象クライアントを返します。
    boolean
    isConnected()
    管理対象クライアント isConnected を返します。
    boolean
    isManualAcks()
    手動確認を使用する必要がある場合。デフォルトでは false です。
    boolean
    removeCallback(ClientManager.ConnectCallback connectCallback)
    登録からコールバックを削除します。

    インターフェース org.springframework.beans.factory.BeanNameAware から継承されたメソッド

    setBeanName

    インターフェース org.springframework.context.Lifecycle から継承されたメソッド

    isRunning, start, stop

    インターフェース org.springframework.integration.mqtt.core.MqttComponent から継承されたメソッド

    getBeanName, getConnectionInfo

    インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド

    getPhase, isAutoStartup, stop

  • フィールドの詳細

    • DEFAULT_COMPLETION_TIMEOUT

      static final long DEFAULT_COMPLETION_TIMEOUT
      ミリ秒単位のデフォルトの完了タイムアウト。
      関連事項:

    • DISCONNECT_COMPLETION_TIMEOUT

      static final long DISCONNECT_COMPLETION_TIMEOUT
      ミリ秒単位のデフォルトの切断完了タイムアウト。
      関連事項:

  • メソッドの詳細

    • getClient

      T getClient()
      管理対象クライアントを返します。
      戻り値:
      管理対象クライアント。

    • isManualAcks

      boolean isManualAcks()
      手動確認を使用する必要がある場合。デフォルトでは false です。
      戻り値:
      手動確認を使用する必要がある場合は true。

    • addCallback

      void addCallback(ClientManager.ConnectCallback connectCallback)
      クライアントからの connectComplete イベントのコールバックを登録します。
      パラメーター:
      connectCallback - 登録する ClientManager.ConnectCallback。

    • removeCallback

      boolean removeCallback(ClientManager.ConnectCallback connectCallback)
      登録からコールバックを削除します。
      パラメーター:
      connectCallback - 登録解除する ClientManager.ConnectCallback。
      戻り値:
      コールバックが削除された場合は true。

    • isConnected

      boolean isConnected()
      管理対象クライアント isConnected を返します。
      戻り値:
      管理対象クライアント isConnected。
      導入:
      6.4