com.hivemq.spi.message

Class PUBLISH

java.lang.Object

com.hivemq.spi.message.MessageWithID

com.hivemq.spi.message.PUBLISH

All Implemented Interfaces:

Message, Serializable

Direct Known Subclasses:

REMOTE_PUBLISH

public class PUBLISH
extends MessageWithID

A MQTT PUBLISH message

Note that a PUBLISH message is considered equal if the topic Strings are equal

Since:

1.4

Author:

Dominik Obermaier

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected long	timestamp

Fields inherited from class com.hivemq.spi.message.MessageWithID

messageId

Constructor Summary

Constructors

Constructor and Description
PUBLISH()
PUBLISH(byte[] payload, String topic, QoS qoS)
PUBLISH(byte[] payload, String topic, QoS qoS, int ttl)

Method Summary

Methods

Modifier and Type	Method and Description
static PUBLISH	copy(PUBLISH original) Crates a deep copy of a PUBLISH object.
boolean	equals(Object o)
byte[]	getPayload()
QoS	getQoS()
long	getTimestamp()
String	getTopic()
int	getTTL()
int	hashCode()
boolean	isDuplicateDelivery()
boolean	isRetain()
void	setDuplicateDelivery(boolean duplicateDelivery)
void	setPayload(byte[] payload)
void	setQoS(QoS qoS)
void	setRetain(boolean retain)
void	setTopic(String topic)
void	setTTL(int ttl)

Methods inherited from class com.hivemq.spi.message.MessageWithID

getMessageId, setMessageId

Methods inherited from class java.lang.Object

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

Field Detail

timestamp

protected long timestamp

Constructor Detail

PUBLISH

public PUBLISH()

PUBLISH

public PUBLISH(byte[] payload,
       String topic,
       QoS qoS)

PUBLISH

public PUBLISH(byte[] payload,
       String topic,
       QoS qoS,
       int ttl)

Method Detail

getPayload

public byte[] getPayload()

Returns:

the payload of the PUBLISH message

setPayload

public void setPayload(byte[] payload)

getTopic

public String getTopic()

Returns:

the topic of the PUBLISH message

setTopic

public void setTopic(String topic)

isDuplicateDelivery

public boolean isDuplicateDelivery()

Returns:

true if the message is a duplicate message

setDuplicateDelivery

public void setDuplicateDelivery(boolean duplicateDelivery)

isRetain

public boolean isRetain()

Returns:

if the PUBLISH message should be retained

setRetain

public void setRetain(boolean retain)

getTTL

public int getTTL()

Returns:

the time-to-live of this PUBLISH message

setTTL

public void setTTL(int ttl)

getQoS

public QoS getQoS()

Returns:

the QoS level of the PUBLISH message

setQoS

public void setQoS(QoS qoS)

getTimestamp

public long getTimestamp()

Returns:

the timestamp of the PUBLISH message

copy

public static PUBLISH copy(PUBLISH original)

Crates a deep copy of a PUBLISH object.

Use this method if you want to reuse a publish received by a callback to prevent side effects.

Parameters:

original - the original PUBLISH message

Returns:

a deep copy of the original PUBLISH message

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object