com.hivemq.client.internal.mqtt

Class MqttBlockingClient

java.lang.Object

com.hivemq.client.internal.mqtt.MqttBlockingClient

All Implemented Interfaces:

Mqtt5BlockingClient, Mqtt5Client, MqttClient

public class MqttBlockingClient
extends java.lang.Object
implements Mqtt5BlockingClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt5.Mqtt5BlockingClient

Mqtt5BlockingClient.Mqtt5Publishes

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 and Description
@NotNull Mqtt5ConnAck	connect(@Nullable Mqtt5Connect connect) Connects this client with the given Connect message.
void	disconnect(@NotNull Mqtt5Disconnect disconnect) Disconnects this client with the given Disconnect message.
@NotNull MqttClientConfig	getConfig()
@NotNull Mqtt5PublishResult	publish(@Nullable Mqtt5Publish publish) Publishes the given Publish message.
@NotNull Mqtt5BlockingClient.Mqtt5Publishes	publishes(@Nullable MqttGlobalPublishFilter filter) Globally consumes all incoming Publish messages matching the given filter.
void	reauth() Re-authenticates this client.
@NotNull Mqtt5SubAck	subscribe(@Nullable Mqtt5Subscribe subscribe) Subscribes this client with the given Subscribe message.
@NotNull MqttAsyncClient	toAsync() Turns the API of this client into a asynchronous API based on futures and callbacks.
@NotNull MqttRxClient	toRx() Turns the API of this client into a reactive API.
@NotNull Mqtt5UnsubAck	unsubscribe(@Nullable Mqtt5Unsubscribe unsubscribe) Unsubscribes this client with the given Unsubscribe message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

connect, connectWith, disconnect, disconnectWith, publishWith, subscribeWith, toBlocking, unsubscribeWith

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

builder

Method Detail

connect

@NotNull
public @NotNull Mqtt5ConnAck connect(@Nullable
                                              @Nullable Mqtt5Connect connect)

Description copied from interface: Mqtt5BlockingClient

Connects this client with the given Connect message.

Specified by:

connect in interface Mqtt5BlockingClient

Parameters:

connect - the Connect message sent to the broker.

Returns:

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

subscribe

@NotNull
public @NotNull Mqtt5SubAck subscribe(@Nullable
                                               @Nullable Mqtt5Subscribe subscribe)

Description copied from interface: Mqtt5BlockingClient

Subscribes this client with the given Subscribe message.

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

Specified by:

subscribe in interface Mqtt5BlockingClient

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).

publishes

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

Description copied from interface: Mqtt5BlockingClient

Globally consumes all incoming Publish messages matching the given filter.

Specified by:

publishes in interface Mqtt5BlockingClient

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.

unsubscribe

@NotNull
public @NotNull Mqtt5UnsubAck unsubscribe(@Nullable
                                                   @Nullable Mqtt5Unsubscribe unsubscribe)

Description copied from interface: Mqtt5BlockingClient

Unsubscribes this client with the given Unsubscribe message.

Specified by:

unsubscribe in interface Mqtt5BlockingClient

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).

publish

@NotNull
public @NotNull Mqtt5PublishResult publish(@Nullable
                                                    @Nullable Mqtt5Publish publish)

Description copied from interface: Mqtt5BlockingClient

Publishes the given Publish message.

Specified by:

publish in interface Mqtt5BlockingClient

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).

reauth

public void reauth()

Description copied from interface: Mqtt5BlockingClient

Re-authenticates this client.

Specified by:

reauth in interface Mqtt5BlockingClient

disconnect

public void disconnect(@NotNull
                       @NotNull Mqtt5Disconnect disconnect)

Description copied from interface: Mqtt5BlockingClient

Disconnects this client with the given Disconnect message.

Specified by:

disconnect in interface Mqtt5BlockingClient

Parameters:

disconnect - the Disconnect message sent to the broker.

getConfig

@NotNull
public @NotNull MqttClientConfig getConfig()

Specified by:

getConfig in interface Mqtt5Client

Specified by:

getConfig in interface MqttClient

Returns:

the configuration of this client.

toRx

@NotNull
public @NotNull MqttRxClient toRx()

Description copied from interface: Mqtt5Client

Turns the API of this client into a reactive API.

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

Specified by:

toRx in interface Mqtt5Client

Returns:

a reactive API for this client.

toAsync

@NotNull
public @NotNull MqttAsyncClient toAsync()

Description copied from interface: Mqtt5Client

Turns the API of this client into a asynchronous API based on futures and callbacks.

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

Specified by:

toAsync in interface Mqtt5Client

Returns:

a asynchronous API for this client.