Interface ClientManager<T extends com.hivemq.client.mqtt.MqttClient>
- Type Parameters:
T- MQTT client type
- All Known Implementing Classes:
AbstractMqttClientManager, Mqtt3ClientManager, Mqtt5ClientManager
public interface ClientManager<T extends com.hivemq.client.mqtt.MqttClient>
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:
- 7.2
- Author:
- Jiandong Ma
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceA contract for a custom callback ononConnectedevent from the client. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCallback(ClientManager.ConnectCallback connectCallback) Register a callback for theonConnectedevent from the client.Return the managed client.booleanReturn the managed clients isConnected.booleanremoveCallback(ClientManager.ConnectCallback connectCallback) Remove the callback from registration.
-
Method Details
-
getClient
-
isConnected
boolean isConnected()Return the managed clients isConnected.- Returns:
- the managed clients isConnected.
-
addCallback
Register a callback for theonConnectedevent from the client.- Parameters:
connectCallback- aClientManager.ConnectCallbackto register.
-
removeCallback
Remove the callback from registration.- Parameters:
connectCallback- aClientManager.ConnectCallbackto unregister.- Returns:
- true if callback was removed.
-