Package com.hivemq.client.mqtt

Interface MqttProxyConfigBuilderBase<B extends MqttProxyConfigBuilderBase<B>>

Type Parameters:

B - the type of the builder.

All Known Subinterfaces:

MqttProxyConfigBuilder, MqttProxyConfigBuilder.Nested<P>

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

Builder base for a MqttProxyConfig.

Since:

1.2

Method Summary

Modifier and Type	Method	Description
B	address(@NotNull InetSocketAddress address)	Sets the proxy address to connect to.
B	handshakeTimeout(long timeout, @NotNull TimeUnit timeUnit)	Sets the proxy handshake timeout.
B	host(@NotNull String host)	Sets the proxy host to connect to.
B	host(@NotNull InetAddress host)	Sets the proxy host to connect to.
B	password(@Nullable String password)	Sets the proxy password.
B	port(int port)	Sets the proxy port to connect to.
B	protocol(@NotNull MqttProxyProtocol protocol)	Sets the proxy protocol.
B	username(@Nullable String username)	Sets the proxy username.

Method Details

protocol

@CheckReturnValue
@NotNull
B protocol(@NotNull
 @NotNull MqttProxyProtocol protocol)

Sets the proxy protocol.

Parameters:

protocol - the proxy protocol.

Returns:

the builder.

address

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

Sets the proxy address to connect to.

Parameters:

address - the proxy address.

Returns:

the builder.

host

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

Sets the proxy host to connect to.

Parameters:

host - the proxy host.

Returns:

the builder.

host

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

Sets the proxy host to connect to.

Parameters:

host - the proxy host.

Returns:

the builder.

port

@CheckReturnValue
@NotNull
B port(int port)

Sets the proxy port to connect to.

Parameters:

port - the proxy port.

Returns:

the builder.

username

@CheckReturnValue
@NotNull
B username(@Nullable
 @Nullable String username)

Sets the proxy username.

Parameters:

username - the proxy username.

Returns:

the builder.

password

@CheckReturnValue
@NotNull
B password(@Nullable
 @Nullable String password)

Sets the proxy password.

Parameters:

password - the proxy username.

Returns:

the builder.

handshakeTimeout

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

Sets the proxy handshake timeout.

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

Parameters:

timeout - the proxy handshake timeout or 0 to disable the timeout.

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

Returns:

the builder.