Package com.hivemq.client.mqtt

Interface MqttProxyConfig

@DoNotImplement
public interface MqttProxyConfig

Configuration for a proxy to use by MQTT clients.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_HANDSHAKE_TIMEOUT_MS	The default proxy handshake timeout in milliseconds.
static final int	DEFAULT_HTTP_PROXY_PORT	The default HTTP proxy port.
static final @NotNull String	DEFAULT_PROXY_HOST	The default proxy host.
static final @NotNull MqttProxyProtocol	DEFAULT_PROXY_PROTOCOL	The default proxy protocol.
static final int	DEFAULT_SOCKS_PROXY_PORT	The default SOCKS proxy port.

Method Summary

Modifier and Type	Method	Description
static @NotNull MqttProxyConfigBuilder	builder()	Creates a builder for a proxy configuration.
@NotNull MqttProxyConfigBuilder	extend()	Creates a builder for extending this proxy configuration.
@NotNull InetSocketAddress	getAddress()
int	getHandshakeTimeoutMs()
@NotNull Optional<String>	getPassword()
@NotNull MqttProxyProtocol	getProtocol()
@NotNull Optional<String>	getUsername()

Field Details

DEFAULT_PROXY_PROTOCOL

@NotNull
static final @NotNull MqttProxyProtocol DEFAULT_PROXY_PROTOCOL

The default proxy protocol.

DEFAULT_PROXY_HOST

@NotNull
static final @NotNull String DEFAULT_PROXY_HOST

The default proxy host.

See Also:

• Constant Field Values

DEFAULT_SOCKS_PROXY_PORT

static final int DEFAULT_SOCKS_PROXY_PORT

The default SOCKS proxy port.

See Also:

• Constant Field Values

DEFAULT_HTTP_PROXY_PORT

static final int DEFAULT_HTTP_PROXY_PORT

The default HTTP proxy port.

See Also:

• Constant Field Values

DEFAULT_HANDSHAKE_TIMEOUT_MS

static final int DEFAULT_HANDSHAKE_TIMEOUT_MS

The default proxy handshake timeout in milliseconds.

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull MqttProxyConfigBuilder builder()

Creates a builder for a proxy configuration.

Returns:

the created builder for a proxy configuration.

getProtocol

@NotNull
@NotNull MqttProxyProtocol getProtocol()

Returns:

the proxy protocol.

getAddress

@NotNull
@NotNull InetSocketAddress getAddress()

Returns:

the proxy address to connect to.

getUsername

@NotNull
@NotNull Optional<String> getUsername()

Returns:

the optional proxy username.

getPassword

@NotNull
@NotNull Optional<String> getPassword()

Returns:

the optional proxy password.

getHandshakeTimeoutMs

int getHandshakeTimeoutMs()

Returns:

the proxy handshake timeout in milliseconds.

extend

@NotNull
@NotNull MqttProxyConfigBuilder extend()

Creates a builder for extending this proxy configuration.

Returns:

the created builder.