blob: 1ad37a58d973662a2b3ca441709c983ece1c8731 [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.6"/>
<title>Paho C++: src/mqtt/types.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Paho C++
&#160;<span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">The Paho MQTT C++ Client Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('types_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a></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 class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">types.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Basic types and type conversions for the Paho MQTT C++ library.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br/>
<code>#include &lt;vector&gt;</code><br/>
<code>#include &lt;memory&gt;</code><br/>
<code>#include &lt;chrono&gt;</code><br/>
</div>
<p><a href="types_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:abdf26d760bbf2b18e19a82eae1b75a6e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdf26d760bbf2b18e19a82eae1b75a6e"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::byte</b> = uint8_t</td></tr>
<tr class="memdesc:abdf26d760bbf2b18e19a82eae1b75a6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">A 'byte' is an 8-bit, unsigned int. <br/></td></tr>
<tr class="separator:abdf26d760bbf2b18e19a82eae1b75a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c4d1d7995dd0788086c71bb3886ed8b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9c4d1d7995dd0788086c71bb3886ed8b"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::string</b> = std::string</td></tr>
<tr class="memdesc:a9c4d1d7995dd0788086c71bb3886ed8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">An mqtt string is just a std::string. <br/></td></tr>
<tr class="separator:a9c4d1d7995dd0788086c71bb3886ed8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68d70f0dda15b7630c147b56b50b5b57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68d70f0dda15b7630c147b56b50b5b57"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::binary</b> = std::string</td></tr>
<tr class="memdesc:a68d70f0dda15b7630c147b56b50b5b57"><td class="mdescLeft">&#160;</td><td class="mdescRight">A binary blob of data is, umm, just a string too! <br/></td></tr>
<tr class="separator:a68d70f0dda15b7630c147b56b50b5b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b3231169b1d658b36a3980c59cc7b6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b3231169b1d658b36a3980c59cc7b6c"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::string_ptr</b> = std::shared_ptr&lt; const string &gt;</td></tr>
<tr class="memdesc:a6b3231169b1d658b36a3980c59cc7b6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart/shared pointer to a const string. <br/></td></tr>
<tr class="separator:a6b3231169b1d658b36a3980c59cc7b6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2203eb9e648f72cf8cc4c5c1f4e7d035"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2203eb9e648f72cf8cc4c5c1f4e7d035"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::binary_ptr</b> = std::shared_ptr&lt; const binary &gt;</td></tr>
<tr class="memdesc:a2203eb9e648f72cf8cc4c5c1f4e7d035"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart/shared pointer to a const binary blob. <br/></td></tr>
<tr class="separator:a2203eb9e648f72cf8cc4c5c1f4e7d035"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9a32bc28c28424385cb1038f0218552d"><td class="memTemplParams" colspan="2">template&lt;class Rep , class Period &gt; </td></tr>
<tr class="memitem:a9a32bc28c28424385cb1038f0218552d"><td class="memTemplItemLeft" align="right" valign="top">std::chrono::seconds&#160;</td><td class="memTemplItemRight" valign="bottom"><b>mqtt::to_seconds</b> (const std::chrono::duration&lt; Rep, Period &gt; &amp;dur)</td></tr>
<tr class="memdesc:a9a32bc28c28424385cb1038f0218552d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a chrono duration to seconds. <a href="#a9a32bc28c28424385cb1038f0218552d">More...</a><br/></td></tr>
<tr class="separator:a9a32bc28c28424385cb1038f0218552d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38f7f3ae50901f2befa8d57f2dea5f1e"><td class="memTemplParams" colspan="2">template&lt;class Rep , class Period &gt; </td></tr>
<tr class="memitem:a38f7f3ae50901f2befa8d57f2dea5f1e"><td class="memTemplItemLeft" align="right" valign="top">long&#160;</td><td class="memTemplItemRight" valign="bottom"><b>mqtt::to_seconds_count</b> (const std::chrono::duration&lt; Rep, Period &gt; &amp;dur)</td></tr>
<tr class="memdesc:a38f7f3ae50901f2befa8d57f2dea5f1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a chrono duration to a number of seconds. <a href="#a38f7f3ae50901f2befa8d57f2dea5f1e">More...</a><br/></td></tr>
<tr class="separator:a38f7f3ae50901f2befa8d57f2dea5f1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f5ca48b2c51567309e86f195707f7ce"><td class="memTemplParams" colspan="2">template&lt;class Rep , class Period &gt; </td></tr>
<tr class="memitem:a7f5ca48b2c51567309e86f195707f7ce"><td class="memTemplItemLeft" align="right" valign="top">std::chrono::milliseconds&#160;</td><td class="memTemplItemRight" valign="bottom"><b>mqtt::to_milliseconds</b> (const std::chrono::duration&lt; Rep, Period &gt; &amp;dur)</td></tr>
<tr class="memdesc:a7f5ca48b2c51567309e86f195707f7ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a chrono duration to milliseconds. <a href="#a7f5ca48b2c51567309e86f195707f7ce">More...</a><br/></td></tr>
<tr class="separator:a7f5ca48b2c51567309e86f195707f7ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebf4a90459fc946acd41c9c352272821"><td class="memTemplParams" colspan="2">template&lt;class Rep , class Period &gt; </td></tr>
<tr class="memitem:aebf4a90459fc946acd41c9c352272821"><td class="memTemplItemLeft" align="right" valign="top">long&#160;</td><td class="memTemplItemRight" valign="bottom"><b>mqtt::to_milliseconds_count</b> (const std::chrono::duration&lt; Rep, Period &gt; &amp;dur)</td></tr>
<tr class="memdesc:aebf4a90459fc946acd41c9c352272821"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a chrono duration to a number of milliseconds. <a href="#aebf4a90459fc946acd41c9c352272821">More...</a><br/></td></tr>
<tr class="separator:aebf4a90459fc946acd41c9c352272821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47db58a58cd28677f387787de734b6ab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::to_bool</b> (int n)</td></tr>
<tr class="memdesc:a47db58a58cd28677f387787de734b6ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an into to a bool. <a href="#a47db58a58cd28677f387787de734b6ab">More...</a><br/></td></tr>
<tr class="separator:a47db58a58cd28677f387787de734b6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3d0adcf05f4a64aa67f4b67df390625"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><b>mqtt::to_int</b> (bool b)</td></tr>
<tr class="memdesc:ae3d0adcf05f4a64aa67f4b67df390625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts the boolean into a C integer true/false value. <a href="#ae3d0adcf05f4a64aa67f4b67df390625">More...</a><br/></td></tr>
<tr class="separator:ae3d0adcf05f4a64aa67f4b67df390625"><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>Basic types and type conversions for the Paho MQTT C++ library. </p>
<dl class="section date"><dt>Date</dt><dd>May 17, 2015 </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Frank Pagliughi </dd></dl>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_503ebd9f384f44c9859dcb1451d026bc.html">mqtt</a></li><li class="navelem"><a class="el" href="types_8h.html">types.h</a></li>
<li class="footer">Generated on Sun Jul 23 2017 10:24:29 for Paho C++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>