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

Class CMMqttEventSUBSCRIBE

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.CMMqttEventSUBSCRIBE

public class CMMqttEventSUBSCRIBE
extends CMMqttEventFixedHeader

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

See Also:

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

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
CMMqttEventSUBSCRIBE()	Creates an instance of the CMMqttEventSUBSCRIBE class.
CMMqttEventSUBSCRIBE(ByteBuffer msg)

Method Summary

Modifier and Type	Method	Description
boolean	addTopicQoS(String strTopic, byte qos)	Adds the Topic Filter / QoS pair to the list.
int	getPacketID()	gets MQTT Packet ID.
protected int	getPayloadByteNum()
CMList<CMMqttTopicQoS>	getTopicQoSList()	Returns the list of Topic Filter / QoS pairs.
protected int	getVarHeaderByteNum()
protected void	marshallPayload()
protected void	marshallVarHeader()
void	removeAllTopicQoS()	Removes all Topic Filter / QoS pairs from the list.
boolean	removeTopicQoS(String strTopic)	Removes the Topic Filter / QoS pair from the list.
void	setPacketID(int nID)	sets MQTT Packet ID.
void	setTopicQoSList(CMList<CMMqttTopicQoS> topicQoSList)	Sets the list of Topic Filter / QoS pairs.
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

CMMqttEventSUBSCRIBE

public CMMqttEventSUBSCRIBE()

Creates an instance of the CMMqttEventSUBSCRIBE class.

CMMqttEventSUBSCRIBE

public CMMqttEventSUBSCRIBE(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

setTopicQoSList

public void setTopicQoSList(CMList<CMMqttTopicQoS> topicQoSList)

Sets the list of Topic Filter / QoS pairs.

Parameters:

topicQoSList - - the list of Topic Filter / QoS pairs.

getTopicQoSList

public CMList<CMMqttTopicQoS> getTopicQoSList()

Returns the list of Topic Filter / QoS pairs.

Returns:

the list of Topic Filter / QoS pairs.

addTopicQoS

public boolean addTopicQoS(String strTopic,
 byte qos)

Adds the Topic Filter / QoS pair to the list.

Parameters:

strTopic - - the Topic Filter

qos - - the QoS

Returns:

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

removeTopicQoS

public boolean removeTopicQoS(String strTopic)

Removes the Topic Filter / QoS pair from the list.

Parameters:

strTopic - - the Topic Filter

Returns:

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

removeAllTopicQoS

public void removeAllTopicQoS()

Removes all Topic Filter / QoS pairs 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.