io.vertx.rxjava3.mqtt

Class MqttClient

java.lang.Object

io.vertx.rxjava3.mqtt.MqttClient

public class MqttClient
extends Object

An MQTT client

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.rx.TypeArg<MqttClient>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
MqttClient(MqttClient delegate)
MqttClient(Object delegate)

Method Summary

Modifier and Type	Method and Description
String	clientId()
MqttClient	closeHandler(Handler<Void> closeHandler) Set a handler that will be called when the connection with server is closed
Single<MqttConnAckMessage>	connect(int port, String host) Connects to an MQTT server calling connectHandler after connection
Single<MqttConnAckMessage>	connect(int port, String host, String serverName) Connects to an MQTT server calling connectHandler after connection
static MqttClient	create(Vertx vertx) Return an MQTT client instance using the default options
static MqttClient	create(Vertx vertx, MqttClientOptions options) Return an MQTT client instance
Completable	disconnect() Disconnects from the MQTT server calling disconnectHandler after disconnection
boolean	equals(Object o)
MqttClient	exceptionHandler(Handler<Throwable> handler) Set an exception handler for the client, that will be called when an error happens in internal netty structures.
MqttClient	getDelegate()
int	hashCode()
boolean	isConnected()
static MqttClient	newInstance(MqttClient arg)
MqttClient	ping() This method is needed by the client in order to avoid server closes the connection due to the keep alive timeout if client has no messages to send
MqttClient	pingResponseHandler(Handler<Void> pingResponseHandler) Sets handler which will be called after PINGRESP packet receiving
Single<Integer>	publish(String topic, Buffer payload, MqttQoS qosLevel, boolean isDup, boolean isRetain) Sends the PUBLISH message to the remote MQTT server
MqttClient	publishCompletionExpirationHandler(Handler<Integer> publishCompletionExpirationHandler) Sets a handler which will be called when the client does not receive a PUBACK or PUBREC/PUBCOMP for a message published using QoS 1 or 2 respectively.
MqttClient	publishCompletionHandler(Handler<Integer> publishCompletionHandler) Sets a handler which will be called each time the publishing of a message has been completed.
MqttClient	publishCompletionUnknownPacketIdHandler(Handler<Integer> publishCompletionPhantomHandler) Sets a handler which will be called when the client receives a PUBACK/PUBREC/PUBCOMP with an unknown packet ID.
MqttClient	publishHandler(Handler<MqttPublishMessage> publishHandler) Sets handler which will be called each time server publish something to client
Single<MqttConnAckMessage>	rxConnect(int port, String host) Connects to an MQTT server calling connectHandler after connection
Single<MqttConnAckMessage>	rxConnect(int port, String host, String serverName) Connects to an MQTT server calling connectHandler after connection
Completable	rxDisconnect() Disconnects from the MQTT server calling disconnectHandler after disconnection
Single<Integer>	rxPublish(String topic, Buffer payload, MqttQoS qosLevel, boolean isDup, boolean isRetain) Sends the PUBLISH message to the remote MQTT server
Single<Integer>	rxSubscribe(Map<String,Integer> topics) Subscribes to the topic and adds a handler which will be called after the request is sent
Single<Integer>	rxSubscribe(String topic, int qos) Subscribes to the topic with a specified QoS level
Single<Integer>	rxUnsubscribe(List<String> topics) Unsubscribe from receiving messages on given topics
Single<Integer>	rxUnsubscribe(String topic) Unsubscribe from receiving messages on given topic
Single<Integer>	subscribe(Map<String,Integer> topics) Subscribes to the topic and adds a handler which will be called after the request is sent
Single<Integer>	subscribe(String topic, int qos) Subscribes to the topic with a specified QoS level
MqttClient	subscribeCompletionHandler(Handler<MqttSubAckMessage> subscribeCompletionHandler) Sets handler which will be called after SUBACK packet receiving
String	toString()
Single<Integer>	unsubscribe(List<String> topics) Unsubscribe from receiving messages on given topics
Single<Integer>	unsubscribe(String topic) Unsubscribe from receiving messages on given topic
MqttClient	unsubscribeCompletionHandler(Handler<Integer> unsubscribeCompletionHandler) Sets handler which will be called after UNSUBACK packet receiving

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<MqttClient> __TYPE_ARG

Constructor Detail

MqttClient

public MqttClient(MqttClient delegate)

MqttClient

public MqttClient(Object delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public MqttClient getDelegate()

create

public static MqttClient create(Vertx vertx,
                                MqttClientOptions options)

Return an MQTT client instance

Parameters:

vertx - Vert.x instance

options - MQTT client options

Returns:

MQTT client instance

create

public static MqttClient create(Vertx vertx)

Return an MQTT client instance using the default options

Parameters:

vertx - Vert.x instance

Returns:

MQTT client instance

connect

public Single<MqttConnAckMessage> connect(int port,
                                          String host)

Connects to an MQTT server calling connectHandler after connection

Parameters:

port - port of the MQTT server

host - hostname/ip address of the MQTT server

Returns:

current MQTT client instance

rxConnect

public Single<MqttConnAckMessage> rxConnect(int port,
                                            String host)

Connects to an MQTT server calling connectHandler after connection

Parameters:

port - port of the MQTT server

host - hostname/ip address of the MQTT server

Returns:

current MQTT client instance

connect

public Single<MqttConnAckMessage> connect(int port,
                                          String host,
                                          String serverName)

Connects to an MQTT server calling connectHandler after connection

Parameters:

port - port of the MQTT server

host - hostname/ip address of the MQTT server

serverName - the SNI server name

Returns:

current MQTT client instance

rxConnect

public Single<MqttConnAckMessage> rxConnect(int port,
                                            String host,
                                            String serverName)

Connects to an MQTT server calling connectHandler after connection

Parameters:

port - port of the MQTT server

host - hostname/ip address of the MQTT server

serverName - the SNI server name

Returns:

current MQTT client instance

disconnect

public Completable disconnect()

Disconnects from the MQTT server calling disconnectHandler after disconnection

Returns:

current MQTT client instance

rxDisconnect

public Completable rxDisconnect()

Disconnects from the MQTT server calling disconnectHandler after disconnection

Returns:

current MQTT client instance

publish

public Single<Integer> publish(String topic,
                               Buffer payload,
                               MqttQoS qosLevel,
                               boolean isDup,
                               boolean isRetain)

Sends the PUBLISH message to the remote MQTT server

Parameters:

topic - topic on which the message is published

payload - message payload

qosLevel - QoS level

isDup - if the message is a duplicate

isRetain - if the message needs to be retained

Returns:

current MQTT client instance

rxPublish

public Single<Integer> rxPublish(String topic,
                                 Buffer payload,
                                 MqttQoS qosLevel,
                                 boolean isDup,
                                 boolean isRetain)

Sends the PUBLISH message to the remote MQTT server

Parameters:

topic - topic on which the message is published

payload - message payload

qosLevel - QoS level

isDup - if the message is a duplicate

isRetain - if the message needs to be retained

Returns:

current MQTT client instance

publishCompletionHandler

public MqttClient publishCompletionHandler(Handler<Integer> publishCompletionHandler)

Sets a handler which will be called each time the publishing of a message has been completed.

For a message that has been published using

• QoS 0 this means that the client has successfully sent the corresponding PUBLISH packet,
• QoS 1 this means that a corresponding PUBACK has been received from the server,
• QoS 2 this means that a corresponding PUBCOMP has been received from the server.

Parameters:

publishCompletionHandler - handler called with the packetId

Returns:

current MQTT client instance

publishCompletionExpirationHandler

public MqttClient publishCompletionExpirationHandler(Handler<Integer> publishCompletionExpirationHandler)

Sets a handler which will be called when the client does not receive a PUBACK or PUBREC/PUBCOMP for a message published using QoS 1 or 2 respectively.

The time to wait for an acknowledgement message can be configured using MqttClientOptions. If the client receives a PUBACK/PUBREC/PUBCOMP for a message after its completion has expired, the handler registered using publishCompletionUnknownPacketIdHandler(io.vertx.core.Handler<java.lang.Integer>) will be invoked.

Note that this behavior is outside the scope of the MQTT 3.1.1 specification. The client's default behavior is therefore to wait forever for the server's corresponding acknowledgement.

Parameters:

publishCompletionExpirationHandler - the handler to call with the ID of the expired packet

Returns:

current MQTT client instance

publishCompletionUnknownPacketIdHandler

public MqttClient publishCompletionUnknownPacketIdHandler(Handler<Integer> publishCompletionPhantomHandler)

Sets a handler which will be called when the client receives a PUBACK/PUBREC/PUBCOMP with an unknown packet ID.

Parameters:

publishCompletionPhantomHandler - the handler to call with the unknown packet ID

Returns:

current MQTT client instance

publishHandler

public MqttClient publishHandler(Handler<MqttPublishMessage> publishHandler)

Sets handler which will be called each time server publish something to client

Parameters:

publishHandler - handler to call

Returns:

current MQTT client instance

subscribeCompletionHandler

public MqttClient subscribeCompletionHandler(Handler<MqttSubAckMessage> subscribeCompletionHandler)

Sets handler which will be called after SUBACK packet receiving

Parameters:

subscribeCompletionHandler - handler to call. List inside is a granted QoS array

Returns:

current MQTT client instance

subscribe

public Single<Integer> subscribe(String topic,
                                 int qos)

Subscribes to the topic with a specified QoS level

Parameters:

topic - topic you subscribe on

qos - QoS level

Returns:

current MQTT client instance

rxSubscribe

public Single<Integer> rxSubscribe(String topic,
                                   int qos)

Subscribes to the topic with a specified QoS level

Parameters:

topic - topic you subscribe on

qos - QoS level

Returns:

current MQTT client instance

subscribe

public Single<Integer> subscribe(Map<String,Integer> topics)

Subscribes to the topic and adds a handler which will be called after the request is sent

Parameters:

topics - topics you subscribe on

Returns:

current MQTT client instance

rxSubscribe

public Single<Integer> rxSubscribe(Map<String,Integer> topics)

Subscribes to the topic and adds a handler which will be called after the request is sent

Parameters:

topics - topics you subscribe on

Returns:

current MQTT client instance

unsubscribeCompletionHandler

public MqttClient unsubscribeCompletionHandler(Handler<Integer> unsubscribeCompletionHandler)

Sets handler which will be called after UNSUBACK packet receiving

Parameters:

unsubscribeCompletionHandler - handler to call with the packetid

Returns:

current MQTT client instance

unsubscribe

public Single<Integer> unsubscribe(List<String> topics)

Unsubscribe from receiving messages on given topics

Parameters:

topics - list of topics you want to unsubscribe from

Returns:

current MQTT client instance

rxUnsubscribe

public Single<Integer> rxUnsubscribe(List<String> topics)

Unsubscribe from receiving messages on given topics

Parameters:

topics - list of topics you want to unsubscribe from

Returns:

current MQTT client instance

unsubscribe

public Single<Integer> unsubscribe(String topic)

Unsubscribe from receiving messages on given topic

Parameters:

topic - list of topics you want to unsubscribe from

Returns:

current MQTT client instance

rxUnsubscribe

public Single<Integer> rxUnsubscribe(String topic)

Unsubscribe from receiving messages on given topic

Parameters:

topic - list of topics you want to unsubscribe from

Returns:

current MQTT client instance

pingResponseHandler

public MqttClient pingResponseHandler(Handler<Void> pingResponseHandler)

Sets handler which will be called after PINGRESP packet receiving

Parameters:

pingResponseHandler - handler to call

Returns:

current MQTT client instance

exceptionHandler

public MqttClient exceptionHandler(Handler<Throwable> handler)

Set an exception handler for the client, that will be called when an error happens in internal netty structures. io.netty.handler.codec.DecoderException can be one of the cause

Parameters:

handler - the exception handler

Returns:

current MQTT client instance

closeHandler

public MqttClient closeHandler(Handler<Void> closeHandler)

Set a handler that will be called when the connection with server is closed

Parameters:

closeHandler - handler to call

Returns:

current MQTT client instance

ping

public MqttClient ping()

This method is needed by the client in order to avoid server closes the connection due to the keep alive timeout if client has no messages to send

Returns:

current MQTT client instance

clientId

public String clientId()

Returns:

the client identifier

isConnected

public boolean isConnected()

Returns:

if the connection between client and remote server is established/open

newInstance

public static MqttClient newInstance(MqttClient arg)