blob: 70c3231400110c273b9b20f0f5a78343fa2f8e69 [file] [log] [blame]
<!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_connect` fn in crate `paho_mqtt3as_sys`.">
<meta name="keywords" content="rust, rustlang, rust-lang, MQTTAsync_connect">
<title>paho_mqtt3as_sys::MQTTAsync_connect - 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_connect', 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_connect</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#2430-2432' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub unsafe extern &quot;C&quot; fn MQTTAsync_connect(<br>&nbsp;&nbsp;&nbsp;&nbsp;handle: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync.html" title="type paho_mqtt3as_sys::MQTTAsync">MQTTAsync</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;options: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../paho_mqtt3as_sys/struct.MQTTAsync_connectOptions.html" title="struct paho_mqtt3as_sys::MQTTAsync_connectOptions">MQTTAsync_connectOptions</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 attempts to connect a previously-created client (see
MQTTAsync_create()) to an MQTT server using the specified options. If you
want to enable asynchronous message and status notifications, you must call
MQTTAsync_setCallbacks() prior to MQTTAsync_connect().
@param handle A valid client handle from a successful call to
MQTTAsync_create().
@param options A pointer to a valid MQTTAsync_connectOptions
structure.
@return ::MQTTASYNC_SUCCESS if the client connect request was accepted.
If the client was unable to connect to the server, an error code is
returned via the onFailure callback, if set.
Error codes greater than 0 are returned by the MQTT protocol:<br><br>
<b>1</b>: Connection refused: Unacceptable protocol version<br>
<b>2</b>: Connection refused: Identifier rejected<br>
<b>3</b>: Connection refused: Server unavailable<br>
<b>4</b>: Connection refused: Bad user name or password<br>
<b>5</b>: Connection refused: Not authorized<br>
<b>6-255</b>: Reserved for future use<br></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>