blob: f5e732fa2d4f0434859a225c6af35992d927329c [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>MqttClient Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="MqttClient class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:uPLibrary.Networking.M2Mqtt.MqttClient" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="uPLibrary.Networking.M2Mqtt" /><meta name="file" content="cb16a48f-8c20-616e-a5ae-e418baa99315" /><meta name="guid" content="cb16a48f-8c20-616e-a5ae-e418baa99315" /><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="4158a883-de72-1ec4-2209-632a86aebd74.htm" title="uPLibrary.Networking.M2Mqtt" tocid="4158a883-de72-1ec4-2209-632a86aebd74">uPLibrary.Networking.M2Mqtt</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="1c43333f-2896-2b9e-5895-dc5157db58a3.htm" title="MqttClient Class" tocid="1c43333f-2896-2b9e-5895-dc5157db58a3">MqttClient Class</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="cb16a48f-8c20-616e-a5ae-e418baa99315.htm" title="MqttClient Properties" tocid="cb16a48f-8c20-616e-a5ae-e418baa99315">MqttClient Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="4b68bb86-8a13-6f03-849d-4acf7f447332.htm" title="CleanSession Property " tocid="4b68bb86-8a13-6f03-849d-4acf7f447332">CleanSession Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="866121a7-d73c-7311-0324-e191af316de9.htm" title="ClientId Property " tocid="866121a7-d73c-7311-0324-e191af316de9">ClientId Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="36164747-27d6-bb3c-0074-33063e8d00ad.htm" title="IsConnected Property " tocid="36164747-27d6-bb3c-0074-33063e8d00ad">IsConnected Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="2222e8d5-c602-9e52-4f6e-f46edc066022.htm" title="ProtocolVersion Property " tocid="2222e8d5-c602-9e52-4f6e-f46edc066022">ProtocolVersion Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="a1a0e000-245b-e4f3-446d-c7c0e8880eb0.htm" title="Settings Property " tocid="a1a0e000-245b-e4f3-446d-c7c0e8880eb0">Settings Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="e4e7e8a1-2bbc-da42-f989-26ba8e319bb2.htm" title="WillFlag Property " tocid="e4e7e8a1-2bbc-da42-f989-26ba8e319bb2">WillFlag Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="ff4879de-905e-4827-1d29-b376914aaa70.htm" title="WillMessage Property " tocid="ff4879de-905e-4827-1d29-b376914aaa70">WillMessage Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="59e39ac0-ab6a-aadb-60cd-6ef3daeacf68.htm" title="WillQosLevel Property " tocid="59e39ac0-ab6a-aadb-60cd-6ef3daeacf68">WillQosLevel Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="64ed3ccd-7c69-947b-f5e9-3197551926a9.htm" title="WillTopic Property " tocid="64ed3ccd-7c69-947b-f5e9-3197551926a9">WillTopic Property </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">MqttClient Properties</td></tr></table><span class="introStyle"></span><p>The <a href="1c43333f-2896-2b9e-5895-dc5157db58a3.htm">MqttClient</a> type exposes the following members.</p><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" />Properties</span></div><div id="ID0RBSection" 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/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="4b68bb86-8a13-6f03-849d-4acf7f447332.htm">CleanSession</a></td><td><div class="summary">
Clean session flag
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="866121a7-d73c-7311-0324-e191af316de9.htm">ClientId</a></td><td><div class="summary">
Client identifier
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="36164747-27d6-bb3c-0074-33063e8d00ad.htm">IsConnected</a></td><td><div class="summary">
Connection status between client and broker
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="2222e8d5-c602-9e52-4f6e-f46edc066022.htm">ProtocolVersion</a></td><td><div class="summary">
MQTT protocol version
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="a1a0e000-245b-e4f3-446d-c7c0e8880eb0.htm">Settings</a></td><td><div class="summary">
MQTT client settings
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="e4e7e8a1-2bbc-da42-f989-26ba8e319bb2.htm">WillFlag</a></td><td><div class="summary">
Will flag
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="ff4879de-905e-4827-1d29-b376914aaa70.htm">WillMessage</a></td><td><div class="summary">
Will message
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="59e39ac0-ab6a-aadb-60cd-6ef3daeacf68.htm">WillQosLevel</a></td><td><div class="summary">
Will QOS level
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="64ed3ccd-7c69-947b-f5e9-3197551926a9.htm">WillTopic</a></td><td><div class="summary">
Will topic
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="1c43333f-2896-2b9e-5895-dc5157db58a3.htm">MqttClient Class</a></div><div class="seeAlsoStyle"><a href="4158a883-de72-1ec4-2209-632a86aebd74.htm">uPLibrary.Networking.M2Mqtt Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>