blob: f8e8c946eb4c29adb295726bdc19a6dbcacaf799 [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 Constructor (String, Int32, Boolean, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)</title><meta name="Language" content="en-us" /><meta name="Microsoft.Help.Id" content="M:uPLibrary.Networking.M2Mqtt.MqttClient.#ctor(System.String,System.Int32,System.Boolean,uPLibrary.Networking.M2Mqtt.MqttSslProtocols,System.Net.Security.RemoteCertificateValidationCallback,System.Net.Security.LocalCertificateSelectionCallback)" /><meta name="Description" content="Constructor" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="uPLibrary.Networking.M2Mqtt" /><meta name="file" content="edd74122-b9d2-deaf-4905-06af5e03364c" /><meta name="guid" content="edd74122-b9d2-deaf-4905-06af5e03364c" /><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" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="956ab130-7366-1a07-e5e3-b2959971d0c0.htm" title="MqttClient Constructor " tocid="956ab130-7366-1a07-e5e3-b2959971d0c0">MqttClient Constructor </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="75e1376d-4644-352d-20bc-c7535d1a92db.htm" title="MqttClient Constructor (IPAddress)" tocid="75e1376d-4644-352d-20bc-c7535d1a92db">MqttClient Constructor (IPAddress)</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="8e0943dc-418d-687a-7078-5149ce1f3759.htm" title="MqttClient Constructor (String)" tocid="8e0943dc-418d-687a-7078-5149ce1f3759">MqttClient Constructor (String)</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="1e18af87-25c6-8512-d45f-26a6eb67c1c9.htm" title="MqttClient Constructor (IPAddress, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols)" tocid="1e18af87-25c6-8512-d45f-26a6eb67c1c9">MqttClient Constructor (IPAddress, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols)</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="522e2e77-9119-1be5-c11d-5637c84e4770.htm" title="MqttClient Constructor (String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols)" tocid="522e2e77-9119-1be5-c11d-5637c84e4770">MqttClient Constructor (String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols)</a></div><div class="toclevel2 current" data-toclevel="2"><a data-tochassubtree="false" href="edd74122-b9d2-deaf-4905-06af5e03364c.htm" title="MqttClient Constructor (String, Int32, Boolean, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)" tocid="edd74122-b9d2-deaf-4905-06af5e03364c">MqttClient Constructor (String, Int32, Boolean, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="2dbd55f6-191c-c244-ce0f-38e066a64e18.htm" title="MqttClient Constructor (String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols, RemoteCertificateValidationCallback)" tocid="2dbd55f6-191c-c244-ce0f-38e066a64e18">MqttClient Constructor (String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols, RemoteCertificateValidationCallback)</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="2a07eab3-3c87-d72b-0498-cc660100c47d.htm" title="MqttClient Constructor (String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)" tocid="2a07eab3-3c87-d72b-0498-cc660100c47d">MqttClient Constructor (String, Int32, Boolean, X509Certificate, X509Certificate, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)</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 Constructor (String, Int32, Boolean, MqttSslProtocols, RemoteCertificateValidationCallback, LocalCertificateSelectionCallback)</td></tr></table><span class="introStyle"></span><div class="summary">
Constructor
</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="identifier">MqttClient</span>(
<span class="identifier">string</span> <span class="parameter">brokerHostName</span>,
<span class="identifier">int</span> <span class="parameter">brokerPort</span>,
<span class="identifier">bool</span> <span class="parameter">secure</span>,
<span class="identifier">MqttSslProtocols</span> <span class="parameter">sslProtocol</span>,
<span class="identifier">RemoteCertificateValidationCallback</span> <span class="parameter">userCertificateValidationCallback</span>,
<span class="identifier">LocalCertificateSelectionCallback</span> <span class="parameter">userCertificateSelectionCallback</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">Sub</span> <span class="identifier">New</span> (
<span class="parameter">brokerHostName</span> <span class="keyword">As</span> <span class="identifier">String</span>,
<span class="parameter">brokerPort</span> <span class="keyword">As</span> <span class="identifier">Integer</span>,
<span class="parameter">secure</span> <span class="keyword">As</span> <span class="identifier">Boolean</span>,
<span class="parameter">sslProtocol</span> <span class="keyword">As</span> <span class="identifier">MqttSslProtocols</span>,
<span class="parameter">userCertificateValidationCallback</span> <span class="keyword">As</span> <span class="identifier">RemoteCertificateValidationCallback</span>,
<span class="parameter">userCertificateSelectionCallback</span> <span class="keyword">As</span> <span class="identifier">LocalCertificateSelectionCallback</span>
)</pre></div><div id="ID0EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span>:
<span class="identifier">MqttClient</span>(
<span class="identifier">String</span>^ <span class="parameter">brokerHostName</span>,
<span class="identifier">int</span> <span class="parameter">brokerPort</span>,
<span class="identifier">bool</span> <span class="parameter">secure</span>,
<span class="identifier">MqttSslProtocols</span> <span class="parameter">sslProtocol</span>,
<span class="identifier">RemoteCertificateValidationCallback</span>^ <span class="parameter">userCertificateValidationCallback</span>,
<span class="identifier">LocalCertificateSelectionCallback</span>^ <span class="parameter">userCertificateSelectionCallback</span>
)</pre></div><div id="ID0EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">new</span> :
<span class="parameter">brokerHostName</span> : <span class="identifier">string</span> *
<span class="parameter">brokerPort</span> : <span class="identifier">int</span> *
<span class="parameter">secure</span> : <span class="identifier">bool</span> *
<span class="parameter">sslProtocol</span> : <span class="identifier">MqttSslProtocols</span> *
<span class="parameter">userCertificateValidationCallback</span> : <span class="identifier">RemoteCertificateValidationCallback</span> *
<span class="parameter">userCertificateSelectionCallback</span> : <span class="identifier">LocalCertificateSelectionCallback</span> <span class="keyword">-&gt;</span> <span class="identifier">MqttClient</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">brokerHostName</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span id="LST3F26E83F_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3F26E83F_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>String</a><br />Broker Host Name or IP Address</dd><dt><span class="parameter">brokerPort</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/td2s409d" target="_blank">System<span id="LST3F26E83F_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3F26E83F_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Int32</a><br />Broker port</dd><dt><span class="parameter">secure</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/a28wyd50" target="_blank">System<span id="LST3F26E83F_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3F26E83F_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Boolean</a><br />Using secure connection</dd><dt><span class="parameter">sslProtocol</span></dt><dd>Type: <a href="6b6752a0-132d-982d-42c0-b1d9d443f969.htm">uPLibrary.Networking.M2Mqtt<span id="LST3F26E83F_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3F26E83F_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>MqttSslProtocols</a><br />SSL/TLS protocol version</dd><dt><span class="parameter">userCertificateValidationCallback</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/ms145054" target="_blank">System.Net.Security<span id="LST3F26E83F_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3F26E83F_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>RemoteCertificateValidationCallback</a><br />A RemoteCertificateValidationCallback delegate responsible for validating the certificate supplied by the remote party</dd><dt><span class="parameter">userCertificateSelectionCallback</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/ms145028" target="_blank">System.Net.Security<span id="LST3F26E83F_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST3F26E83F_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LocalCertificateSelectionCallback</a><br />A LocalCertificateSelectionCallback delegate responsible for selecting the certificate used for authentication</dd></dl></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID2RBSection" 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="956ab130-7366-1a07-e5e3-b2959971d0c0.htm">MqttClient Overload</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>