blob: f80f894ef974e58985d57bdd4fb17174a95a49ad [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>MqttNetworkChannel Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="MqttNetworkChannel class" /><meta name="System.Keywords" content="uPLibrary.Networking.M2Mqtt.MqttNetworkChannel class" /><meta name="System.Keywords" content="MqttNetworkChannel class, about MqttNetworkChannel class" /><meta name="Microsoft.Help.F1" content="uPLibrary.Networking.M2Mqtt.MqttNetworkChannel" /><meta name="Microsoft.Help.Id" content="T:uPLibrary.Networking.M2Mqtt.MqttNetworkChannel" /><meta name="Description" content="Channel to communicate over the network" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="uPLibrary.Networking.M2Mqtt" /><meta name="file" content="c4fa5a27-49d4-bc90-3bbb-54db099da314" /><meta name="guid" content="c4fa5a27-49d4-bc90-3bbb-54db099da314" /><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="c4fa5a27-49d4-bc90-3bbb-54db099da314.htm" title="MqttNetworkChannel Class" tocid="c4fa5a27-49d4-bc90-3bbb-54db099da314">MqttNetworkChannel Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="f1e4982e-9370-e147-feed-dcaa495d134b.htm" title="MqttNetworkChannel Constructor " tocid="f1e4982e-9370-e147-feed-dcaa495d134b">MqttNetworkChannel Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="80c3df7f-4a49-ab60-d773-561db3ac1c26.htm" title="MqttNetworkChannel Properties" tocid="80c3df7f-4a49-ab60-d773-561db3ac1c26">MqttNetworkChannel Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="d5cb1b12-2063-94ad-bcc0-02848401652f.htm" title="MqttNetworkChannel Methods" tocid="d5cb1b12-2063-94ad-bcc0-02848401652f">MqttNetworkChannel 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">MqttNetworkChannel Class</td></tr></table><span class="introStyle"></span><div class="summary">
Channel to communicate over the network
</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="LST67CEC83C_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST67CEC83C_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <span class="selflink">uPLibrary.Networking.M2Mqtt<span id="LST67CEC83C_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST67CEC83C_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>MqttNetworkChannel</span><br /></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('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">MqttNetworkChannel</span> : <span class="identifier">IMqttNetworkChannel</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">MqttNetworkChannel</span>
<span class="keyword">Implements</span> <span class="identifier">IMqttNetworkChannel</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">MqttNetworkChannel</span> : <span class="identifier">IMqttNetworkChannel</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">MqttNetworkChannel</span> =
<span class="keyword">class</span>
<span class="keyword">interface</span> <span class="identifier">IMqttNetworkChannel</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">MqttNetworkChannel</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="c14eec5a-1dd8-29aa-3efb-1c34068a984e.htm">MqttNetworkChannel(Socket)</a></td><td><div class="summary">
Constructor
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="508edb77-8bbf-b42e-a2fd-a86beb44b6b2.htm">MqttNetworkChannel(String, Int32)</a></td><td><div class="summary">
Constructor
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="aef7b415-04b4-a0ff-b496-64256e388d43.htm">MqttNetworkChannel(Socket, Boolean, X509Certificate, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">MqttNetworkChannel</span> class</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="5fc4907e-616a-5cc7-5989-1d0ac38477a0.htm">MqttNetworkChannel(String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">MqttNetworkChannel</span> class</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;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="e14c06db-c78e-0b6f-56a9-7c77e013ab40.htm">DataAvailable</a></td><td><div class="summary">
Data available on the channel
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="a1a7d497-1e16-aa41-684b-9b5f6a3f2e0b.htm">RemoteHostName</a></td><td><div class="summary">
Remote host name
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="322177e0-a0ab-c315-1359-368b5db3fd98.htm">RemoteIpAddress</a></td><td><div class="summary">
Remote IP address
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="0c0ea521-97ef-e5f4-1c34-5862c8840043.htm">RemotePort</a></td><td><div class="summary">
Remote port
</div></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="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="e33a1b59-ecdf-7273-9f5c-4c9525ed83e6.htm">Accept</a></td><td><div class="summary">
Accept connection from a remote client
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="963aa59b-b905-2777-d79c-2fb83c7a6093.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="0a44ce25-d4a4-8e88-a42e-932710570f73.htm">Connect</a></td><td><div class="summary">
Connect to remote server
</div></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;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="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;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="a2552868-ba51-1d35-43ce-9ea405d3c1c2.htm">Receive(<span id="LST67CEC83C_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST67CEC83C_2?cpp=array&lt;");</script>Byte<span id="LST67CEC83C_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST67CEC83C_3?cpp=&gt;|cs=[]|vb=()|nu=[]|fs=[]");</script>)</a></td><td><div class="summary">
Receive data from the network
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="a1c37ac5-4a47-142b-8df8-61f93a04c96d.htm">Receive(<span id="LST67CEC83C_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST67CEC83C_4?cpp=array&lt;");</script>Byte<span id="LST67CEC83C_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST67CEC83C_5?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="a1f46e19-44d6-08b3-5c58-045aa613b429.htm">Send</a></td><td><div class="summary">
Send data on the network channel
</div></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/7bxwbwt2" target="_blank">ToString</a></td><td><div class="summary">Returns a string that represents the current object.</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID6RBSection" 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>