com.hivemq.client.mqtt

Interface MqttClientTransportConfigBuilderBase<B extends MqttClientTransportConfigBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

MqttClientTransportConfigBuilder, MqttClientTransportConfigBuilder.Nested<P>

@DoNotImplement
public interface MqttClientTransportConfigBuilderBase<B extends MqttClientTransportConfigBuilderBase<B>>

Builder base for a MqttClientTransportConfig.

Since:

1.1

Method Summary

Modifier and Type	Method and Description
B	localAddress(@Nullable InetAddress address) Sets the optional local bind address.
B	localAddress(@Nullable InetSocketAddress address) Sets the optional local bind address.
B	localAddress(@Nullable String address) Sets the optional local bind address.
B	localPort(int port) Sets the optional local bind port.
B	mqttConnectTimeout(long timeout, @NotNull TimeUnit timeUnit) Sets the timeout between sending the Connect and receiving the ConnAck message.
MqttProxyConfigBuilder.Nested<? extends B>	proxyConfig() Fluent counterpart of proxyConfig(MqttProxyConfig).
B	proxyConfig(@Nullable MqttProxyConfig proxyConfig) Sets the optional proxy configuration.
B	serverAddress(@NotNull InetSocketAddress address) Sets the server address to connect to.
B	serverHost(@NotNull InetAddress host) Sets the server host to connect to.
B	serverHost(@NotNull String host) Sets the server host to connect to.
B	serverPort(int port) Sets the server port to connect to.
B	socketConnectTimeout(long timeout, @NotNull TimeUnit timeUnit) Sets the timeout for connecting the socket to the server.
MqttClientSslConfigBuilder.Nested<? extends B>	sslConfig() Fluent counterpart of sslConfig(MqttClientSslConfig).
B	sslConfig(@Nullable MqttClientSslConfig sslConfig) Sets the optional secure transport configuration.
B	sslWithDefaultConfig() Sets the secure transport configuration to the default configuration.
MqttWebSocketConfigBuilder.Nested<? extends B>	webSocketConfig() Fluent counterpart of webSocketConfig(MqttWebSocketConfig).
B	webSocketConfig(@Nullable MqttWebSocketConfig webSocketConfig) Sets the optional WebSocket transport configuration.
B	webSocketWithDefaultConfig() Sets the WebSocket transport configuration to the default configuration.

Method Detail

serverAddress

@CheckReturnValue
 @NotNull
B serverAddress(@NotNull
                                            @NotNull InetSocketAddress address)

Sets the server address to connect to.

Parameters:

address - the server address.

Returns:

the builder.

serverHost

@CheckReturnValue
 @NotNull
B serverHost(@NotNull
                                         @NotNull String host)

Sets the server host to connect to.

Parameters:

host - the server host.

Returns:

the builder.

serverHost

@CheckReturnValue
 @NotNull
B serverHost(@NotNull
                                         @NotNull InetAddress host)

Sets the server host to connect to.

Parameters:

host - the server host.

Returns:

the builder.

serverPort

@CheckReturnValue
 @NotNull
B serverPort(int port)

Sets the server port to connect to.

Parameters:

port - the server port.

Returns:

the builder.

localAddress

@CheckReturnValue
 @NotNull
B localAddress(@Nullable
                                           @Nullable InetSocketAddress address)

Sets the optional local bind address.

The address must be resolved.

Parameters:

address - the local bind address.

Returns:

the builder.

Since:

1.2

localAddress

@CheckReturnValue
 @NotNull
B localAddress(@Nullable
                                           @Nullable String address)

Sets the optional local bind address.

The address must be resolvable.

Parameters:

address - the local bind address.

Returns:

the builder.

Since:

1.2

localAddress

@CheckReturnValue
 @NotNull
B localAddress(@Nullable
                                           @Nullable InetAddress address)

Sets the optional local bind address.

Parameters:

address - the local bind address

Returns:

the builder.

Since:

1.2

localPort

@CheckReturnValue
 @NotNull
B localPort(int port)

Sets the optional local bind port.

Parameters:

port - the local bind port.

Returns:

the builder.

Since:

1.2

sslWithDefaultConfig

@CheckReturnValue
 @NotNull
B sslWithDefaultConfig()

Sets the secure transport configuration to the default configuration.

This means that the systems default trust store, ciphers and protocols are used.

Returns:

the builder.

sslConfig

@CheckReturnValue
 @NotNull
B sslConfig(@Nullable
                                        @Nullable MqttClientSslConfig sslConfig)

Sets the optional secure transport configuration.

Parameters:

sslConfig - the secure transport configuration or null to remove any previously set secure transport configuration.

Returns:

the builder.

sslConfig

@CheckReturnValue
MqttClientSslConfigBuilder.Nested<? extends B> sslConfig()

Fluent counterpart of sslConfig(MqttClientSslConfig).

Calling MqttClientSslConfigBuilder.Nested.applySslConfig() on the returned builder has the effect of extending the current secure transport configuration.

Returns:

the fluent builder for the secure transport configuration.

See Also:

sslConfig(MqttClientSslConfig)

webSocketWithDefaultConfig

@CheckReturnValue
 @NotNull
B webSocketWithDefaultConfig()

Sets the WebSocket transport configuration to the default configuration.

Returns:

the builder.

webSocketConfig

@CheckReturnValue
 @NotNull
B webSocketConfig(@Nullable
                                              @Nullable MqttWebSocketConfig webSocketConfig)

Sets the optional WebSocket transport configuration.

Parameters:

webSocketConfig - the WebSocket transport configuration or null to remove any previously set WebSocket transport configuration.

Returns:

the builder.

webSocketConfig

@CheckReturnValue
MqttWebSocketConfigBuilder.Nested<? extends B> webSocketConfig()

Fluent counterpart of webSocketConfig(MqttWebSocketConfig).

Calling MqttWebSocketConfigBuilder.Nested.applyWebSocketConfig() on the returned builder has the effect of extending the current WebSocket transport configuration.

Returns:

the fluent builder for the WebSocket configuration.

See Also:

webSocketConfig(MqttWebSocketConfig)

proxyConfig

@CheckReturnValue
 @NotNull
B proxyConfig(@Nullable
                                          @Nullable MqttProxyConfig proxyConfig)

Sets the optional proxy configuration.

Parameters:

proxyConfig - the proxy configuration or null to remove any previously set proxy configuration.

Returns:

the builder.

Since:

1.2

proxyConfig

@CheckReturnValue
MqttProxyConfigBuilder.Nested<? extends B> proxyConfig()

Fluent counterpart of proxyConfig(MqttProxyConfig).

Calling MqttProxyConfigBuilder.Nested.applyProxyConfig() on the returned builder has the effect of extending the current proxy configuration.

Returns:

the fluent builder for the proxy configuration.

Since:

1.2

See Also:

proxyConfig(MqttProxyConfig)

socketConnectTimeout

@CheckReturnValue
 @NotNull
B socketConnectTimeout(long timeout,
                                                   @NotNull
                                                   @NotNull TimeUnit timeUnit)

Sets the timeout for connecting the socket to the server.

The timeout in milliseconds must be in the range: [0, Integer.MAX_VALUE].

Parameters:

timeout - the timeout for connecting the socket to the server or 0 to disable the timeout.

timeUnit - the time unit of the given timeout (this timeout only supports millisecond precision).

Returns:

the builder.

Since:

1.2

mqttConnectTimeout

@CheckReturnValue
 @NotNull
B mqttConnectTimeout(long timeout,
                                                 @NotNull
                                                 @NotNull TimeUnit timeUnit)

Sets the timeout between sending the Connect and receiving the ConnAck message.

The timeout in milliseconds must be in the range: [0, Integer.MAX_VALUE].

Parameters:

timeout - the timeout between sending the Connect and receiving the ConnAck message or 0 to disable the timeout.

timeUnit - the time unit of the given timeout (this timeout only supports millisecond precision).

Returns:

the builder.

Since:

1.2