Google Git
Sign in
eclipse / gerrit / www.eclipse.org / paho / b0d1f1dc4e00e95ae1282c5465b8ac347079ffc3 / . / files / mqttdoc / MQTTAsync / html / struct_m_q_t_t_async__success_data.html
blob: 4e5db270bca715514a59859687164c4d7b68d948 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Paho Asynchronous MQTT C Client Library: MQTTAsync_successData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Paho Asynchronous MQTT C Client Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">MQTTAsync_successData Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_m_q_t_t_async_8h_source.html">MQTTAsync.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:af8f771e67d284379111151b003c0d810"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__success_data.html#af8f771e67d284379111151b003c0d810">token</a></td></tr>
<tr class="separator:af8f771e67d284379111151b003c0d810"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bdd3370df613284ce3d889cbd0e1994"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:a35738099155a0e4f54050da474bab2e7"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#a35738099155a0e4f54050da474bab2e7">qos</a></td></tr>
<tr class="separator:a35738099155a0e4f54050da474bab2e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82786d9ba5cae39873f378a48b36c23b"><td class="memItemLeft" >&#160;&#160;&#160;int *&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#a82786d9ba5cae39873f378a48b36c23b">qosList</a></td></tr>
<tr class="separator:a82786d9ba5cae39873f378a48b36c23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea42caf0fa3239ee6b0f6b8c7b9f0d95"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a6ed8403758cecd2f762af6ba5e0ae525"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__message.html">MQTTAsync_message</a>&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#a6ed8403758cecd2f762af6ba5e0ae525">message</a></td></tr>
<tr class="separator:a6ed8403758cecd2f762af6ba5e0ae525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae25f4a1d2a3fa952d052a965376d8fef"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;char *&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#ae25f4a1d2a3fa952d052a965376d8fef">destinationName</a></td></tr>
<tr class="separator:ae25f4a1d2a3fa952d052a965376d8fef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea42caf0fa3239ee6b0f6b8c7b9f0d95"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#aea42caf0fa3239ee6b0f6b8c7b9f0d95">pub</a></td></tr>
<tr class="separator:aea42caf0fa3239ee6b0f6b8c7b9f0d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae128cb06cbc5d1231ddd4d4ceb5a0b8c"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:a95309fdf27015b12bc4adf56306e557b"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;char *&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#a95309fdf27015b12bc4adf56306e557b">serverURI</a></td></tr>
<tr class="separator:a95309fdf27015b12bc4adf56306e557b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#a12d546fd0ccf4e1091b18e1b735c7240">MQTTVersion</a></td></tr>
<tr class="separator:a12d546fd0ccf4e1091b18e1b735c7240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44baf2cb9a0bbcec3ed2eace43f832d1"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#a44baf2cb9a0bbcec3ed2eace43f832d1">sessionPresent</a></td></tr>
<tr class="separator:a44baf2cb9a0bbcec3ed2eace43f832d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae128cb06cbc5d1231ddd4d4ceb5a0b8c"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_async__success_data.html#ae128cb06cbc5d1231ddd4d4ceb5a0b8c">connect</a></td></tr>
<tr class="separator:ae128cb06cbc5d1231ddd4d4ceb5a0b8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bdd3370df613284ce3d889cbd0e1994"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_async__success_data.html#a3bdd3370df613284ce3d889cbd0e1994">alt</a></td></tr>
<tr class="separator:a3bdd3370df613284ce3d889cbd0e1994"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The data returned on completion of a successful API call in the response callback onSuccess. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="af8f771e67d284379111151b003c0d810"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8f771e67d284379111151b003c0d810">&#9670;&nbsp;</a></span>token</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_m_q_t_t_async_8h.html#a7ca6d2a1813f2bbd0bc3af2771e46ba4">MQTTAsync_token</a> token</td>
</tr>
</table>
</div><div class="memdoc">
<p>A token identifying the successful request. Can be used to refer to the request later. </p>
</div>
</div>
<a id="a35738099155a0e4f54050da474bab2e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35738099155a0e4f54050da474bab2e7">&#9670;&nbsp;</a></span>qos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int qos</td>
</tr>
</table>
</div><div class="memdoc">
<p>For subscribe, the granted QoS of the subscription returned by the server. </p>
</div>
</div>
<a id="a82786d9ba5cae39873f378a48b36c23b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82786d9ba5cae39873f378a48b36c23b">&#9670;&nbsp;</a></span>qosList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int* qosList</td>
</tr>
</table>
</div><div class="memdoc">
<p>For subscribeMany, the list of granted QoSs of the subscriptions returned by the server. </p>
</div>
</div>
<a id="a6ed8403758cecd2f762af6ba5e0ae525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ed8403758cecd2f762af6ba5e0ae525">&#9670;&nbsp;</a></span>message</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_m_q_t_t_async__message.html">MQTTAsync_message</a> message</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae25f4a1d2a3fa952d052a965376d8fef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae25f4a1d2a3fa952d052a965376d8fef">&#9670;&nbsp;</a></span>destinationName</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* destinationName</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aea42caf0fa3239ee6b0f6b8c7b9f0d95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea42caf0fa3239ee6b0f6b8c7b9f0d95">&#9670;&nbsp;</a></span>pub</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } pub</td>
</tr>
</table>
</div><div class="memdoc">
<p>For publish, the message being sent to the server. </p>
</div>
</div>
<a id="a95309fdf27015b12bc4adf56306e557b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95309fdf27015b12bc4adf56306e557b">&#9670;&nbsp;</a></span>serverURI</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* serverURI</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a12d546fd0ccf4e1091b18e1b735c7240"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12d546fd0ccf4e1091b18e1b735c7240">&#9670;&nbsp;</a></span>MQTTVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MQTTVersion</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a44baf2cb9a0bbcec3ed2eace43f832d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44baf2cb9a0bbcec3ed2eace43f832d1">&#9670;&nbsp;</a></span>sessionPresent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int sessionPresent</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae128cb06cbc5d1231ddd4d4ceb5a0b8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae128cb06cbc5d1231ddd4d4ceb5a0b8c">&#9670;&nbsp;</a></span>connect</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } connect</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3bdd3370df613284ce3d889cbd0e1994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bdd3370df613284ce3d889cbd0e1994">&#9670;&nbsp;</a></span>alt</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } alt</td>
</tr>
</table>
</div><div class="memdoc">
<p>A union of the different values that can be returned for subscribe, unsubscribe and publish. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="_m_q_t_t_async_8h_source.html">MQTTAsync.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 13 2018 13:40:20 for Paho Asynchronous MQTT C Client Library by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>