Package com.hivemq.client.mqtt.mqtt3.message.connect

Interface Mqtt3Connect

All Superinterfaces:

Mqtt3Message

@DoNotImplement
public interface Mqtt3Connect
extends Mqtt3Message

MQTT 3 Connect message. This message is translated from and to an MQTT 3 CONNECT packet.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_CLEAN_SESSION	The default whether a client wants a clean session.
static final int	DEFAULT_KEEP_ALIVE	The default keep alive in seconds a client wants to use.
static final int	NO_KEEP_ALIVE	The value that disables keep alive.

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt3ConnectBuilder	builder()	Creates a builder for a Connect message.
@NotNull Mqtt3ConnectBuilder	extend()	Creates a builder for extending this Connect message.
int	getKeepAlive()
@NotNull Mqtt3ConnectRestrictions	getRestrictions()
@NotNull Optional<Mqtt3SimpleAuth>	getSimpleAuth()
default @NotNull Mqtt3MessageType	getType()
@NotNull Optional<Mqtt3Publish>	getWillPublish()
boolean	isCleanSession()

Field Details

NO_KEEP_ALIVE

static final int NO_KEEP_ALIVE

The value that disables keep alive.

See Also:

• Constant Field Values

DEFAULT_KEEP_ALIVE

static final int DEFAULT_KEEP_ALIVE

The default keep alive in seconds a client wants to use.

See Also:

• Constant Field Values

DEFAULT_CLEAN_SESSION

static final boolean DEFAULT_CLEAN_SESSION

The default whether a client wants a clean session.

See Also:

• Constant Field Values

Method Details

builder

@NotNull
static @NotNull Mqtt3ConnectBuilder builder()

Creates a builder for a Connect message.

Returns:

the created builder.

getKeepAlive

int getKeepAlive()

Returns:

the keep alive in seconds the client wants to use.

isCleanSession

boolean isCleanSession()

Returns:

whether the client wants a clean session. If true an existing session is cleared.

getRestrictions

@NotNull
@NotNull Mqtt3ConnectRestrictions getRestrictions()

Returns:

the restrictions set from the client.

Since:

1.3

getSimpleAuth

@NotNull
@NotNull Optional<Mqtt3SimpleAuth> getSimpleAuth()

Returns:

the optional simple authentication and/or authorization related data of this Connect message.

getWillPublish

@NotNull
@NotNull Optional<Mqtt3Publish> getWillPublish()

Returns:

the optional Will Publish of this Connect message.

getType

@NotNull
default @NotNull Mqtt3MessageType getType()

Specified by:

getType in interface Mqtt3Message

Returns:

the type of this MQTT message.

extend

@NotNull
@NotNull Mqtt3ConnectBuilder extend()

Creates a builder for extending this Connect message.

Returns:

the created builder.