Package com.hivemq.client.mqtt.mqtt3

Interface Mqtt3RxClient

All Superinterfaces:

Mqtt3Client, MqttClient

@DoNotImplement
public interface Mqtt3RxClient
extends Mqtt3Client

Reactive API of an Mqtt3Client.

Since:

1.0

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 Single<Mqtt3ConnAck>	connect()	Creates a Single for connecting this client with the default Connect message.
@NotNull Single<Mqtt3ConnAck>	connect(@NotNull Mqtt3Connect connect)	Creates a Single for connecting this client with the given Connect message.
@NotNull Mqtt3ConnectBuilder.Nested<Single<Mqtt3ConnAck>>	connectWith()	Fluent counterpart of connect(Mqtt3Connect).
@NotNull Completable	disconnect()	Creates a Completable for disconnecting this client.
@NotNull Flowable<Mqtt3PublishResult>	publish(@NotNull Flowable<Mqtt3Publish> publishFlowable)	Creates a Flowable for publishing the Publish messages emitted by the given Flowable.
@NotNull Flowable<Mqtt3Publish>	publishes(@NotNull MqttGlobalPublishFilter filter)	Creates a Flowable for globally consuming all incoming Publish messages matching the given filter.
@NotNull Flowable<Mqtt3Publish>	publishes(@NotNull MqttGlobalPublishFilter filter, boolean manualAcknowledgement)	Creates a Flowable for globally consuming all incoming Publish messages matching the given filter.
@NotNull Single<Mqtt3SubAck>	subscribe(@NotNull Mqtt3Subscribe subscribe)	Creates a Single for subscribing this client with the given Subscribe message.
@NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>	subscribePublishes(@NotNull Mqtt3Subscribe subscribe)	Creates a FlowableWithSingle for subscribing this client with the given Subscribe message.
@NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>	subscribePublishes(@NotNull Mqtt3Subscribe subscribe, boolean manualAcknowledgement)	Creates a FlowableWithSingle for subscribing this client with the given Subscribe message.
@NotNull Mqtt3SubscribeBuilder.Publishes.Start<FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>>	subscribePublishesWith()	Fluent counterpart of subscribePublishes(Mqtt3Subscribe, boolean).
@NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>	subscribeStream(@NotNull Mqtt3Subscribe subscribe)	Deprecated. use subscribePublishes(Mqtt3Subscribe).
@NotNull Mqtt3SubscribeBuilder.Nested.Start<FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>>	subscribeStreamWith()	Deprecated. use subscribePublishesWith().
@NotNull Mqtt3SubscribeBuilder.Nested.Start<Single<Mqtt3SubAck>>	subscribeWith()	Fluent counterpart of subscribe(Mqtt3Subscribe).
default @NotNull Mqtt3RxClient	toRx()	Turns the API of this client into a reactive API.
@NotNull Completable	unsubscribe(@NotNull Mqtt3Unsubscribe unsubscribe)	Creates a Completable for unsubscribing this client with the given Unsubscribe message.
@NotNull Mqtt3UnsubscribeBuilder.Nested.Start<Completable>	unsubscribeWith()	Fluent counterpart of unsubscribe(Mqtt3Unsubscribe).

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

getConfig, toAsync, toBlocking

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

getState

Method Details

connect

@CheckReturnValue
@NotNull
@NotNull Single<Mqtt3ConnAck> connect()

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

Returns:

see connect(Mqtt3Connect).

See Also:

• connect(Mqtt3Connect)

connect

@CheckReturnValue
@NotNull
@NotNull Single<Mqtt3ConnAck> connect(@NotNull
 @NotNull Mqtt3Connect connect)

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.

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.

connectWith

@CheckReturnValue
@NotNull Mqtt3ConnectBuilder.Nested<Single<Mqtt3ConnAck>> connectWith()

Fluent counterpart of connect(Mqtt3Connect).

Calling Mqtt3ConnectBuilder.Nested.applyConnect() 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

@CheckReturnValue
@NotNull
@NotNull Single<Mqtt3SubAck> subscribe(@NotNull
 @NotNull Mqtt3Subscribe subscribe)

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 publishes(MqttGlobalPublishFilter) to consume the incoming Publish messages. Alternatively, call subscribePublishes(Mqtt3Subscribe) to consume the incoming Publish messages matching the subscriptions of the Subscribe message directly.

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.

subscribeWith

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

Fluent counterpart of subscribe(Mqtt3Subscribe).

Calling Mqtt3SubscribeBuilder.Nested.Complete.applySubscribe() 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)

subscribeStream

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

Deprecated.

use subscribePublishes(Mqtt3Subscribe).

Use subscribePublishes(Mqtt3Subscribe).

Parameters:

subscribe - use subscribePublishes(Mqtt3Subscribe).

Returns:

use subscribePublishes(Mqtt3Subscribe).

subscribeStreamWith

@Deprecated
@NotNull Mqtt3SubscribeBuilder.Nested.Start<FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>> subscribeStreamWith()

Deprecated.

use subscribePublishesWith().

Use subscribePublishesWith().

Returns:

use subscribePublishesWith().

subscribePublishes

@CheckReturnValue
@NotNull
@NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck> subscribePublishes(@NotNull
 @NotNull Mqtt3Subscribe subscribe)

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.

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

Since:

1.2

See Also:

• subscribePublishes(Mqtt3Subscribe, boolean)

subscribePublishes

@CheckReturnValue
@NotNull
@NotNull FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck> subscribePublishes(@NotNull
 @NotNull Mqtt3Subscribe subscribe,
 boolean manualAcknowledgement)

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.

Parameters:

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

manualAcknowledgement - whether the Publish messages are acknowledged manually.

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

Since:

1.2

See Also:

• subscribePublishes(Mqtt3Subscribe)

subscribePublishesWith

@CheckReturnValue
@NotNull Mqtt3SubscribeBuilder.Publishes.Start<FlowableWithSingle<Mqtt3Publish,Mqtt3SubAck>> subscribePublishesWith()

Fluent counterpart of subscribePublishes(Mqtt3Subscribe, boolean).

Calling Mqtt3SubscribeBuilder.Nested.Complete.applySubscribe() on the returned builder has the same effect as calling subscribePublishes(Mqtt3Subscribe) with the result of Mqtt3SubscribeBuilder.Complete.build().

Returns:

the fluent builder for the Subscribe message.

Since:

1.2

See Also:

• subscribePublishes(Mqtt3Subscribe, boolean)

publishes

@CheckReturnValue
@NotNull
@NotNull Flowable<Mqtt3Publish> publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter)

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.

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.

See Also:

• publishes(MqttGlobalPublishFilter, boolean)

publishes

@CheckReturnValue
@NotNull
@NotNull Flowable<Mqtt3Publish> publishes(@NotNull
 @NotNull MqttGlobalPublishFilter filter,
 boolean manualAcknowledgement)

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.

Parameters:

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

manualAcknowledgement - whether the Publish messages are acknowledged manually.

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.

Since:

1.2

See Also:

• publishes(MqttGlobalPublishFilter)

unsubscribe

@CheckReturnValue
@NotNull
@NotNull Completable unsubscribe(@NotNull
 @NotNull Mqtt3Unsubscribe unsubscribe)

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

The returned Completable 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 Completable.

Parameters:

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

Returns:

the Completable 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.

unsubscribeWith

@CheckReturnValue
@NotNull Mqtt3UnsubscribeBuilder.Nested.Start<Completable> unsubscribeWith()

Fluent counterpart of unsubscribe(Mqtt3Unsubscribe).

Calling Mqtt3UnsubscribeBuilder.Nested.Complete.applyUnsubscribe() 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

@CheckReturnValue
@NotNull
@NotNull Flowable<Mqtt3PublishResult> publish(@NotNull
 @NotNull Flowable<Mqtt3Publish> publishFlowable)

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.

Parameters:

publishFlowable - the source of the Publish messages to publish.

Returns:

the Flowable which

• emits Mqtt3PublishResults each corresponding to a Publish message,
• completes if the given Flowable completes, but not before all Mqtt3PublishResults were emitted, or
• errors with the same exception if the given Flowable errors, but not before all Mqtt3PublishResults were emitted.

disconnect

@CheckReturnValue
@NotNull
@NotNull Completable disconnect()

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.

Returns:

the Completable which

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

toRx

@CheckReturnValue
@NotNull
default @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.