Package com.hivemq.client.mqtt.mqtt3

Interface Mqtt3BlockingClient

All Superinterfaces:

Mqtt3Client, MqttClient

@DoNotImplement
public interface Mqtt3BlockingClient
extends Mqtt3Client

Blocking API of an Mqtt3Client.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Mqtt3BlockingClient.Mqtt3Publishes	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 Mqtt3ConnAck	connect()	Connects this client with the default Connect message.
@NotNull Mqtt3ConnAck	connect(@NotNull Mqtt3Connect connect)	Connects this client with the given Connect message.
@NotNull Mqtt3ConnectBuilder.Send<Mqtt3ConnAck>	connectWith()	Fluent counterpart of connect(Mqtt3Connect).
void	disconnect()	Disconnects this client with the given Disconnect message.
void	publish(@NotNull Mqtt3Publish publish)	Publishes the given Publish message.
@NotNull Mqtt3BlockingClient.Mqtt3Publishes	publishes(@NotNull MqttGlobalPublishFilter filter)	Globally consumes all incoming Publish messages matching the given filter.
@NotNull Mqtt3BlockingClient.Mqtt3Publishes	publishes(@NotNull MqttGlobalPublishFilter filter, boolean manualAcknowledgement)	Globally consumes all incoming Publish messages matching the given filter.
@NotNull Mqtt3PublishBuilder.SendVoid	publishWith()	Fluent counterpart of publish(Mqtt3Publish).
@NotNull Mqtt3SubAck	subscribe(@NotNull Mqtt3Subscribe subscribe)	Subscribes this client with the given Subscribe message.
@NotNull Mqtt3SubscribeBuilder.Send.Start<Mqtt3SubAck>	subscribeWith()	Fluent counterpart of subscribe(Mqtt3Subscribe).
default @NotNull Mqtt3BlockingClient	toBlocking()	Turns the API of this client into a blocking API.
void	unsubscribe(@NotNull Mqtt3Unsubscribe unsubscribe)	Unsubscribes this client with the given Unsubscribe message.
@NotNull Mqtt3UnsubscribeBuilder.SendVoid.Start	unsubscribeWith()	Fluent counterpart of unsubscribe(Mqtt3Unsubscribe).

Methods inherited from interface com.hivemq.client.mqtt.mqtt3.Mqtt3Client

getConfig, toAsync, toRx

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

getState

Method Details

connect

@NotNull
@NotNull Mqtt3ConnAck connect()

Connects this client with the default Connect message.

Returns:

see connect(Mqtt3Connect).

See Also:

• connect(Mqtt3Connect)

connect

@NotNull
@NotNull Mqtt3ConnAck connect(@NotNull
 @NotNull Mqtt3Connect 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:

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

connectWith

@CheckReturnValue
@NotNull Mqtt3ConnectBuilder.Send<Mqtt3ConnAck> connectWith()

Fluent counterpart of connect(Mqtt3Connect).

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

Returns:

the fluent builder for the Connect message.

See Also:

• connect(Mqtt3Connect)

subscribe

@NotNull
@NotNull Mqtt3SubAck subscribe(@NotNull
 @NotNull Mqtt3Subscribe 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:

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

subscribeWith

@CheckReturnValue
@NotNull Mqtt3SubscribeBuilder.Send.Start<Mqtt3SubAck> subscribeWith()

Fluent counterpart of subscribe(Mqtt3Subscribe).

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

Returns:

the fluent builder for the Subscribe message.

See Also:

• subscribe(Mqtt3Subscribe)

publishes

@NotNull
@NotNull Mqtt3BlockingClient.Mqtt3Publishes 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 Mqtt3BlockingClient.Mqtt3Publishes instance that can be used to receive the Publish messages on the calling thread.

See Also:

• publishes(MqttGlobalPublishFilter, boolean)

publishes

@NotNull
@NotNull Mqtt3BlockingClient.Mqtt3Publishes 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 Mqtt3BlockingClient.Mqtt3Publishes instance that can be used to receive the Publish messages on the calling thread.

Since:

1.2

See Also:

• publishes(MqttGlobalPublishFilter)

unsubscribe

void unsubscribe(@NotNull
 @NotNull Mqtt3Unsubscribe unsubscribe)

Unsubscribes this client with the given Unsubscribe message.

Parameters:

unsubscribe - the Unsubscribe message sent to the broker.

unsubscribeWith

@CheckReturnValue
@NotNull Mqtt3UnsubscribeBuilder.SendVoid.Start unsubscribeWith()

Fluent counterpart of unsubscribe(Mqtt3Unsubscribe).

Calling Mqtt3UnsubscribeBuilder.SendVoid.Complete.send() on the returned builder has the same effect as calling unsubscribe(Mqtt3Unsubscribe) with the result of Mqtt3UnsubscribeBuilder.Complete.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• unsubscribe(Mqtt3Unsubscribe)

publish

void publish(@NotNull
 @NotNull Mqtt3Publish publish)

Publishes the given Publish message.

Parameters:

publish - the Publish message sent to the broker.

publishWith

@CheckReturnValue
@NotNull Mqtt3PublishBuilder.SendVoid publishWith()

Fluent counterpart of publish(Mqtt3Publish).

Calling Mqtt3PublishBuilder.SendVoid.Complete.send() on the returned builder has the same effect as calling publish(Mqtt3Publish) with the result of Mqtt3PublishBuilder.Complete.build().

Returns:

the fluent builder for the Unsubscribe message.

See Also:

• publish(Mqtt3Publish)

disconnect

void disconnect()

Disconnects this client with the given Disconnect message.

toBlocking

@CheckReturnValue
@NotNull
default @NotNull Mqtt3BlockingClient toBlocking()

Description copied from interface: Mqtt3Client

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 Mqtt3Client

Returns:

a blocking API for this client.