blob: 531a62cdea81fc1c9d23599b20627ad30e2b2e38 [file] [log] [blame]
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>MqttMsgPubcomp Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="MqttMsgPubcomp class" /><meta name="System.Keywords" content="uPLibrary.Networking.M2Mqtt.Messages.MqttMsgPubcomp class" /><meta name="System.Keywords" content="MqttMsgPubcomp class, about MqttMsgPubcomp class" /><meta name="Microsoft.Help.F1" content="uPLibrary.Networking.M2Mqtt.Messages.MqttMsgPubcomp" /><meta name="Microsoft.Help.Id" content="T:uPLibrary.Networking.M2Mqtt.Messages.MqttMsgPubcomp" /><meta name="Description" content="Class for PUBCOMP message from broker to client" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="uPLibrary.Networking.M2Mqtt.Messages" /><meta name="file" content="eeaa2484-186e-dd2a-6741-b5ddc890026a" /><meta name="guid" content="eeaa2484-186e-dd2a-6741-b5ddc890026a" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">A Sandcastle Documented Class Library<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="4158a883-de72-1ec4-2209-632a86aebd74.htm" title="A Sandcastle Documented Class Library" tocid="roottoc">A Sandcastle Documented Class Library</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="311542f9-0333-9080-9217-f386962efb4a.htm" title="uPLibrary.Networking.M2Mqtt.Messages" tocid="311542f9-0333-9080-9217-f386962efb4a">uPLibrary.Networking.M2Mqtt.Messages</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="eeaa2484-186e-dd2a-6741-b5ddc890026a.htm" title="MqttMsgPubcomp Class" tocid="eeaa2484-186e-dd2a-6741-b5ddc890026a">MqttMsgPubcomp Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="259c31dc-f972-ad55-d5c7-ce4ed1e95705.htm" title="MqttMsgPubcomp Constructor " tocid="259c31dc-f972-ad55-d5c7-ce4ed1e95705">MqttMsgPubcomp Constructor </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="88297028-e7a2-b032-b072-08d2b846f773.htm" title="MqttMsgPubcomp Properties" tocid="88297028-e7a2-b032-b072-08d2b846f773">MqttMsgPubcomp Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="2d6d00e1-0ef2-a33e-7cc7-f881c29fda3e.htm" title="MqttMsgPubcomp Methods" tocid="2d6d00e1-0ef2-a33e-7cc7-f881c29fda3e">MqttMsgPubcomp Methods</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="9f188b8f-22e4-c6c8-22e9-c0bf2c853c09.htm" title="MqttMsgPubcomp Fields" tocid="9f188b8f-22e4-c6c8-22e9-c0bf2c853c09">MqttMsgPubcomp Fields</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn">MqttMsgPubcomp Class</td></tr></table><span class="introStyle"></span><div class="summary">
Class for PUBCOMP message from broker to client
</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Inheritance Hierarchy</span></div><div id="ID0RBSection" class="collapsibleSection"><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST4C4F222_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C4F222_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">uPLibrary.Networking.M2Mqtt.Messages<span id="LST4C4F222_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C4F222_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>MqttMsgBase</a><br />    <span class="selflink">uPLibrary.Networking.M2Mqtt.Messages<span id="LST4C4F222_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C4F222_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>MqttMsgPubcomp</span><br /></div><p> </p><strong>Namespace:</strong> <a href="311542f9-0333-9080-9217-f386962efb4a.htm">uPLibrary.Networking.M2Mqtt.Messages</a><br /><strong>Assembly:</strong> M2Mqtt.Net (in M2Mqtt.Net.dll) Version: 4.3.0.0 (4.3.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">MqttMsgPubcomp</span> : <span class="identifier">MqttMsgBase</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">MqttMsgPubcomp</span>
<span class="keyword">Inherits</span> <span class="identifier">MqttMsgBase</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">MqttMsgPubcomp</span> : <span class="keyword">public</span> <span class="identifier">MqttMsgBase</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">MqttMsgPubcomp</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">MqttMsgBase</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">MqttMsgPubcomp</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="259c31dc-f972-ad55-d5c7-ce4ed1e95705.htm">MqttMsgPubcomp</a></td><td><div class="summary">
Constructor
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID4RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="97cb7fb4-5976-3246-a3cc-9e5cd08251e7.htm">DupFlag</a></td><td><div class="summary">
Duplicate message flag
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="fda6ce26-ac1b-1d79-81fd-37fbf85817ff.htm">MessageId</a></td><td><div class="summary">
Message identifier for the message
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="2c37703a-5282-15c4-0b8f-0b0725d4d809.htm">QosLevel</a></td><td><div class="summary">
Quality of Service level
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="f455209c-c79d-b94f-fc5b-8345c5d4b2ce.htm">Retain</a></td><td><div class="summary">
Retain message flag
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="e2c11765-f737-d909-1c4f-1b4f2728fc69.htm">Type</a></td><td><div class="summary">
Message type
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID5RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="b908aa25-988c-45df-47b3-ffb5cafbe538.htm">encodeRemainingLength</a></td><td><div class="summary">
Encode remaining length and insert it into message buffer
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">Determines whether the specified object is equal to the current object.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="4af22e68-553d-ab89-6d34-c2d15cb2738f.htm">GetBytes</a></td><td> (Overrides <a href="f0fafcf1-e39b-e48e-d718-9ce6bbc3e18a.htm">MqttMsgBase<span id="LST4C4F222_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C4F222_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>GetBytes(Byte)</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">Serves as the default hash function. </div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="317d3669-35cd-c421-71db-8bfc050b144f.htm">GetTraceString</a></td><td><div class="summary">
Returns a string representation of the message for tracing
</div> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;static;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="8bca2992-131c-5c22-69ec-c6c2d3dd1982.htm">Parse</a></td><td><div class="summary">
Parse bytes for a PUBCOMP message
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="d4bfc6a9-78f5-e17a-29a9-339c8fcd2e2e.htm">ToString</a></td><td> (Overrides <a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">Object<span id="LST4C4F222_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C4F222_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ToString<span id="LST4C4F222_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST4C4F222_5?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID6RBSection" class="collapsibleSection"><table id="memberList" class="members"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="c985e235-7e86-3dcd-bd3c-bf609bbec9c7.htm">dupFlag</a></td><td> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="68e5aa71-7f7f-2330-bd90-c6746d9a6040.htm">messageId</a></td><td> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="aaf0c153-7c6b-faf8-e8c9-4a1597bc7aec.htm">qosLevel</a></td><td> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="e8d4e350-0bc9-257a-931a-e25fc0044ef1.htm">retain</a></td><td> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protfield.gif" alt="Protected field" title="Protected field" /></td><td><a href="d3232a4b-eef0-7549-f66e-c0775583db92.htm">type</a></td><td> (Inherited from <a href="c682cddc-7005-0317-ca4e-dbb5d5c257bc.htm">MqttMsgBase</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID7RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="311542f9-0333-9080-9217-f386962efb4a.htm">uPLibrary.Networking.M2Mqtt.Messages Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>