files/rustdoc/paho_mqtt3as_sys/fn.MQTTAsync_create.html - gerrit/www.eclipse.org/paho - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="rustdoc">
     <meta name="description" content="API documentation for the Rust `MQTTAsync_create` fn in crate `paho_mqtt3as_sys`.">
     <meta name="keywords" content="rust, rustlang, rust-lang, MQTTAsync_create">

     <title>paho_mqtt3as_sys::MQTTAsync_create - Rust</title>

     <link rel="stylesheet" type="text/css" href="../normalize.css">
     <link rel="stylesheet" type="text/css" href="../rustdoc.css">
     <link rel="stylesheet" type="text/css" href="../main.css">


 </head>
 <body class="rustdoc fn">
     <!--[if lte IE 8]>
     <div class="warning">
         This old browser is unsupported and will most likely display funky
         things.
     </div>
     <![endif]-->


     <nav class="sidebar">

         <p class='location'><a href='index.html'>paho_mqtt3as_sys</a></p><script>window.sidebarCurrent = {name: 'MQTTAsync_create', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
     </nav>

     <nav class="sub">
         <form class="search-form js-only">
             <div class="search-container">
                 <input class="search-input" name="search"
                        autocomplete="off"
                        placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
                        type="search">
             </div>
         </form>
     </nav>

     <section id='main' class="content">
 <h1 class='fqn'><span class='in-band'>Function <a href='index.html'>paho_mqtt3as_sys</a>::<wbr><a class="fn" href=''>MQTTAsync_create</a></span><span class='out-of-band'><span id='render-detail'>
                    <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
                        [<span class='inner'>&#x2212;</span>]
                    </a>
                </span><a class='srclink' href='../src/paho_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#1867-1872' title='goto source code'>[src]</a></span></h1>
 <pre class='rust fn'>pub unsafe extern &quot;C&quot; fn MQTTAsync_create(<br>&nbsp;&nbsp;&nbsp;&nbsp;handle: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync.html" title="type paho_mqtt3as_sys::MQTTAsync">MQTTAsync</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;serverURI: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;clientId: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;persistence_type: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;persistence_context: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/std/os/raw/enum.c_void.html" title="enum std::os::raw::c_void">c_void</a><br>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></pre><div class='docblock'><p>This function creates an MQTT client ready for connection to the
 specified server and using the specified persistent storage (see
 MQTTAsync_persistence). See also MQTTAsync_destroy().
 @param handle A pointer to an ::MQTTAsync handle. The handle is
 populated with a valid client reference following a successful return from
 this function.
 @param serverURI A null-terminated string specifying the server to
 which the client will connect. It takes the form <i>protocol://host:port</i>.
 <i>protocol</i> must be <i>tcp</i> or <i>ssl</i>. For <i>host</i>, you can
 specify either an IP address or a host name. For instance, to connect to
 a server running on the local machines with the default MQTT port, specify
 <i>tcp://localhost:1883</i>.
 @param clientId The client identifier passed to the server when the
 client connects to it. It is a null-terminated UTF-8 encoded string.
 @param persistence_type The type of persistence to be used by the client:
 <br>
 ::MQTTCLIENT_PERSISTENCE_NONE: Use in-memory persistence. If the device or
 system on which the client is running fails or is switched off, the current
 state of any in-flight messages is lost and some messages may not be
 delivered even at QoS1 and QoS2.
 <br>
 ::MQTTCLIENT_PERSISTENCE_DEFAULT: Use the default (file system-based)
 persistence mechanism. Status about in-flight messages is held in persistent
 storage and provides some protection against message loss in the case of
 unexpected failure.
 <br>
 ::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence
 implementation. Using this type of persistence gives control of the
 persistence mechanism to the application. The application has to implement
 the MQTTClient_persistence interface.
 @param persistence_context If the application uses
 ::MQTTCLIENT_PERSISTENCE_NONE persistence, this argument is unused and should
 be set to NULL. For ::MQTTCLIENT_PERSISTENCE_DEFAULT persistence, it
 should be set to the location of the persistence directory (if set
 to NULL, the persistence directory used is the working directory).
 Applications that use ::MQTTCLIENT_PERSISTENCE_USER persistence set this
 argument to point to a valid MQTTClient_persistence structure.
 @return ::MQTTASYNC_SUCCESS if the client is successfully created, otherwise
 an error code is returned.</p>
 </div></section>
     <section id='search' class="content hidden"></section>

     <section class="footer"></section>

     <aside id="help" class="hidden">
         <div>
             <h1 class="hidden">Help</h1>

             <div class="shortcuts">
                 <h2>Keyboard Shortcuts</h2>

                 <dl>
                     <dt>?</dt>
                     <dd>Show this help dialog</dd>
                     <dt>S</dt>
                     <dd>Focus the search field</dd>
                     <dt>&larrb;</dt>
                     <dd>Move up in search results</dd>
                     <dt>&rarrb;</dt>
                     <dd>Move down in search results</dd>
                     <dt>&#9166;</dt>
                     <dd>Go to active search result</dd>
                     <dt>+</dt>
                     <dd>Collapse/expand all sections</dd>
                 </dl>
             </div>

             <div class="infos">
                 <h2>Search Tricks</h2>

                 <p>
                     Prefix searches with a type followed by a colon (e.g.
                     <code>fn:</code>) to restrict the search to a given type.
                 </p>

                 <p>
                     Accepted types are: <code>fn</code>, <code>mod</code>,
                     <code>struct</code>, <code>enum</code>,
                     <code>trait</code>, <code>type</code>, <code>macro</code>,
                     and <code>const</code>.
                 </p>

                 <p>
                     Search functions by type signature (e.g.
                     <code>vec -> usize</code> or <code>* -> vec</code>)
                 </p>
             </div>
         </div>
     </aside>


     <script>
         window.rootPath = "../";
         window.currentCrate = "paho_mqtt3as_sys";
     </script>
     <script src="../main.js"></script>
     <script defer src="../search-index.js"></script>
 </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<meta name="generator" content="rustdoc">
	<meta name="description" content="API documentation for the Rust `MQTTAsync_create` fn in crate `paho_mqtt3as_sys`.">
	<meta name="keywords" content="rust, rustlang, rust-lang, MQTTAsync_create">

	<title>paho_mqtt3as_sys::MQTTAsync_create - Rust</title>

	<link rel="stylesheet" type="text/css" href="../normalize.css">
	<link rel="stylesheet" type="text/css" href="../rustdoc.css">
	<link rel="stylesheet" type="text/css" href="../main.css">




	</head>
	<body class="rustdoc fn">
	<!--[if lte IE 8]>
	<div class="warning">
	This old browser is unsupported and will most likely display funky
	things.
	</div>
	<![endif]-->



	<nav class="sidebar">

	<p class='location'><a href='index.html'>paho_mqtt3as_sys</a></p><script>window.sidebarCurrent = {name: 'MQTTAsync_create', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
	</nav>

	<nav class="sub">
	<form class="search-form js-only">
	<div class="search-container">
	<input class="search-input" name="search"
	autocomplete="off"
	placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
	type="search">
	</div>
	</form>
	</nav>

	<section id='main' class="content">
	<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>paho_mqtt3as_sys</a>::<wbr><a class="fn" href=''>MQTTAsync_create</a></span><span class='out-of-band'><span id='render-detail'>
	<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
	[<span class='inner'>−</span>]
	</a>
	</span><a class='srclink' href='../src/paho_mqtt3as_sys/home/fmp/mqtt/paho-rust/target/debug/build/paho-mqtt3as-sys-8520fd8db5dd3f65/out/bindings.rs.html#1867-1872' title='goto source code'>[src]</a></span></h1>
	<pre class='rust fn'>pub unsafe extern "C" fn MQTTAsync_create(<br>    handle: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">mut </a><a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync.html" title="type paho_mqtt3as_sys::MQTTAsync">MQTTAsync</a>, <br>    serverURI: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>, <br>    clientId: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">const </a><a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_char.html" title="type std::os::raw::c_char">c_char</a>, <br>    persistence_type: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>, <br>    persistence_context: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/std/os/raw/enum.c_void.html" title="enum std::os::raw::c_void">c_void</a><br>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a></pre><div class='docblock'><p>This function creates an MQTT client ready for connection to the
	specified server and using the specified persistent storage (see
	MQTTAsync_persistence). See also MQTTAsync_destroy().
	@param handle A pointer to an ::MQTTAsync handle. The handle is
	populated with a valid client reference following a successful return from
	this function.
	@param serverURI A null-terminated string specifying the server to
	which the client will connect. It takes the form <i>protocol://host:port</i>.
	<i>protocol</i> must be <i>tcp</i> or <i>ssl</i>. For <i>host</i>, you can
	specify either an IP address or a host name. For instance, to connect to
	a server running on the local machines with the default MQTT port, specify
	<i>tcp://localhost:1883</i>.
	@param clientId The client identifier passed to the server when the
	client connects to it. It is a null-terminated UTF-8 encoded string.
	@param persistence_type The type of persistence to be used by the client:
	<br>
	::MQTTCLIENT_PERSISTENCE_NONE: Use in-memory persistence. If the device or
	system on which the client is running fails or is switched off, the current
	state of any in-flight messages is lost and some messages may not be
	delivered even at QoS1 and QoS2.
	<br>
	::MQTTCLIENT_PERSISTENCE_DEFAULT: Use the default (file system-based)
	persistence mechanism. Status about in-flight messages is held in persistent
	storage and provides some protection against message loss in the case of
	unexpected failure.
	<br>
	::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence
	implementation. Using this type of persistence gives control of the
	persistence mechanism to the application. The application has to implement
	the MQTTClient_persistence interface.
	@param persistence_context If the application uses
	::MQTTCLIENT_PERSISTENCE_NONE persistence, this argument is unused and should
	be set to NULL. For ::MQTTCLIENT_PERSISTENCE_DEFAULT persistence, it
	should be set to the location of the persistence directory (if set
	to NULL, the persistence directory used is the working directory).
	Applications that use ::MQTTCLIENT_PERSISTENCE_USER persistence set this
	argument to point to a valid MQTTClient_persistence structure.
	@return ::MQTTASYNC_SUCCESS if the client is successfully created, otherwise
	an error code is returned.</p>
	</div></section>
	<section id='search' class="content hidden"></section>

	<section class="footer"></section>

	<aside id="help" class="hidden">
	<div>
	<h1 class="hidden">Help</h1>

	<div class="shortcuts">
	<h2>Keyboard Shortcuts</h2>

	<dl>
	<dt>?</dt>
	<dd>Show this help dialog</dd>
	<dt>S</dt>
	<dd>Focus the search field</dd>
	<dt>&larrb;</dt>
	<dd>Move up in search results</dd>
	<dt>&rarrb;</dt>
	<dd>Move down in search results</dd>
	<dt>⏎</dt>
	<dd>Go to active search result</dd>
	<dt>+</dt>
	<dd>Collapse/expand all sections</dd>
	</dl>
	</div>

	<div class="infos">
	<h2>Search Tricks</h2>

	<p>
	Prefix searches with a type followed by a colon (e.g.
	<code>fn:</code>) to restrict the search to a given type.
	</p>

	<p>
	Accepted types are: <code>fn</code>, <code>mod</code>,
	<code>struct</code>, <code>enum</code>,
	<code>trait</code>, <code>type</code>, <code>macro</code>,
	and <code>const</code>.
	</p>

	<p>
	Search functions by type signature (e.g.
	<code>vec -> usize</code> or <code>* -> vec</code>)
	</p>
	</div>
	</div>
	</aside>



	<script>
	window.rootPath = "../";
	window.currentCrate = "paho_mqtt3as_sys";
	</script>
	<script src="../main.js"></script>
	<script defer src="../search-index.js"></script>
	</body>
	</html>