com.hivemq.client.mqtt.mqtt3

Interface Mqtt3ClientConfig

All Superinterfaces:

MqttClientConfig

@DoNotImplement
public interface Mqtt3ClientConfig
extends MqttClientConfig

Configuration of an Mqtt3Client.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
@NotNull Optional<Mqtt3ClientConnectionConfig>	getConnectionConfig() Returns the optional connection configuration of the client.
@NotNull Optional<Mqtt3SimpleAuth>	getSimpleAuth() Returns the optional simple authentication and/or authorization related data of the client.
@NotNull Optional<Mqtt3Publish>	getWillPublish() Returns the optional Will Publish of the client.

Methods inherited from interface com.hivemq.client.mqtt.MqttClientConfig

getAutomaticReconnect, getClientIdentifier, getConnectedListeners, getDisconnectedListeners, getExecutorConfig, getMqttVersion, getServerAddress, getServerHost, getServerPort, getSslConfig, getState, getTransportConfig, getWebSocketConfig

Method Detail

getConnectionConfig

@NotNull
@NotNull Optional<Mqtt3ClientConnectionConfig> getConnectionConfig()

Description copied from interface: MqttClientConfig

Returns the optional connection configuration of the client. It is present if the client is connected and has received the ConnAck message.

Specified by:

getConnectionConfig in interface MqttClientConfig

Returns:

the optional connection configuration of the client.

getSimpleAuth

@NotNull
@NotNull Optional<Mqtt3SimpleAuth> getSimpleAuth()

Returns the optional simple authentication and/or authorization related data of the client.

It is used as default if Mqtt3Connect.simpleAuth is not set during connect.

Keep in mind that the data is stored with the client in memory. If you want to use it only during connect or if you use a different token for each connection please set Mqtt3Connect.simpleAuth instead.

Returns:

the optional simple authentication and/or authorization related data of the client.

Since:

1.1

getWillPublish

@NotNull
@NotNull Optional<Mqtt3Publish> getWillPublish()

Returns the optional Will Publish of the client.

It is used as default if Mqtt3Connect.willPublish is not set during connect.

Keep in mind that the Will Publish is stored with the client in memory. If you use a different Will Publish for each connection please set Mqtt3Connect.willPublish instead.

Returns:

the optional Will Publish of the client.

Since:

1.1