com.hivemq.client.internal.mqtt

Class MqttClientConfig

java.lang.Object

com.hivemq.client.internal.mqtt.MqttClientConfig

All Implemented Interfaces:

Mqtt5ClientConfig, MqttClientConfig

public class MqttClientConfig
extends java.lang.Object
implements Mqtt5ClientConfig

Constructor Summary

Constructors

Constructor and Description
MqttClientConfig(@NotNull MqttVersion mqttVersion, @NotNull MqttClientIdentifierImpl clientIdentifier, @NotNull java.lang.String serverHost, int serverPort, @NotNull MqttClientExecutorConfigImpl executorConfig, @Nullable MqttClientSslConfigImpl sslConfig, @Nullable MqttWebSocketConfigImpl webSocketConfig, @NotNull MqttClientAdvancedConfig advancedConfig)

Method Summary

Modifier and Type	Method and Description
@NotNull io.netty.channel.EventLoop	acquireEventLoop()
boolean	executeInEventLoop(@NotNull java.lang.Runnable runnable)
@NotNull MqttClientAdvancedConfig	getAdvancedConfig()
@NotNull ClientComponent	getClientComponent()
@NotNull java.util.Optional<MqttClientIdentifier>	getClientIdentifier() Returns the identifier of the client.
@NotNull java.util.Optional<Mqtt5ClientConnectionConfig>	getConnectionConfig() Returns the optional connection configuration of the client.
@NotNull MqttClientExecutorConfigImpl	getExecutorConfig()
@NotNull MqttVersion	getMqttVersion()
@NotNull MqttClientIdentifierImpl	getRawClientIdentifier()
@Nullable MqttClientConnectionConfig	getRawConnectionConfig()
@Nullable MqttClientSslConfigImpl	getRawSslConfig()
@NotNull java.util.concurrent.atomic.AtomicReference<MqttClientState>	getRawState()
@Nullable MqttWebSocketConfigImpl	getRawWebSocketConfig()
@NotNull java.lang.String	getServerHost()
int	getServerPort()
@NotNull java.util.Optional<MqttClientSslConfig>	getSslConfig()
@NotNull MqttClientState	getState()
@NotNull java.util.Optional<MqttWebSocketConfig>	getWebSocketConfig()
void	releaseEventLoop()
void	setClientIdentifier(@NotNull MqttClientIdentifierImpl clientIdentifier)
void	setConnectionConfig(@Nullable MqttClientConnectionConfig connectionConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MqttClientConfig

public MqttClientConfig(@NotNull
                        @NotNull MqttVersion mqttVersion,
                        @NotNull
                        @NotNull MqttClientIdentifierImpl clientIdentifier,
                        @NotNull
                        @NotNull java.lang.String serverHost,
                        int serverPort,
                        @NotNull
                        @NotNull MqttClientExecutorConfigImpl executorConfig,
                        @Nullable
                        @Nullable MqttClientSslConfigImpl sslConfig,
                        @Nullable
                        @Nullable MqttWebSocketConfigImpl webSocketConfig,
                        @NotNull
                        @NotNull MqttClientAdvancedConfig advancedConfig)

Method Detail

getMqttVersion

@NotNull
public @NotNull MqttVersion getMqttVersion()

Specified by:

getMqttVersion in interface MqttClientConfig

Returns:

the MQTT version of the client.

getClientIdentifier

@NotNull
public @NotNull java.util.Optional<MqttClientIdentifier> getClientIdentifier()

Description copied from interface: MqttClientConfig

Returns the identifier of the client. It is not present if it was not specified by the client itself but is assigned by the server and the server did not tell the assigned Client Identifier yet.

Specified by:

getClientIdentifier in interface MqttClientConfig

Returns:

the (currently not present) identifier of the client.

getRawClientIdentifier

@NotNull
public @NotNull MqttClientIdentifierImpl getRawClientIdentifier()

setClientIdentifier

public void setClientIdentifier(@NotNull
                                @NotNull MqttClientIdentifierImpl clientIdentifier)

getServerHost

@NotNull
public @NotNull java.lang.String getServerHost()

Specified by:

getServerHost in interface MqttClientConfig

Returns:

the server host the clients connects to or is connected to.

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface MqttClientConfig

Returns:

the server port the client connects to or is connected to.

getExecutorConfig

@NotNull
public @NotNull MqttClientExecutorConfigImpl getExecutorConfig()

Specified by:

getExecutorConfig in interface MqttClientConfig

Returns:

the executor configuration of the client.

getSslConfig

@NotNull
public @NotNull java.util.Optional<MqttClientSslConfig> getSslConfig()

Specified by:

getSslConfig in interface MqttClientConfig

Returns:

the optional secure transport configuration of the client.

getRawSslConfig

@Nullable
public @Nullable MqttClientSslConfigImpl getRawSslConfig()

getWebSocketConfig

@NotNull
public @NotNull java.util.Optional<MqttWebSocketConfig> getWebSocketConfig()

Specified by:

getWebSocketConfig in interface MqttClientConfig

Returns:

the optional WebSocket configuration of the client.

getRawWebSocketConfig

@Nullable
public @Nullable MqttWebSocketConfigImpl getRawWebSocketConfig()

getAdvancedConfig

@NotNull
public @NotNull MqttClientAdvancedConfig getAdvancedConfig()

Specified by:

getAdvancedConfig in interface Mqtt5ClientConfig

Returns:

the advanced configuration of the client.

getClientComponent

@NotNull
public @NotNull ClientComponent getClientComponent()

acquireEventLoop

@NotNull
public @NotNull io.netty.channel.EventLoop acquireEventLoop()

releaseEventLoop

public void releaseEventLoop()

executeInEventLoop

public boolean executeInEventLoop(@NotNull
                                  @NotNull java.lang.Runnable runnable)

getState

@NotNull
public @NotNull MqttClientState getState()

Specified by:

getState in interface MqttClientConfig

Returns:

the state of the client.

getRawState

@NotNull
public @NotNull java.util.concurrent.atomic.AtomicReference<MqttClientState> getRawState()

getConnectionConfig

@NotNull
public @NotNull java.util.Optional<Mqtt5ClientConnectionConfig> 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 Mqtt5ClientConfig

Specified by:

getConnectionConfig in interface MqttClientConfig

Returns:

the optional connection configuration of the client.

getRawConnectionConfig

@Nullable
public @Nullable MqttClientConnectionConfig getRawConnectionConfig()

setConnectionConfig

public void setConnectionConfig(@Nullable
                                @Nullable MqttClientConnectionConfig connectionConfig)