io.netty.handler.codec.mqtt

Class MqttPublishMessage

java.lang.Object

io.netty.handler.codec.mqtt.MqttMessage

io.netty.handler.codec.mqtt.MqttPublishMessage

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

public class MqttPublishMessage
extends MqttMessage
implements ByteBufHolder

See MQTTV3.1/publish

Field Summary

Fields inherited from class io.netty.handler.codec.mqtt.MqttMessage

DISCONNECT, PINGREQ, PINGRESP

Constructor Summary

Constructors

Constructor and Description
MqttPublishMessage(MqttFixedHeader mqttFixedHeader, MqttPublishVariableHeader variableHeader, ByteBuf payload)

Method Summary

Modifier and Type	Method and Description
ByteBuf	content() Return the data which is held by this ByteBufHolder.
MqttPublishMessage	copy() Creates a deep copy of this ByteBufHolder.
MqttPublishMessage	duplicate() Duplicates this ByteBufHolder.
ByteBuf	payload()
int	refCnt() Returns the reference count of this object.
boolean	release() Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement) Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
MqttPublishMessage	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
MqttPublishMessage	retain() Increases the reference count by 1.
MqttPublishMessage	retain(int increment) Increases the reference count by the specified increment.
MqttPublishMessage	retainedDuplicate() Duplicates this ByteBufHolder.
MqttPublishMessage	touch() Records the current access location of this object for debugging purposes.
MqttPublishMessage	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.
MqttPublishVariableHeader	variableHeader()

Methods inherited from class io.netty.handler.codec.mqtt.MqttMessage

decoderResult, fixedHeader, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttPublishMessage

public MqttPublishMessage(MqttFixedHeader mqttFixedHeader,
                          MqttPublishVariableHeader variableHeader,
                          ByteBuf payload)

Method Detail

variableHeader

public MqttPublishVariableHeader variableHeader()

Overrides:

variableHeader in class MqttMessage

payload

public ByteBuf payload()

Overrides:

payload in class MqttMessage

content

public ByteBuf content()

Description copied from interface: ByteBufHolder

Return the data which is held by this ByteBufHolder.

Specified by:

content in interface ByteBufHolder

copy

public MqttPublishMessage copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

duplicate

public MqttPublishMessage duplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

Specified by:

duplicate in interface ByteBufHolder

retainedDuplicate

public MqttPublishMessage retainedDuplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

Specified by:

retainedDuplicate in interface ByteBufHolder

See Also:

ByteBuf.retainedDuplicate()

replace

public MqttPublishMessage replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface ByteBufHolder

refCnt

public int refCnt()

Description copied from interface: ReferenceCounted

Returns the reference count of this object. If 0, it means this object has been deallocated.

Specified by:

refCnt in interface ReferenceCounted

retain

public MqttPublishMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

retain

public MqttPublishMessage retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

touch

public MqttPublishMessage touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

touch

public MqttPublishMessage touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated