com.hivemq.client.internal.mqtt.mqtt3

Class Mqtt3BlockingClientView

java.lang.Object

com.hivemq.client.internal.mqtt.mqtt3.Mqtt3BlockingClientView

All Implemented Interfaces:

Mqtt3BlockingClient, Mqtt3Client, MqttClient

public class Mqtt3BlockingClientView
extends java.lang.Object
implements Mqtt3BlockingClient

Nested Class Summary

Nested classes/interfaces inherited from interface com.hivemq.client.mqtt.mqtt3.Mqtt3BlockingClient

Mqtt3BlockingClient.Mqtt3Publishes

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 Mqtt3ConnAck	connect(@Nullable Mqtt3Connect connect) Connects this client with the given Connect message.
void	disconnect() Disconnects this client with the given Disconnect message.
@NotNull Mqtt3ClientConfig	getConfig()
void	publish(@Nullable Mqtt3Publish publish) Publishes the given Publish message.
@NotNull Mqtt3BlockingClient.Mqtt3Publishes	publishes(@Nullable MqttGlobalPublishFilter filter) Globally consumes all incoming Publish messages matching the given filter.
@NotNull Mqtt3SubAck	subscribe(@Nullable Mqtt3Subscribe subscribe) Subscribes this client with the given Subscribe message.
@NotNull Mqtt3AsyncClient	toAsync() Turns the API of this client into a asynchronous API based on futures and callbacks.
@NotNull Mqtt3RxClient	toRx() Turns the API of this client into a reactive API.
void	unsubscribe(@Nullable Mqtt3Unsubscribe 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.mqtt3.Mqtt3BlockingClient

connect, connectWith, publishWith, subscribeWith, toBlocking, unsubscribeWith

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

builder

Method Detail

connect

@NotNull
public @NotNull Mqtt3ConnAck connect(@Nullable
                                              @Nullable Mqtt3Connect connect)

Description copied from interface: Mqtt3BlockingClient

Connects this client with the given Connect message.

Specified by:

connect in interface Mqtt3BlockingClient

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 Mqtt3SubAck subscribe(@Nullable
                                               @Nullable Mqtt3Subscribe subscribe)

Description copied from interface: Mqtt3BlockingClient

Subscribes this client with the given Subscribe message.

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

Specified by:

subscribe in interface Mqtt3BlockingClient

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 Mqtt3BlockingClient.Mqtt3Publishes publishes(@Nullable
                                                                      @Nullable MqttGlobalPublishFilter filter)

Description copied from interface: Mqtt3BlockingClient

Globally consumes all incoming Publish messages matching the given filter.

Specified by:

publishes in interface Mqtt3BlockingClient

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.

unsubscribe

public void unsubscribe(@Nullable
                        @Nullable Mqtt3Unsubscribe unsubscribe)

Description copied from interface: Mqtt3BlockingClient

Unsubscribes this client with the given Unsubscribe message.

Specified by:

unsubscribe in interface Mqtt3BlockingClient

Parameters:

unsubscribe - the Unsubscribe message sent to the broker.

publish

public void publish(@Nullable
                    @Nullable Mqtt3Publish publish)

Description copied from interface: Mqtt3BlockingClient

Publishes the given Publish message.

Specified by:

publish in interface Mqtt3BlockingClient

Parameters:

publish - the Publish message sent to the broker.

disconnect

public void disconnect()

Description copied from interface: Mqtt3BlockingClient

Disconnects this client with the given Disconnect message.

Specified by:

disconnect in interface Mqtt3BlockingClient

getConfig

@NotNull
public @NotNull Mqtt3ClientConfig getConfig()

Specified by:

getConfig in interface Mqtt3Client

Specified by:

getConfig in interface MqttClient

Returns:

the configuration of this client.

toRx

@NotNull
public @NotNull Mqtt3RxClient toRx()

Description copied from interface: Mqtt3Client

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 Mqtt3Client

Returns:

a reactive API for this client.

toAsync

@NotNull
public @NotNull Mqtt3AsyncClient toAsync()

Description copied from interface: Mqtt3Client

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 Mqtt3Client

Returns:

a asynchronous API for this client.