com.hivemq.client.mqtt

Interface MqttWebSocketConfig

All Known Implementing Classes:

MqttWebSocketConfigImpl

@DoNotImplement
public interface MqttWebSocketConfig

Configuration for a WebSocket transport to use by MQTT clients.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull java.lang.String	DEFAULT_MQTT_SUBPROTOCOL The default WebSocket subprotocol.
static @NotNull java.lang.String	DEFAULT_SERVER_PATH The default WebSocket server path.

Method Summary

Modifier and Type	Method and Description
static @NotNull MqttWebSocketConfigBuilder	builder() Creates a builder for a WebSocket configuration.
@NotNull MqttWebSocketConfigBuilder	extend() Creates a builder for extending this WebSocket configuration.
@NotNull java.lang.String	getServerPath()
@NotNull java.lang.String	getSubprotocol()

Field Detail

DEFAULT_SERVER_PATH

@NotNull
static final @NotNull java.lang.String DEFAULT_SERVER_PATH

The default WebSocket server path.

See Also:

Constant Field Values

DEFAULT_MQTT_SUBPROTOCOL

@NotNull
static final @NotNull java.lang.String DEFAULT_MQTT_SUBPROTOCOL

The default WebSocket subprotocol.

See the WebSocket Subprotocol Name Registry

See Also:

Constant Field Values

Method Detail

builder

@NotNull
static @NotNull MqttWebSocketConfigBuilder builder()

Creates a builder for a WebSocket configuration.

Returns:

the created builder for a WebSocket configuration.

getServerPath

@NotNull
@NotNull java.lang.String getServerPath()

Returns:

the WebSocket server path.

getSubprotocol

@NotNull
@NotNull java.lang.String getSubprotocol()

Returns:

the WebSocket subprotocol.

extend

@NotNull
@NotNull MqttWebSocketConfigBuilder extend()

Creates a builder for extending this WebSocket configuration.

Returns:

the created builder.

Since:

1.1