io.smallrye.reactive.messaging.mqtt

Class ReceivingMqttMessage

java.lang.Object

io.smallrye.reactive.messaging.mqtt.ReceivingMqttMessage

All Implemented Interfaces:

MqttMessage<byte[]>, Message<byte[]>

public class ReceivingMqttMessage
extends Object
implements MqttMessage<byte[]>

Field Summary

Fields inherited from interface org.eclipse.microprofile.reactive.messaging.Message

LOGGER

Method Summary

Modifier and Type	Method and Description
int	getMessageId()
Function<Throwable,CompletionStage<Void>>	getNack()
byte[]	getPayload()
io.netty.handler.codec.mqtt.MqttQoS	getQosLevel()
String	getTopic()
boolean	isDuplicate()
boolean	isRetain()
CompletionStage<Void>	nack(Throwable reason, Metadata metadata) Acknowledge negatively this message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.smallrye.reactive.messaging.mqtt.MqttMessage

of, of, of, of, of, withAck

Methods inherited from interface org.eclipse.microprofile.reactive.messaging.Message

ack, addMetadata, getAck, getMetadata, getMetadata, nack, of, of, of, unwrap, withMetadata, withMetadata, withNack, withPayload

Method Detail

getPayload

public byte[] getPayload()

Specified by:

getPayload in interface Message<byte[]>

Returns:

The payload for this message.

getMessageId

public int getMessageId()

Specified by:

getMessageId in interface MqttMessage<byte[]>

getQosLevel

public io.netty.handler.codec.mqtt.MqttQoS getQosLevel()

Specified by:

getQosLevel in interface MqttMessage<byte[]>

isDuplicate

public boolean isDuplicate()

Specified by:

isDuplicate in interface MqttMessage<byte[]>

isRetain

public boolean isRetain()

Specified by:

isRetain in interface MqttMessage<byte[]>

getTopic

public String getTopic()

Specified by:

getTopic in interface MqttMessage<byte[]>

nack

public CompletionStage<Void> nack(Throwable reason,
                                  Metadata metadata)

Description copied from interface: Message

Acknowledge negatively this message. nack is used to indicate that the processing of a message failed. The reason is passed as parameter. Additional metadata may be provided that the connector can use when nacking the message. The interpretation of metadata is connector-specific.

Specified by:

nack in interface Message<byte[]>

Parameters:

reason - the reason of the nack, must not be null

metadata - additional nack metadata the connector may use, may be null

Returns:

a completion stage completed when the message is negative-acknowledgement has completed. If the negative acknowledgement fails, the completion stage propagates the failure.

getNack

public Function<Throwable,CompletionStage<Void>> getNack()

Specified by:

getNack in interface Message<byte[]>

Returns:

the function used to retrieve the negative-acknowledgement asynchronous function.