Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@xiazhvera
xiazhvera committed Feb 9, 2024
1 parent d218695 commit d20a362
Show file tree
Hide file tree
Showing 418 changed files with 47,029 additions and 0 deletions.
91 changes: 91 additions & 0 deletions docs/html/_action_8cpp.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AWS IoT C++ SDK: Action.cpp 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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">AWS IoT C++ SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Action.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Action Base class and related definitions for IoT Client.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="_action_8hpp_source.html">Action.hpp</a>&quot;</code><br />
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Defines a base class to be used by all Actions that can be run by the IoT Client. Also contains definitions for related Action types like ActionType, ActionState and ActionData </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
176 changes: 176 additions & 0 deletions docs/html/_action_8hpp.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AWS IoT C++ SDK: Action.hpp 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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">AWS IoT C++ SDK
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">Action.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Action Base class and related definitions for IoT Client.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;atomic&gt;</code><br />
<code>#include &quot;<a class="el" href="_utf8_string_8hpp_source.html">util/Utf8String.hpp</a>&quot;</code><br />
<code>#include &quot;util/threading/ThreadTask.hpp&quot;</code><br />
<code>#include &quot;<a class="el" href="_response_code_8hpp_source.html">ResponseCode.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_network_connection_8hpp_source.html">NetworkConnection.hpp</a>&quot;</code><br />
</div>
<p><a href="_action_8hpp_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 id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classawsiotsdk_1_1_action_state.html">awsiotsdk::ActionState</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classawsiotsdk_1_1_action.html" title="Action Class.">Action</a> State Class. <a href="classawsiotsdk_1_1_action_state.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classawsiotsdk_1_1_action_data.html">awsiotsdk::ActionData</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classawsiotsdk_1_1_action.html" title="Action Class.">Action</a> Data Class. <a href="classawsiotsdk_1_1_action_data.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classawsiotsdk_1_1_action.html">awsiotsdk::Action</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classawsiotsdk_1_1_action.html" title="Action Class.">Action</a> Class. <a href="classawsiotsdk_1_1_action.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1a5b35725e1f3e72eda0b1e385a943f8"><td class="memItemLeft" align="right" valign="top"><a id="a1a5b35725e1f3e72eda0b1e385a943f8" name="a1a5b35725e1f3e72eda0b1e385a943f8"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_NETWORK_ACTION_THREAD_SLEEP_DURATION_MS</b>&#160;&#160;&#160;100</td></tr>
<tr class="separator:a1a5b35725e1f3e72eda0b1e385a943f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:acaa59a76f3c629d2756ca9bb92edbd62"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_action_8hpp.html#acaa59a76f3c629d2756ca9bb92edbd62">awsiotsdk::ActionType</a> { <br />
&#160;&#160;<b>RESERVED_ACTION</b> = 0
, <b>CORE_PROCESS_INBOUND</b> = 1
, <b>CORE_PROCESS_OUTBOUND</b> = 2
, <b>CONNECT</b> = 3
, <br />
&#160;&#160;<b>DISCONNECT</b> = 4
, <b>PUBLISH</b> = 5
, <b>PUBACK</b> = 6
, <b>PUBREC</b> = 7
, <br />
&#160;&#160;<b>PUBREL</b> = 8
, <b>PUBCOMP</b> = 9
, <b>SUBSCRIBE</b> = 10
, <b>READ_INCOMING</b> = 11
, <br />
&#160;&#160;<b>KEEP_ALIVE</b> = 12
, <b>PUBLISH_INBOUND</b> = 13
, <b>UNSUBSCRIBE</b> = 14
, <b>RECONNECT</b> = 15
, <br />
&#160;&#160;<b>GREENGRASS_DISCOVER</b> = 16
<br />
}</td></tr>
<tr class="memdesc:acaa59a76f3c629d2756ca9bb92edbd62"><td class="mdescLeft">&#160;</td><td class="mdescRight">ActionType Enum Class. <a href="_action_8hpp.html#acaa59a76f3c629d2756ca9bb92edbd62">More...</a><br /></td></tr>
<tr class="separator:acaa59a76f3c629d2756ca9bb92edbd62"><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 >Defines a base class to be used by all Actions that can be run by the IoT Client. Also contains definitions for related Action types like ActionType, ActionState and ActionData </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="acaa59a76f3c629d2756ca9bb92edbd62" name="acaa59a76f3c629d2756ca9bb92edbd62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acaa59a76f3c629d2756ca9bb92edbd62">&#9670;&#160;</a></span>ActionType</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum class <a class="el" href="_action_8hpp.html#acaa59a76f3c629d2756ca9bb92edbd62">awsiotsdk::ActionType</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p >Defines a strongly typed enum which specifies different Action Types. Actions can be registered in the core client for each of these Types. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
Loading

0 comments on commit d20a362

Please sign in to comment.