Package com.hivemq.client.mqtt

Interface MqttClient

All Known Subinterfaces:

Mqtt3AsyncClient, Mqtt3BlockingClient, Mqtt3Client, Mqtt3RxClient, Mqtt5AsyncClient, Mqtt5BlockingClient, Mqtt5Client, Mqtt5RxClient

@DoNotImplement
public interface MqttClient

Common interface for MQTT clients.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull String	DEFAULT_SERVER_HOST	The default server host.
static final int	DEFAULT_SERVER_PORT	The default server port.
static final int	DEFAULT_SERVER_PORT_SSL	The default server port when using SSL/TLS.
static final int	DEFAULT_SERVER_PORT_WEBSOCKET	The default server port when using WebSocket.
static final int	DEFAULT_SERVER_PORT_WEBSOCKET_SSL	The default server port when using SSL/TLS and WebSocket.

Method Summary

Modifier and Type	Method	Description
static @NotNull MqttClientBuilder	builder()	Creates a builder for an MQTT client.
@NotNull MqttClientConfig	getConfig()
default @NotNull MqttClientState	getState()

Field Details

DEFAULT_SERVER_HOST

@NotNull
static final @NotNull String DEFAULT_SERVER_HOST

The default server host.

See Also:

• Constant Field Values

DEFAULT_SERVER_PORT

static final int DEFAULT_SERVER_PORT

The default server port.

See Also:

• Constant Field Values

DEFAULT_SERVER_PORT_SSL

static final int DEFAULT_SERVER_PORT_SSL

The default server port when using SSL/TLS.

See Also:

• Constant Field Values

DEFAULT_SERVER_PORT_WEBSOCKET

static final int DEFAULT_SERVER_PORT_WEBSOCKET

The default server port when using WebSocket.

See Also:

• Constant Field Values

DEFAULT_SERVER_PORT_WEBSOCKET_SSL

static final int DEFAULT_SERVER_PORT_WEBSOCKET_SSL

The default server port when using SSL/TLS and WebSocket.

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull MqttClientBuilder builder()

Creates a builder for an MQTT client.

Returns:

the created builder for an MQTT client.

getConfig

@NotNull
@NotNull MqttClientConfig getConfig()

Returns:

the configuration of this client.

getState

@NotNull
default @NotNull MqttClientState getState()

Returns:

the state of this client.

Since:

1.1