blob: c12f16396f198b819b331c7ccf484a1c688b2cef [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_setCallbacks` fn in crate `paho_mqtt3as_sys`.">
<meta name="keywords" content="rust, rustlang, rust-lang, MQTTAsync_setCallbacks">
<title>paho_mqtt3as_sys::MQTTAsync_setCallbacks - 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_setCallbacks', 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_setCallbacks</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#1795-1800' title='goto source code'>[src]</a></span></h1>
<pre class='rust fn'>pub unsafe extern &quot;C&quot; fn MQTTAsync_setCallbacks(<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;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>&nbsp;&nbsp;&nbsp;&nbsp;cl: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_connectionLost.html" title="type paho_mqtt3as_sys::MQTTAsync_connectionLost">MQTTAsync_connectionLost</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;ma: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_messageArrived.html" title="type paho_mqtt3as_sys::MQTTAsync_messageArrived">MQTTAsync_messageArrived</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;dc: <a class="type" href="../paho_mqtt3as_sys/type.MQTTAsync_deliveryComplete.html" title="type paho_mqtt3as_sys::MQTTAsync_deliveryComplete">MQTTAsync_deliveryComplete</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 sets the global callback functions for a specific client.
If your client application doesn&#39;t use a particular callback, set the
relevant parameter to NULL. Any necessary message acknowledgements and
status communications are handled in the background without any intervention
from the client application. If you do not set a messageArrived callback
function, you will not be notified of the receipt of any messages as a
result of a subscription.</p>
<p><b>Note:</b> The MQTT client must be disconnected when this function is
called.
@param handle A valid client handle from a successful call to
MQTTAsync_create().
@param context A pointer to any application-specific context. The
the <i>context</i> pointer is passed to each of the callback functions to
provide access to the context information in the callback.
@param cl A pointer to an MQTTAsync_connectionLost() callback
function. You can set this to NULL if your application doesn&#39;t handle
disconnections.
@param ma A pointer to an MQTTAsync_messageArrived() callback
function. You can set this to NULL if your application doesn&#39;t handle
receipt of messages.
@param dc A pointer to an MQTTAsync_deliveryComplete() callback
function. You can set this to NULL if you do not want to check
for successful delivery.
@return ::MQTTASYNC_SUCCESS if the callbacks were correctly set,
::MQTTASYNC_FAILURE if an error occurred.</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>