Package org.springframework.integration.mqtt.core

Interface ClientManager<T,C>

Type Parameters:

T - MQTT client type

C - MQTT connection options type (v5 or v3)

All Superinterfaces:

Aware, BeanNameAware, Lifecycle, MqttComponent<C>, Phased, SmartLifecycle

All Known Implementing Classes:

AbstractMqttClientManager, Mqttv3ClientManager, Mqttv5ClientManager

public interface ClientManager<T,C>
extends 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

Author:

Artem Vozhdayenko, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ClientManager.ConnectCallback	A contract for a custom callback on connectComplete event from the client.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_COMPLETION_TIMEOUT	The default completion timeout in milliseconds.
static final long	DISCONNECT_COMPLETION_TIMEOUT	The default disconnect completion timeout in milliseconds.

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Method Summary

Modifier and Type	Method	Description
void	addCallback(ClientManager.ConnectCallback connectCallback)	Register a callback for the connectComplete event from the client.
T	getClient()	Return the managed client.
boolean	isManualAcks()	If manual acknowledge has to be used; false by default.
boolean	removeCallback(ClientManager.ConnectCallback connectCallback)	Remove the callback from registration.

Methods inherited from interface org.springframework.beans.factory.BeanNameAware

setBeanName

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

Methods inherited from interface org.springframework.integration.mqtt.core.MqttComponent

getBeanName, getConnectionInfo

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, isAutoStartup, stop

Field Details

DEFAULT_COMPLETION_TIMEOUT

static final long DEFAULT_COMPLETION_TIMEOUT

The default completion timeout in milliseconds.

See Also:

• Constant Field Values

DISCONNECT_COMPLETION_TIMEOUT

static final long DISCONNECT_COMPLETION_TIMEOUT

The default disconnect completion timeout in milliseconds.

See Also:

• Constant Field Values

Method Details

getClient

T getClient()

Return the managed client.

Returns:

the managed client.

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.