Package com.hivemq.client.mqtt.mqtt5

Interface Mqtt5BlockingClient

All Superinterfaces:

Mqtt5Client, MqttClient

@DoNotImplement
public interface Mqtt5BlockingClient
extends Mqtt5Client

Blocking API of an Mqtt5Client.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Mqtt5BlockingClient.Mqtt5Publishes	Resource which queues incoming Publish messages until they are received.

Field Summary

Fields inherited from interface com.hivemq.client.mqtt.MqttClient

DEFAULT_SERVER_HOST, DEFAULT_SERVER_PORT, DEFAULT_SERVER_PORT_SSL, DEFAULT_SERVER_PORT_WEBSOCKET, DEFAULT_SERVER_PORT_WEBSOCKET_SSL

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt5ConnAck	connect()	Connects this client with the default Connect message.
@NotNull Mqtt5ConnAck	connect(@NotNull Mqtt5Connect connect)	Connects this client with the given Connect message.
@NotNull Mqtt5ConnectBuilder.Send<Mqtt5ConnAck>	connectWith()	Fluent counterpart of connect(Mqtt5Connect).
void	disconnect()	Disconnects this client with the default Disconnect message.
void	disconnect(@NotNull Mqtt5Disconnect disconnect)	Disconnects this client with the given Disconnect message.
@NotNull Mqtt5DisconnectBuilder.SendVoid	disconnectWith()	Fluent counterpart of disconnect(Mqtt5Disconnect).
@NotNull Mqtt5PublishResult	publish(@NotNull Mqtt5Publish publish)	Publishes the given Publish message.
@NotNull Mqtt5BlockingClient.Mqtt5Publishes	publishes(@NotNull MqttGlobalPublishFilter filter)	Globally consumes all incoming Publish messages matching the given filter.
@NotNull Mqtt5BlockingClient.Mqtt5Publishes	publishes(@NotNull MqttGlobalPublishFilter filter, boolean manualAcknowledgement)	Globally consumes all incoming Publish messages matching the given filter.
@NotNull Mqtt5PublishBuilder.Send<Mqtt5PublishResult>	publishWith()	Fluent counterpart of publish(Mqtt5Publish).
void	reauth()	Re-authenticates this client.
@NotNull Mqtt5SubAck	subscribe(@NotNull Mqtt5Subscribe subscribe)	Subscribes this client with the given Subscribe message.
@NotNull Mqtt5SubscribeBuilder.Send.Start<Mqtt5SubAck>	subscribeWith()	Fluent counterpart of subscribe(Mqtt5Subscribe).
default @NotNull Mqtt5BlockingClient	toBlocking()	Turns the API of this client into a blocking API.
@NotNull Mqtt5UnsubAck	unsubscribe(@NotNull Mqtt5Unsubscribe unsubscribe)	Unsubscribes this client with the given Unsubscribe message.
@NotNull Mqtt5UnsubscribeBuilder.Send.Start<Mqtt5UnsubAck>	unsubscribeWith()	Fluent counterpart of unsubscribe(Mqtt5Unsubscribe).

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.Mqtt5Client

getConfig, toAsync, toRx

Methods inherited from interface com.hivemq.client.mqtt.MqttClient

getState

Method Details

connect

@NotNull
@NotNull Mqtt5ConnAck connect()

Connects this client with the default Connect message.

Returns:

see connect(Mqtt5Connect).

See Also:

• connect(Mqtt5Connect)

connect

@NotNull
@NotNull Mqtt5ConnAck connect(@NotNull
 @NotNull Mqtt5Connect connect)

Connects this client with the given Connect message.

Parameters:

connect - the Connect message sent to the broker.

Returns:

the ConnAck message if it does not contain an Error Code (connected successfully).

Throws:

Mqtt5ConnAckException - wrapping the ConnAck message if it contains an Error Code.

connectWith

@CheckReturnValue
@NotNull Mqtt5ConnectBuilder.Send<Mqtt5ConnAck> connectWith()

Fluent counterpart of connect(Mqtt5Connect).

Calling Mqtt5ConnectBuilder.Send.send() on the returned builder has the same effect as calling connect(Mqtt5Connect) with the result of Mqtt5ConnectBuilder.build().

Returns:

the fluent builder for the Connect message.

See Also:

• connect(Mqtt5Connect)

subscribe

@NotNull
@NotNull Mqtt5SubAck subscribe(@NotNull
 @NotNull Mqtt5Subscribe subscribe)

Subscribes this client with the given Subscribe message.

See publishes(MqttGlobalPublishFilter) to consume the incoming Publish messages.

Parameters:

subscribe - the Subscribe messages sent to the broker.

Returns:

the SubAck message if all subscriptions of the Subscribe message were successful (the SubAck message contains no Error Codes).

Throws:

Mqtt5SubAckException - wrapping the SubAck message if it contains at least one Error Code.

subscribeWith

@CheckReturnValue
@NotNull Mqtt5SubscribeBuilder.Send.Start<Mqtt5SubAck> subscribeWith()

Fluent counterpart of subscribe(Mqtt5Subscribe).

Calling Mqtt5SubscribeBuilder.Send.Complete.send() on the returned builder has the same effect as calling subscribe(Mqtt5Subscribe) with the result of Mqtt5SubscribeBuilder.Complete.build().

Returns:

the fluent builder for the Subscribe message.

See Also:

• subscribe(Mqtt5Subscribe)

publishes

@NotNull
@NotNull Mqtt5BlockingClient.Mqtt5Publishes publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter)

Globally consumes all incoming Publish messages matching the given filter.

Parameters:

filter - the filter with which all incoming Publish messages are filtered.

Returns:

a Mqtt5BlockingClient.Mqtt5Publishes instance that can be used to receive the Publish messages on the calling thread.

See Also:

• publishes(MqttGlobalPublishFilter, boolean)

publishes

@NotNull
@NotNull Mqtt5BlockingClient.Mqtt5Publishes publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter,
 boolean manualAcknowledgement)

Globally consumes all incoming Publish messages matching the given filter.

Parameters:

filter - the filter with which all incoming Publish messages are filtered.

manualAcknowledgement - whether the Publish messages are acknowledged manually.

Returns:

a Mqtt5BlockingClient.Mqtt5Publishes instance that can be used to receive the Publish messages on the calling thread.

Since:

1.2

See Also:

• publishes(MqttGlobalPublishFilter)

unsubscribe

@NotNull
@NotNull Mqtt5UnsubAck unsubscribe(@NotNull
 @NotNull Mqtt5Unsubscribe unsubscribe)

Unsubscribes this client with the given Unsubscribe message.

Parameters:

unsubscribe - the Unsubscribe message sent to the broker.

Returns:

the UnsubAck message if all Topic Filters of the Unsubscribe message were successfully unsubscribed (the UnsubAck message contains no Error Codes).

Throws:

Mqtt5UnsubAckException - wrapping the UnsubAck message if it contains at least one Error Code.

unsubscribeWith

@CheckReturnValue
@NotNull Mqtt5UnsubscribeBuilder.Send.Start<Mqtt5UnsubAck> unsubscribeWith()

Fluent counterpart of unsubscribe(Mqtt5Unsubscribe).

Calling Mqtt5UnsubscribeBuilder.Send.Complete.send() on the returned builder has the same effect as calling unsubscribe(Mqtt5Unsubscribe) with the result of Mqtt5UnsubscribeBuilder.Complete.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• unsubscribe(Mqtt5Unsubscribe)

publish

@NotNull
@NotNull Mqtt5PublishResult publish(@NotNull
 @NotNull Mqtt5Publish publish)

Publishes the given Publish message.

Parameters:

publish - the Publish message sent to the broker.

Returns:

the Mqtt5PublishResult if the Publish message was successfully published (no acknowledgement message contains an Error Code, Mqtt5PublishResult.getError() will always be absent).

Throws:

Mqtt5PubAckException - wrapping the corresponding PubAck message if it contains an Error Code.

Mqtt5PubRecException - wrapping the corresponding PubRec message if it contains an Error Code.

publishWith

@CheckReturnValue
@NotNull Mqtt5PublishBuilder.Send<Mqtt5PublishResult> publishWith()

Fluent counterpart of publish(Mqtt5Publish).

Calling Mqtt5PublishBuilder.Send.Complete.send() on the returned builder has the same effect as calling publish(Mqtt5Publish) with the result of Mqtt5PublishBuilder.Complete.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• publish(Mqtt5Publish)

reauth

void reauth()

Re-authenticates this client.

Throws:

Mqtt5AuthException - wrapping the Auth message with the Error Code if not re-authenticated successfully.

disconnect

void disconnect()

Disconnects this client with the default Disconnect message.

See Also:

• disconnect(Mqtt5Disconnect)

disconnect

void disconnect(@NotNull
 @NotNull Mqtt5Disconnect disconnect)

Disconnects this client with the given Disconnect message.

Parameters:

disconnect - the Disconnect message sent to the broker.

disconnectWith

@CheckReturnValue
@NotNull Mqtt5DisconnectBuilder.SendVoid disconnectWith()

Fluent counterpart of disconnect(Mqtt5Disconnect).

Calling Mqtt5DisconnectBuilder.SendVoid.send() on the returned builder has the same effect as calling disconnect(Mqtt5Disconnect) with the result of Mqtt5DisconnectBuilder.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• disconnect(Mqtt5Disconnect)

toBlocking

@CheckReturnValue
@NotNull
default @NotNull Mqtt5BlockingClient toBlocking()

Description copied from interface: Mqtt5Client

Turns the API of this client into a blocking API.

The blocking API can be used simultaneously with the other APIs.

Specified by:

toBlocking in interface Mqtt5Client

Returns:

a blocking API for this client.