Google Git
Sign in
eclipse / gerrit / www.eclipse.org / paho / b0d1f1dc4e00e95ae1282c5465b8ac347079ffc3 / . / new / paho / files / mqttdoc / MQTTClient / html / struct_m_q_t_t_property.html
blob: 7558b0e0ccd9480f329d840e0bafb496f9991157 [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 MQTT C Client Library: MQTTProperty 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 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">MQTTProperty Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_m_q_t_t_properties_8h_source.html">MQTTProperties.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:a2ff04e8cc70fbaa9bcb9a4fb3d510882"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="_m_q_t_t_properties_8h.html#af623c1b670dfe3fda633c068e054d8b4">MQTTPropertyCodes</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_property.html#a2ff04e8cc70fbaa9bcb9a4fb3d510882">identifier</a></td></tr>
<tr class="separator:a2ff04e8cc70fbaa9bcb9a4fb3d510882"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0a928bd9a20f1c0adf29a5c4e255e19"><td class="memItemLeft" >union {</td></tr>
<tr class="memitem:a55e53bce3266fcc5db4b8fc2bd474466"><td class="memItemLeft" >&#160;&#160;&#160;char&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_property.html#a55e53bce3266fcc5db4b8fc2bd474466">byte</a></td></tr>
<tr class="separator:a55e53bce3266fcc5db4b8fc2bd474466"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc65d9aa44e97d08a9146292c49a40fe"><td class="memItemLeft" >&#160;&#160;&#160;short&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_property.html#adc65d9aa44e97d08a9146292c49a40fe">integer2</a></td></tr>
<tr class="separator:adc65d9aa44e97d08a9146292c49a40fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41c59b8b7de1e81188a9b0f889a91365"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_property.html#a41c59b8b7de1e81188a9b0f889a91365">integer4</a></td></tr>
<tr class="separator:a41c59b8b7de1e81188a9b0f889a91365"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f642c27ba21dc053aee46ed029cc48f"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
<tr class="memitem:aa43ebcb9f97210421431a671384ef159"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_len_string.html">MQTTLenString</a>&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_property.html#aa43ebcb9f97210421431a671384ef159">data</a></td></tr>
<tr class="separator:aa43ebcb9f97210421431a671384ef159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09e85ff5ad73824d6c2edc1ce4283a17"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_len_string.html">MQTTLenString</a>&#160;&#160;&#160;<a class="el" href="struct_m_q_t_t_property.html#a09e85ff5ad73824d6c2edc1ce4283a17">value</a></td></tr>
<tr class="separator:a09e85ff5ad73824d6c2edc1ce4283a17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f642c27ba21dc053aee46ed029cc48f"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a3f642c27ba21dc053aee46ed029cc48f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0a928bd9a20f1c0adf29a5c4e255e19"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_m_q_t_t_property.html#ad0a928bd9a20f1c0adf29a5c4e255e19">value</a></td></tr>
<tr class="separator:ad0a928bd9a20f1c0adf29a5c4e255e19"><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>Structure to hold an MQTT version 5 property of any type </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a2ff04e8cc70fbaa9bcb9a4fb3d510882"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ff04e8cc70fbaa9bcb9a4fb3d510882">&#9670;&nbsp;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="_m_q_t_t_properties_8h.html#af623c1b670dfe3fda633c068e054d8b4">MQTTPropertyCodes</a> identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>The MQTT V5 property id. A multi-byte integer. </p>
</div>
</div>
<a id="a55e53bce3266fcc5db4b8fc2bd474466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55e53bce3266fcc5db4b8fc2bd474466">&#9670;&nbsp;</a></span>byte</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char byte</td>
</tr>
</table>
</div><div class="memdoc">
<p>holds the value of a byte property type </p>
</div>
</div>
<a id="adc65d9aa44e97d08a9146292c49a40fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc65d9aa44e97d08a9146292c49a40fe">&#9670;&nbsp;</a></span>integer2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short integer2</td>
</tr>
</table>
</div><div class="memdoc">
<p>holds the value of a 2 byte integer property type </p>
</div>
</div>
<a id="a41c59b8b7de1e81188a9b0f889a91365"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41c59b8b7de1e81188a9b0f889a91365">&#9670;&nbsp;</a></span>integer4</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int integer4</td>
</tr>
</table>
</div><div class="memdoc">
<p>holds the value of a 4 byte integer property type </p>
</div>
</div>
<a id="aa43ebcb9f97210421431a671384ef159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa43ebcb9f97210421431a671384ef159">&#9670;&nbsp;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_m_q_t_t_len_string.html">MQTTLenString</a> data</td>
</tr>
</table>
</div><div class="memdoc">
<p>The value of a string property, or the name of a user property. </p>
</div>
</div>
<a id="a09e85ff5ad73824d6c2edc1ce4283a17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09e85ff5ad73824d6c2edc1ce4283a17">&#9670;&nbsp;</a></span>value <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_m_q_t_t_len_string.html">MQTTLenString</a> value</td>
</tr>
</table>
</div><div class="memdoc">
<p>The value of a user property. </p>
</div>
</div>
<a id="ad0a928bd9a20f1c0adf29a5c4e255e19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0a928bd9a20f1c0adf29a5c4e255e19">&#9670;&nbsp;</a></span>value <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } value</td>
</tr>
</table>
</div><div class="memdoc">
<p>The value of the property, as a union of the different possible types. </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_properties_8h_source.html">MQTTProperties.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 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>