io.micronaut.mqtt.v3.bind

Class MqttV3BindingContext

java.lang.Object

io.micronaut.mqtt.v3.bind.MqttV3BindingContext

All Implemented Interfaces:

MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

@Internal
public final class MqttV3BindingContext
extends java.lang.Object
implements MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

A binding context for MQTT v3 messages.

Since:

1.0.0

Author:

James Kleeh

Constructor Summary

Constructors

Constructor and Description
MqttV3BindingContext(org.eclipse.paho.client.mqttv3.MqttAsyncClient client, org.eclipse.paho.client.mqttv3.MqttMessage message)

Method Summary

Modifier and Type	Method and Description
void	acknowlege() Acknowledges a message.
int	getId()
org.eclipse.paho.client.mqttv3.MqttMessage	getNativeMessage()
byte[]	getPayload()
int	getQos()
java.lang.String	getTopic()
boolean	isRetained()
void	setPayload(byte[] payload) Sets the message payload.
void	setQos(int qos) Sets the message qos.
void	setRetained(boolean retained) Sets the message to be retained.
void	setTopic(java.lang.String topic) Sets the message topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttV3BindingContext

public MqttV3BindingContext(org.eclipse.paho.client.mqttv3.MqttAsyncClient client,
                            org.eclipse.paho.client.mqttv3.MqttMessage message)

Parameters:

client - The client

message - The message

Method Detail

getPayload

public byte[] getPayload()

Specified by:

getPayload in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

The message payload

setPayload

public void setPayload(byte[] payload)

Description copied from interface: MqttBindingContext

Sets the message payload.

Specified by:

setPayload in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Parameters:

payload - The payload

isRetained

public boolean isRetained()

Specified by:

isRetained in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

True if the message is retained

setRetained

public void setRetained(boolean retained)

Description copied from interface: MqttBindingContext

Sets the message to be retained.

Specified by:

setRetained in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Parameters:

retained - The retained flag

getQos

public int getQos()

Specified by:

getQos in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

The message QOS

setQos

public void setQos(int qos)

Description copied from interface: MqttBindingContext

Sets the message qos. Must be 0, 1, or 2.

Specified by:

setQos in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Parameters:

qos - The qos

getTopic

public java.lang.String getTopic()

Specified by:

getTopic in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

The message topic

setTopic

public void setTopic(java.lang.String topic)

Description copied from interface: MqttBindingContext

Sets the message topic.

Specified by:

setTopic in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Parameters:

topic - The topic

getId

public int getId()

Specified by:

getId in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

The message ID

acknowlege

public void acknowlege()

Description copied from interface: MqttBindingContext

Acknowledges a message.

Specified by:

acknowlege in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

getNativeMessage

public org.eclipse.paho.client.mqttv3.MqttMessage getNativeMessage()

Specified by:

getNativeMessage in interface MqttBindingContext<org.eclipse.paho.client.mqttv3.MqttMessage>

Returns:

The underlying message instance