Package com.hivemq.client.mqtt

Interface MqttClientTransportConfig

@DoNotImplement
public interface MqttClientTransportConfig

Configuration for a transport to use by MQTT clients.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MQTT_CONNECT_TIMEOUT_MS	The default timeout between sending the Connect and receiving the ConnAck message in milliseconds.
static final int	DEFAULT_SOCKET_CONNECT_TIMEOUT_MS	The default timeout for connecting the socket to the server in milliseconds.

Method Summary

Modifier and Type	Method	Description
static @NotNull MqttClientTransportConfigBuilder	builder()	Creates a builder for a transport configuration.
@NotNull MqttClientTransportConfigBuilder	extend()	Creates a builder for extending this transport configuration.
@NotNull Optional<InetSocketAddress>	getLocalAddress()
int	getMqttConnectTimeoutMs()
@NotNull Optional<MqttProxyConfig>	getProxyConfig()
@NotNull InetSocketAddress	getServerAddress()
int	getSocketConnectTimeoutMs()
@NotNull Optional<MqttClientSslConfig>	getSslConfig()
@NotNull Optional<MqttWebSocketConfig>	getWebSocketConfig()

Field Details

DEFAULT_SOCKET_CONNECT_TIMEOUT_MS

static final int DEFAULT_SOCKET_CONNECT_TIMEOUT_MS

The default timeout for connecting the socket to the server in milliseconds.

Since:

1.2

See Also:

• Constant Field Values

DEFAULT_MQTT_CONNECT_TIMEOUT_MS

static final int DEFAULT_MQTT_CONNECT_TIMEOUT_MS

The default timeout between sending the Connect and receiving the ConnAck message in milliseconds.

Since:

1.2

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull MqttClientTransportConfigBuilder builder()

Creates a builder for a transport configuration.

Returns:

the created builder for a transport configuration.

getServerAddress

@NotNull
@NotNull InetSocketAddress getServerAddress()

Returns:

the server address to connect to.

getLocalAddress

@NotNull
@NotNull Optional<InetSocketAddress> getLocalAddress()

Returns:

the optional local bind address.

Since:

1.2

getSslConfig

@NotNull
@NotNull Optional<MqttClientSslConfig> getSslConfig()

Returns:

the optional secure transport configuration.

getWebSocketConfig

@NotNull
@NotNull Optional<MqttWebSocketConfig> getWebSocketConfig()

Returns:

the optional WebSocket transport configuration.

getProxyConfig

@NotNull
@NotNull Optional<MqttProxyConfig> getProxyConfig()

Returns:

the optional proxy configuration.

Since:

1.2

getSocketConnectTimeoutMs

int getSocketConnectTimeoutMs()

Returns:

the timeout for connecting the socket to the server in milliseconds.

Since:

1.2

getMqttConnectTimeoutMs

int getMqttConnectTimeoutMs()

Returns:

the timeout between sending the Connect and receiving the ConnAck message in milliseconds.

Since:

1.2

extend

@NotNull
@NotNull MqttClientTransportConfigBuilder extend()

Creates a builder for extending this transport configuration.

Returns:

the created builder.