blob: 7975dd1455a87b36162d59a104ed62dcb45bc057 [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>IMqttNetworkChannel Interface</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="IMqttNetworkChannel interface" /><meta name="System.Keywords" content="uPLibrary.Networking.M2Mqtt.IMqttNetworkChannel interface" /><meta name="System.Keywords" content="IMqttNetworkChannel interface, about IMqttNetworkChannel interface" /><meta name="Microsoft.Help.F1" content="uPLibrary.Networking.M2Mqtt.IMqttNetworkChannel" /><meta name="Microsoft.Help.Id" content="T:uPLibrary.Networking.M2Mqtt.IMqttNetworkChannel" /><meta name="Description" content="Interface for channel under MQTT library" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="uPLibrary.Networking.M2Mqtt" /><meta name="file" content="e4f6a471-40f3-038f-daf6-8b7fde3956c8" /><meta name="guid" content="e4f6a471-40f3-038f-daf6-8b7fde3956c8" /><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="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="e4f6a471-40f3-038f-daf6-8b7fde3956c8.htm" title="IMqttNetworkChannel Interface" tocid="e4f6a471-40f3-038f-daf6-8b7fde3956c8">IMqttNetworkChannel Interface</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="c182456b-a547-08ef-dcd2-bf02c5c0c796.htm" title="IMqttNetworkChannel Properties" tocid="c182456b-a547-08ef-dcd2-bf02c5c0c796">IMqttNetworkChannel Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="94c9a646-e581-86ca-4778-544848e845eb.htm" title="IMqttNetworkChannel Methods" tocid="94c9a646-e581-86ca-4778-544848e845eb">IMqttNetworkChannel Methods</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">IMqttNetworkChannel Interface</td></tr></table><span class="introStyle"></span><div class="summary">
Interface for channel under MQTT library
</div><p> </p><strong>Namespace:</strong> <a href="4158a883-de72-1ec4-2209-632a86aebd74.htm">uPLibrary.Networking.M2Mqtt</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('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID1RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID0EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">interface</span> <span class="identifier">IMqttNetworkChannel</span></pre></div><div id="ID0EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Interface</span> <span class="identifier">IMqttNetworkChannel</span></pre></div><div id="ID0EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">interface class</span> <span class="identifier">IMqttNetworkChannel</span></pre></div><div id="ID0EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">IMqttNetworkChannel</span> = <span class="keyword">interface</span> <span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script></div><p>The <span class="selflink">IMqttNetworkChannel</span> type exposes the following members.</p><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" />Properties</span></div><div id="ID2RBSection" 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="7fe30b5a-64cf-fee6-b4e6-b1b44b11216d.htm">DataAvailable</a></td><td><div class="summary">
Data available on channel
</div></td></tr></table><a href="#PageHeader">Top</a></div><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" />Methods</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="b55bfe85-c247-48d0-e704-29f6f90f6f07.htm">Accept</a></td><td><div class="summary">
Accept client connection
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="2e2bf1a6-6e35-acbf-602a-02de9e4a886f.htm">Close</a></td><td><div class="summary">
Close the network channel
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="84ccb351-0f50-24ca-4de5-a7c778cabd05.htm">Connect</a></td><td><div class="summary">
Connect to remote server
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="809aa8cd-5e32-5aaa-63ff-f1ddbd392a7e.htm">Receive(<span id="LSTEF7C1B8F_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEF7C1B8F_0?cpp=array&lt;");</script>Byte<span id="LSTEF7C1B8F_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEF7C1B8F_1?cpp=&gt;|cs=[]|vb=()|nu=[]|fs=[]");</script>)</a></td><td><div class="summary">
Receive data from the network channel
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="f6ac6041-8c03-7f1f-008e-082f3f091b45.htm">Receive(<span id="LSTEF7C1B8F_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEF7C1B8F_2?cpp=array&lt;");</script>Byte<span id="LSTEF7C1B8F_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEF7C1B8F_3?cpp=&gt;|cs=[]|vb=()|nu=[]|fs=[]");</script>, Int32)</a></td><td><div class="summary">
Receive data from the network channel with a specified timeout
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="5e035246-906a-e93f-453c-1a083eb1e1d6.htm">Send</a></td><td><div class="summary">
Send data on the network channel to the broker
</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID4RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><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>