Package kr.ac.konkuk.ccslab.cm.event.mqttevent

Class CMMqttEventUNSUBSCRIBE

java.lang.Object

kr.ac.konkuk.ccslab.cm.entity.CMObject

kr.ac.konkuk.ccslab.cm.event.CMEvent

kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEvent

kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEventFixedHeader

kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEventUNSUBSCRIBE

public class CMMqttEventUNSUBSCRIBE
extends CMMqttEventFixedHeader

This class represents a CM event that is the variable header and payload of MQTT UNSUBSCRIBE packet.

See Also:

• http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718072

Field Summary

Fields inherited from class kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEventFixedHeader

m_flag, m_nRemainingLength, m_packetType

Fields inherited from class kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEvent

CONNACK, CONNECT, DISCONNECT, PINGREQ, PINGRESP, PUBACK, PUBCOMP, PUBLISH, PUBREC, PUBREL, SUBACK, SUBSCRIBE, UNSUBACK, UNSUBSCRIBE

Fields inherited from class kr.ac.konkuk.ccslab.cm.event.CMEvent

m_bytes, m_nByteNum, m_nID, m_strDistributionGroup, m_strDistributionSession, m_strHandlerGroup, m_strHandlerSession, m_strReceiver, m_strSender

Fields inherited from class kr.ac.konkuk.ccslab.cm.entity.CMObject

m_nType

Constructor Summary

Constructors

Constructor	Description
CMMqttEventUNSUBSCRIBE()	Creates an instance of the CMMqttEventUNSUBSCRIBE class.
CMMqttEventUNSUBSCRIBE(ByteBuffer msg)

Method Summary

Modifier and Type	Method	Description
boolean	addTopic(String strTopic)	Adds the Topic Filter to the list.
int	getPacketID()	gets MQTT Packet ID.
protected int	getPayloadByteNum()
CMList<String>	getTopicList()	Returns the list of Topic Filters.
protected int	getVarHeaderByteNum()
protected void	marshallPayload()
protected void	marshallVarHeader()
void	removeAllTopic()	Removes all Topic Filters from the list.
boolean	removeTopic(String strTopic)	Removes the Topic Filter from the list.
void	setPacketID(int nID)	sets MQTT Packet ID.
void	setTopicList(CMList<String> topicList)	Sets the list of Topic Filters.
String	toString()	Returns the string representation of the CMMqttEventFixedHeader.
protected void	unmarshallPayload(ByteBuffer buf)
protected void	unmarshallVarHeader(ByteBuffer buf)

Methods inherited from class kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEventFixedHeader

getBinaryString, getBinaryStringOfByte, getFixedHeaderByteNum, getFlag, getPacketType, getRemainingLength, marshallFixedHeader, setFixedHeader, setFlag, setPacketType, setRemainingLength, unmarshallFixedHeader

Methods inherited from class kr.ac.konkuk.ccslab.cm.event.mqttevent.CMMqttEvent

getByteNum, marshallBody, unmarshallBody

Methods inherited from class kr.ac.konkuk.ccslab.cm.event.CMEvent

allocate, equals, getDistributionGroup, getDistributionSession, getHandlerGroup, getHandlerSession, getID, getInt2BytesFromByteBuffer, getReceiver, getSender, getStringFromByteBuffer, marshall, marshallHeader, putInt2BytesToByteBuffer, putStringToByteBuffer, setByteNum, setDistributionGroup, setDistributionSession, setHandlerGroup, setHandlerSession, setID, setReceiver, setSender, unmarshall, unmarshallHeader

Methods inherited from class kr.ac.konkuk.ccslab.cm.entity.CMObject

getType, setType

Methods inherited from class java.lang.Object

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

Constructor Details

CMMqttEventUNSUBSCRIBE

public CMMqttEventUNSUBSCRIBE()

Creates an instance of the CMMqttEventUNSUBSCRIBE class.

CMMqttEventUNSUBSCRIBE

public CMMqttEventUNSUBSCRIBE(ByteBuffer msg)

Method Details

setPacketID

public void setPacketID(int nID)

sets MQTT Packet ID.

Parameters:

nID - - Packet ID.

getPacketID

public int getPacketID()

gets MQTT Packet ID.

Overrides:

getPacketID in class CMMqttEvent

Returns:

Packet ID.

getVarHeaderByteNum

protected int getVarHeaderByteNum()

Specified by:

getVarHeaderByteNum in class CMMqttEvent

marshallVarHeader

protected void marshallVarHeader()

Specified by:

marshallVarHeader in class CMMqttEvent

unmarshallVarHeader

protected void unmarshallVarHeader(ByteBuffer buf)

Specified by:

unmarshallVarHeader in class CMMqttEvent

setTopicList

public void setTopicList(CMList<String> topicList)

Sets the list of Topic Filters.

Parameters:

topicList - - the list of Topic Filters

getTopicList

public CMList<String> getTopicList()

Returns the list of Topic Filters.

Returns:

the list of Topic Filters.

addTopic

public boolean addTopic(String strTopic)

Adds the Topic Filter to the list.

Parameters:

strTopic - - the Topic Filter

Returns:

true if the Topic Filter is successfully added; false otherwise.

removeTopic

public boolean removeTopic(String strTopic)

Removes the Topic Filter from the list.

Parameters:

strTopic - - the Topic Filter

Returns:

true if the Topic Filter is successfully removed; false otherwise.

removeAllTopic

public void removeAllTopic()

Removes all Topic Filters from the list.

getPayloadByteNum

protected int getPayloadByteNum()

Specified by:

getPayloadByteNum in class CMMqttEvent

marshallPayload

protected void marshallPayload()

Specified by:

marshallPayload in class CMMqttEvent

unmarshallPayload

protected void unmarshallPayload(ByteBuffer buf)

Specified by:

unmarshallPayload in class CMMqttEvent

toString

public String toString()

Description copied from class: CMMqttEventFixedHeader

Returns the string representation of the CMMqttEventFixedHeader.

Overrides:

toString in class CMMqttEventFixedHeader

Returns:

string of this object.