MqttWebSocketConfigBuilderBase (hivemq-mqtt-client 1.3.14 API)

Type Parameters:: B - the type of the builder.

All Known Subinterfaces:: MqttWebSocketConfigBuilder, MqttWebSocketConfigBuilder.Nested<P>

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

Builder base for a MqttWebSocketConfig.

Since:: 1.0

Method Summary

Modifier and Type

Method

Description

B

handshakeTimeout(long timeout, @NotNull TimeUnit timeUnit)

Sets the websocket handshake timeout.

B

httpHeaders(@NotNull Map<String,String> httpHeaders)

Sets the headers.

B

queryString(@NotNull String queryString)

Sets the query string.

B

serverPath(@NotNull String serverPath)

Sets the server path.

B

subprotocol(@NotNull String subprotocol)

Sets the subprotocol.

Method Details
- serverPath
  
  @CheckReturnValue @NotNull B serverPath(@NotNull @NotNull String serverPath)
  
  Sets the server path.
  
  Parameters:
  
  serverPath - the server path.
  
  Returns:
  
  the builder.
- queryString
  
  @CheckReturnValue @NotNull B queryString(@NotNull @NotNull String queryString)
  
  Sets the query string.
  
  Parameters:
  
  queryString - the query string.
  
  Returns:
  
  the builder.
- subprotocol
  
  @CheckReturnValue @NotNull B subprotocol(@NotNull @NotNull String subprotocol)
  
  Sets the subprotocol.
  
  Parameters:
  
  subprotocol - the subprotocol.
  
  Returns:
  
  the builder.
- handshakeTimeout
  
  @CheckReturnValue @NotNull B handshakeTimeout(long timeout, @NotNull @NotNull TimeUnit timeUnit)
  
  Sets the websocket handshake timeout.
  The timeout in milliseconds must be in the range: [0, Integer.MAX_VALUE].
  
  Parameters:
  
  timeout - the websocket 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.
  
  Since:
  
  1.2
- httpHeaders
  
  @CheckReturnValue @NotNull B httpHeaders(@NotNull @NotNull Map<String,String> httpHeaders)
  
  Sets the headers.
  
  Parameters:
  
  httpHeaders - http headers.
  
  Returns:
  
  the builder.