クラス AbstractMqttClientManager<T,C>
java.lang.ObjectSE
org.springframework.integration.mqtt.core.AbstractMqttClientManager<T,C>
- 型パラメーター:
T
- MQTT クライアント型C
- MQTT 接続オプション型 (v5 または v3)
- 実装されているすべてのインターフェース:
Aware
、BeanNameAware
、ApplicationEventPublisherAware
、Lifecycle
、Phased
、SmartLifecycle
、ClientManager<T,
、C> MqttComponent<C>
- 既知の直属サブクラス
Mqttv3ClientManager
,Mqttv5ClientManager
public abstract class AbstractMqttClientManager<T,C>
extends ObjectSE
implements ClientManager<T,C>, ApplicationEventPublisherAware
一般的な v3/v5 クライアントマネージャー実装のベースとなる MQTT クライアントマネージャーの抽象クラス。いくつかの基本的なユーティリティと実装に依存しないフィールドとメソッドが含まれています。
- 導入:
- 6.0
- 作成者:
- Artem Vozhdayenko, Artem Bilan, Christian Tzolov
ネストされたクラスのサマリー
インターフェース org.springframework.integration.mqtt.core.ClientManager から継承されたネストクラス / インターフェース
ClientManager.ConnectCallback
フィールドのサマリー
フィールドインターフェース org.springframework.integration.mqtt.core.ClientManager から継承されたフィールド
DEFAULT_COMPLETION_TIMEOUT, DISCONNECT_COMPLETION_TIMEOUT
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明void
addCallback
(ClientManager.ConnectCallback connectCallback) クライアントからのconnectComplete
イベントのコールバックを登録します。protected ApplicationEventPublisher
このコンポーネントの Bean 名を返します。protected SetSE
<ClientManager.ConnectCallback> 管理対象クライアントを返します。protected StringSE
protected long
protected long
int
getPhase()
SmartLifecycle
でのコンポーネントの自動開始のフェーズ。protected StringSE
getUrl()
boolean
手動確認を使用する必要がある場合。デフォルトでは false です。boolean
boolean
removeCallback
(ClientManager.ConnectCallback connectCallback) 登録からコールバックを削除します。void
setApplicationEventPublisher
(ApplicationEventPublisher applicationEventPublisher) void
setBeanName
(StringSE name) protected void
void
setCompletionTimeout
(long completionTimeout) 操作の完了タイムアウトを設定します。void
setDisconnectCompletionTimeout
(long completionTimeout) 切断時の完了タイムアウトを設定します。void
setManualAcks
(boolean manualAcks) void
setPhase
(int phase) コンポーネントの自動起動のフェーズをSmartLifecycle
に設定します。protected void
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.integration.mqtt.core.ClientManager から継承されたメソッド
isConnected
インターフェース org.springframework.integration.mqtt.core.MqttComponent から継承されたメソッド
getConnectionInfo
インターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
isAutoStartup, stop
フィールドの詳細
logger
lock
コンストラクターの詳細
AbstractMqttClientManager
メソッドの詳細
setManualAcks
public void setManualAcks(boolean manualAcks) getUrl
setUrl
getClientId
getApplicationEventPublisher
setClient
getCallbacks
setCompletionTimeout
getCompletionTimeout
protected long getCompletionTimeout()setDisconnectCompletionTimeout
getDisconnectCompletionTimeout
protected long getDisconnectCompletionTimeout()isManualAcks
public boolean isManualAcks()インターフェースからコピーされた説明:ClientManager
手動確認を使用する必要がある場合。デフォルトでは false です。- 次で指定:
- インターフェース
ClientManager<T,
のC> isManualAcks
- 戻り値:
- 手動確認を使用する必要がある場合は true。
getClient
インターフェースからコピーされた説明:ClientManager
管理対象クライアントを返します。- 次で指定:
- インターフェース
ClientManager<T,
のC> getClient
- 戻り値:
- 管理対象クライアント。
setApplicationEventPublisher
- 次で指定:
- インターフェース
ApplicationEventPublisherAware
のsetApplicationEventPublisher
setBeanName
- 次で指定:
- インターフェース
BeanNameAware
のsetBeanName
getBeanName
インターフェースからコピーされた説明:MqttComponent
このコンポーネントの Bean 名を返します。- 次で指定:
- インターフェース
MqttComponent<T>
のgetBeanName
- 戻り値:
- Bean 名。
getPhase
public int getPhase()SmartLifecycle
でのコンポーネントの自動開始のフェーズ。カスタムが必要な場合は、正しい動作のためにAbstractMqttMessageDrivenChannelAdapter
実装のフェーズよりも小さい必要があることに注意してください。デフォルトのフェーズはDEFAULT_MANAGER_PHASE
です。- 次で指定:
- インターフェース
Phased
のgetPhase
- 次で指定:
- インターフェース
SmartLifecycle
のgetPhase
- 戻り値:
SmartLifecycle
自動開始フェーズ- 関連事項:
addCallback
インターフェースからコピーされた説明:ClientManager
クライアントからのconnectComplete
イベントのコールバックを登録します。- 次で指定:
- インターフェース
ClientManager<T,
のC> addCallback
- パラメーター:
connectCallback
- 登録するClientManager.ConnectCallback
。
removeCallback
インターフェースからコピーされた説明:ClientManager
登録からコールバックを削除します。- 次で指定:
- インターフェース
ClientManager<T,
のC> removeCallback
- パラメーター:
connectCallback
- 登録解除するClientManager.ConnectCallback
。- 戻り値:
- コールバックが削除された場合は true。
isRunning
setPhase
public void setPhase(int phase) コンポーネントの自動起動のフェーズをSmartLifecycle
に設定します。カスタムが必要な場合は、正しい動作のためにAbstractMqttMessageDrivenChannelAdapter
実装のフェーズよりも小さい必要があることに注意してください。- 関連事項: