com.hivemq.client.internal.mqtt.mqtt3

Class Mqtt3RxClientView

java.lang.Object

com.hivemq.client.internal.mqtt.mqtt3.Mqtt3RxClientView

All Implemented Interfaces:

Mqtt3Client, Mqtt3RxClient, MqttClient

public class Mqtt3RxClientView
extends java.lang.Object
implements Mqtt3RxClient

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 io.reactivex.Single<Mqtt3ConnAck>	connect(@Nullable Mqtt3Connect connect) Creates a Single for connecting this client with the given Connect message.
@NotNull io.reactivex.Completable	disconnect() Creates a Completable for disconnecting this client.
@NotNull Mqtt3ClientConfigView	getConfig()
@NotNull io.reactivex.Flowable<Mqtt3PublishResult>	publish(@Nullable io.reactivex.Flowable<Mqtt3Publish> publishFlowable) Creates a Flowable for publishing the Publish messages emitted by the given Flowable.
@NotNull io.reactivex.Flowable<Mqtt3Publish>	publishes(@Nullable MqttGlobalPublishFilter filter) Creates a Flowable for globally consuming all incoming Publish messages matching the given filter.
@NotNull io.reactivex.Single<Mqtt3SubAck>	subscribe(@Nullable Mqtt3Subscribe subscribe) Creates a Single for subscribing this client with the given Subscribe message.
@NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>	subscribeStream(@Nullable Mqtt3Subscribe subscribe) Creates a FlowableWithSingle for subscribing this client with the given Subscribe message.
@NotNull Mqtt3AsyncClientView	toAsync() Turns the API of this client into a asynchronous API based on futures and callbacks.
@NotNull Mqtt3BlockingClientView	toBlocking() Turns the API of this client into a blocking API.
@NotNull io.reactivex.Completable	unsubscribe(@Nullable Mqtt3Unsubscribe unsubscribe) Creates a Single for unsubscribing 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.Mqtt3RxClient

connect, connectWith, subscribeStreamWith, subscribeWith, toRx, unsubscribeWith

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

builder

Method Detail

connect

@NotNull
public @NotNull io.reactivex.Single<Mqtt3ConnAck> connect(@Nullable
                                                                   @Nullable Mqtt3Connect connect)

Description copied from interface: Mqtt3RxClient

Creates a Single for connecting this client with the given Connect message.

The returned Single represents the source of the ConnAck message corresponding to the given Connect message. Calling this method does not connect yet. Connecting is performed lazy and asynchronous when subscribing (in terms of Reactive Streams) to the returned Single.

Specified by:

connect in interface Mqtt3RxClient

Parameters:

connect - the Connect message sent to the broker during connect.

Returns:

the Single which

• succeeds with the ConnAck message if it does not contain an Error Code (connected successfully),
• errors with a Mqtt3ConnAckException wrapping the ConnAck message if it contains an Error Code or
• errors with a different exception if an error occurred before the Connect message was sent or before the ConnAck message was received.

subscribe

@NotNull
public @NotNull io.reactivex.Single<Mqtt3SubAck> subscribe(@Nullable
                                                                    @Nullable Mqtt3Subscribe subscribe)

Description copied from interface: Mqtt3RxClient

Creates a Single for subscribing this client with the given Subscribe message.

The returned Single represents the source of the SubAck message corresponding to the given Subscribe message. Calling this method does not subscribe yet. Subscribing is performed lazy and asynchronous when subscribing (in terms of Reactive Streams) to the returned Single.

See Mqtt3RxClient.publishes(MqttGlobalPublishFilter) to consume the incoming Publish messages. Alternatively, call Mqtt3RxClient.subscribeStream(Mqtt3Subscribe) to consume the incoming Publish messages matching the subscriptions of the Subscribe message directly.

Specified by:

subscribe in interface Mqtt3RxClient

Parameters:

subscribe - the Subscribe message sent to the broker during subscribe.

Returns:

the Single which

• succeeds with the SubAck message if at least one subscription of the Subscribe message was successful (the SubAck message contains at least one Return Code that is not an Error Code),
• errors with a Mqtt3SubAckException wrapping the SubAck message if it only contains Error Codes or
• errors with a different exception if an error occurred before the Subscribe message was sent or before a SubAck message was received.

subscribeStream

@NotNull
public @NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck> subscribeStream(@Nullable
                                                                                      @Nullable Mqtt3Subscribe subscribe)

Description copied from interface: Mqtt3RxClient

Creates a FlowableWithSingle for subscribing this client with the given Subscribe message.

The returned FlowableWithSingle represents the source of the SubAck message corresponding to the given Subscribe message and the source of the incoming Publish messages matching the subscriptions of the Subscribe message. Calling this method does not subscribe yet. Subscribing is performed lazy and asynchronous when subscribing (in terms of Reactive Streams) to the returned FlowableWithSingle.

Specified by:

subscribeStream in interface Mqtt3RxClient

Parameters:

subscribe - the Subscribe message sent to the broker during subscribe.

Returns:

the FlowableWithSingle which

• emits the SubAck message as the single and first element if at least one subscription of the Subscribe message was successful (the SubAck message contains at least one Return Code that is not an Error Code) and then emits the Publish messages matching the successful subscriptions of the Subscribe message,
• completes when all subscriptions of the Subscribe message were unsubscribed,
• errors with a Mqtt3SubAckException wrapping the SubAck message if it only contains Error Codes or
• errors with a different exception if an error occurred before the Subscribe message was sent, before a SubAck message was received or when a error occurs before all subscriptions of the Subscribe message were unsubscribed (e.g. MqttSessionExpiredException).

publishes

@NotNull
public @NotNull io.reactivex.Flowable<Mqtt3Publish> publishes(@Nullable
                                                                       @Nullable MqttGlobalPublishFilter filter)

Description copied from interface: Mqtt3RxClient

Creates a Flowable for globally consuming all incoming Publish messages matching the given filter.

The returned Flowable represents the source of the incoming Publish messages matching the given type. Calling this method does not start consuming yet. This is done lazy and asynchronous when subscribing (in terms of Reactive Streams) to the returned Flowable.

Specified by:

publishes in interface Mqtt3RxClient

Parameters:

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

Returns:

the Flowable which

• emits the incoming Publish messages matching the given filter,
• never completes but
• errors with a MqttSessionExpiredException when the MQTT session expires.

unsubscribe

@NotNull
public @NotNull io.reactivex.Completable unsubscribe(@Nullable
                                                              @Nullable Mqtt3Unsubscribe unsubscribe)

Description copied from interface: Mqtt3RxClient

Creates a Single for unsubscribing this client with the given Unsubscribe message.

The returned Single represents the source of the UnsubAck message corresponding to the given Unsubscribe message. Calling this method does not unsubscribe yet. Unsubscribing is performed lazy and asynchronous when subscribing (in terms of Reactive Streams) to the returned Single.

Specified by:

unsubscribe in interface Mqtt3RxClient

Parameters:

unsubscribe - the Unsubscribe message sent to the broker during unsubscribe.

Returns:

the Single which

• succeeds when the corresponding UnsubAck message was received or
• errors if an error occurred before the Unsubscribe message was sent or before a UnsubAck message was received.

publish

@NotNull
public @NotNull io.reactivex.Flowable<Mqtt3PublishResult> publish(@Nullable
                                                                           @Nullable io.reactivex.Flowable<Mqtt3Publish> publishFlowable)

Description copied from interface: Mqtt3RxClient

Creates a Flowable for publishing the Publish messages emitted by the given Flowable.

The returned Flowable represents the source of Mqtt3PublishResults each corresponding to a Publish message emitted by the given Flowable. Calling this method does not start publishing yet. Publishing is performed lazy and asynchronous. When subscribing (in terms of Reactive Streams) to the returned Flowable the client subscribes (in terms of Reactive Streams) to the given Flowable.

Specified by:

publish in interface Mqtt3RxClient

Parameters:

publishFlowable - the source of the Publish messages to publish.

Returns:

the Flowable which

• emits Mqtt3PublishResults each corresponding to a Publish message,
• completes when the given Flowable completes,
• errors with the same exception when the given Flowable errors or
• errors with a different exception if an error occurred before all Publish messages of the given Flowable are answered by a Mqtt3PublishResult (e.g. MqttSessionExpiredException).

disconnect

@NotNull
public @NotNull io.reactivex.Completable disconnect()

Description copied from interface: Mqtt3RxClient

Creates a Completable for disconnecting this client.

Calling this method does not disconnect yet. Disconnecting is performed lazy and asynchronous when subscribing (in terms of Reactive Streams) to the returned Completable.

Specified by:

disconnect in interface Mqtt3RxClient

Returns:

the Completable which

• completes when the client was successfully disconnected or
• errors if not disconnected gracefully.

getConfig

@NotNull
public @NotNull Mqtt3ClientConfigView getConfig()

Specified by:

getConfig in interface Mqtt3Client

Specified by:

getConfig in interface MqttClient

Returns:

the configuration of this client.

toAsync

@NotNull
public @NotNull Mqtt3AsyncClientView 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.

toBlocking

@NotNull
public @NotNull Mqtt3BlockingClientView 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.