B
- the type of the builder.@DoNotImplement public interface MqttClientBuilderBase<B extends MqttClientBuilderBase<B>>
MqttClient
.@CheckReturnValue @NotNull B identifier(@NotNull @NotNull String identifier)
Client Identifier
.identifier
- the string representation of the Client Identifier.@CheckReturnValue @NotNull B identifier(@NotNull @NotNull MqttClientIdentifier identifier)
Client Identifier
.identifier
- the Client Identifier.@CheckReturnValue @NotNull B serverAddress(@NotNull @NotNull InetSocketAddress address)
server address
to connect to.address
- the server address.@CheckReturnValue @NotNull B serverHost(@NotNull @NotNull String host)
server host
to connect to.host
- the server host.@CheckReturnValue @NotNull B serverHost(@NotNull @NotNull InetAddress host)
server host
to connect to.host
- the server host.@CheckReturnValue @NotNull B serverPort(int port)
server port
to connect to.port
- the server port.@Deprecated @NotNull default B useSslWithDefaultConfig()
sslWithDefaultConfig()
.sslWithDefaultConfig()
.@CheckReturnValue @NotNull B sslWithDefaultConfig()
secure transport configuration
to the default configuration.
This means that the systems default trust store, ciphers and protocols are used.
@Deprecated @NotNull default B useSsl(@Nullable @Nullable MqttClientSslConfig sslConfig)
sslConfig(MqttClientSslConfig)
.sslConfig
- use sslConfig(MqttClientSslConfig)
.sslConfig(MqttClientSslConfig)
.@CheckReturnValue @NotNull B sslConfig(@Nullable @Nullable MqttClientSslConfig sslConfig)
secure transport configuration
.sslConfig
- the secure transport configuration or null
to remove any previously set secure
transport configuration.@Deprecated default MqttClientSslConfigBuilder.Nested<? extends B> useSsl()
sslConfig()
.sslConfig()
.sslConfig()
.@CheckReturnValue MqttClientSslConfigBuilder.Nested<? extends B> sslConfig()
sslConfig(MqttClientSslConfig)
.
Calling MqttClientSslConfigBuilder.Nested.applySslConfig()
on the returned builder has the effect of
extending the current secure transport configuration.
sslConfig(MqttClientSslConfig)
@Deprecated @NotNull default B useWebSocketWithDefaultConfig()
webSocketWithDefaultConfig()
.webSocketWithDefaultConfig()
.@CheckReturnValue @NotNull B webSocketWithDefaultConfig()
WebSocket transport configuration
to the default
configuration.@Deprecated @NotNull default B useWebSocket(@Nullable @Nullable MqttWebSocketConfig webSocketConfig)
webSocketConfig(MqttWebSocketConfig)
.webSocketConfig
- use webSocketConfig(MqttWebSocketConfig)
.webSocketConfig(MqttWebSocketConfig)
.@CheckReturnValue @NotNull B webSocketConfig(@Nullable @Nullable MqttWebSocketConfig webSocketConfig)
WebSocket transport configuration
.webSocketConfig
- the WebSocket transport configuration or null
to remove any previously set
WebSocket transport configuration.@Deprecated default MqttWebSocketConfigBuilder.Nested<? extends B> useWebSocket()
webSocketConfig()
.webSocketConfig()
.webSocketConfig()
.@CheckReturnValue MqttWebSocketConfigBuilder.Nested<? extends B> webSocketConfig()
webSocketConfig(MqttWebSocketConfig)
.
Calling MqttWebSocketConfigBuilder.Nested.applyWebSocketConfig()
on the returned builder has the effect
of extending the current WebSocket transport configuration.
webSocketConfig(MqttWebSocketConfig)
@CheckReturnValue @NotNull B transportConfig(@NotNull @NotNull MqttClientTransportConfig transportConfig)
transport configuration
.transportConfig
- the transport configuration.@CheckReturnValue MqttClientTransportConfigBuilder.Nested<? extends B> transportConfig()
transportConfig(MqttClientTransportConfig)
.
Calling MqttClientTransportConfigBuilder.Nested.applyTransportConfig()
on the returned builder has the
effect of extending the current transport configuration.
transportConfig(MqttClientTransportConfig)
@CheckReturnValue @NotNull B executorConfig(@NotNull @NotNull MqttClientExecutorConfig executorConfig)
executor configuration
.executorConfig
- the executor configuration.@CheckReturnValue MqttClientExecutorConfigBuilder.Nested<? extends B> executorConfig()
executorConfig(MqttClientExecutorConfig)
.
Calling MqttClientExecutorConfigBuilder.Nested.applyExecutorConfig()
on the returned builder has the
effect of extending the current executor configuration.
executorConfig(MqttClientExecutorConfig)
@CheckReturnValue @NotNull B automaticReconnectWithDefaultConfig()
@CheckReturnValue @NotNull B automaticReconnect(@Nullable @Nullable MqttClientAutoReconnect autoReconnect)
automatic reconnect strategy
.autoReconnect
- the automatic reconnect strategy or null
to remove any previously set automatic
reconnect strategy.@CheckReturnValue MqttClientAutoReconnectBuilder.Nested<? extends B> automaticReconnect()
automaticReconnect(MqttClientAutoReconnect)
.
Calling MqttClientAutoReconnectBuilder.Nested#applyAutomaticReconnect()
on the returned builder has the
effect of extending the current automatic reconnect strategy.
automaticReconnect(MqttClientAutoReconnect)
@CheckReturnValue @NotNull B addConnectedListener(@NotNull @NotNull MqttClientConnectedListener connectedListener)
The listeners are called in the same order in which they are added.
connectedListener
- the listener to add.@CheckReturnValue @NotNull B addDisconnectedListener(@NotNull @NotNull MqttClientDisconnectedListener disconnectedListener)
The listeners are called in the same order in which they are added.
disconnectedListener
- the listener to add.