]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - iotdev/awsiot.git/blobdiff - docs/html/structShadowParameters__t.html
removed all content, added redirect
[iotdev/awsiot.git] / docs / html / structShadowParameters__t.html
diff --git a/docs/html/structShadowParameters__t.html b/docs/html/structShadowParameters__t.html
deleted file mode 100644 (file)
index ed02eb6..0000000
+++ /dev/null
@@ -1,124 +0,0 @@
-<!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"/>
-<title>AWSIoTCSDK: ShadowParameters_t Struct Reference</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javaScript" src="search/search.js"></script>
-<link href="doxygen.css" rel="stylesheet" type="text/css"/>
-</head>
-<body onload='searchBox.OnSelectItem(0);'>
-<!-- Generated by Doxygen 1.7.2 -->
-<script type="text/javascript"><!--
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
---></script>
-<div class="navigation" id="top">
-  <div class="tabs">
-    <ul class="tablist">
-      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
-      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
-      <li><a href="modules.html"><span>Modules</span></a></li>
-      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
-      <li><a href="files.html"><span>Files</span></a></li>
-      <li id="searchli">
-        <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 class="tabs2">
-    <ul class="tablist">
-      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
-      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
-      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
-    </ul>
-  </div>
-</div>
-<div class="header">
-  <div class="summary">
-<a href="#pub-attribs">Data Fields</a> &#124;
-<a href="#related">Related Functions</a>  </div>
-  <div class="headertitle">
-<h1>ShadowParameters_t Struct Reference</h1>  </div>
-</div>
-<div class="contents">
-<!-- doxytag: class="ShadowParameters_t" -->
-<p>Shadow Connect parameters.  
-<a href="#_details">More...</a></p>
-
-<p><code>#include &lt;<a class="el" href="aws__iot__shadow__interface_8h_source.html">aws_iot_shadow_interface.h</a>&gt;</code></p>
-<!-- startSectionHeader --><div class="dynheader">
-Collaboration diagram for ShadowParameters_t:<!-- endSectionHeader --></div>
-<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
-<div class="center"><img src="structShadowParameters__t__coll__graph.png" border="0" usemap="#ShadowParameters__t_coll__map" alt="Collaboration graph"/></div>
-<map name="ShadowParameters__t_coll__map" id="ShadowParameters__t_coll__map">
-</map>
-<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
-<table class="memberdecls">
-<tr><td colspan="2"><h2><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb78403e35dd900410d5d26ef0fa315d"></a><!-- doxytag: member="ShadowParameters_t::pMyThingName" ref="adb78403e35dd900410d5d26ef0fa315d" args="" -->
-char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#adb78403e35dd900410d5d26ef0fa315d">pMyThingName</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Every device has a Thing Shadow and this is the placeholder for name. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27619390335abf973719645b8f31a277"></a><!-- doxytag: member="ShadowParameters_t::pMqttClientId" ref="a27619390335abf973719645b8f31a277" args="" -->
-char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#a27619390335abf973719645b8f31a277">pMqttClientId</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Currently the Shadow uses MQTT to connect and it is important to ensure we have unique client id. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abebf2ba2657ead7718385f2406730cc0"></a><!-- doxytag: member="ShadowParameters_t::pHost" ref="abebf2ba2657ead7718385f2406730cc0" args="" -->
-char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#abebf2ba2657ead7718385f2406730cc0">pHost</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">This will be unique to a customer and can be retrieved from the console. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3243eeb13c8bad2cf78dcd7003b1d665"></a><!-- doxytag: member="ShadowParameters_t::port" ref="a3243eeb13c8bad2cf78dcd7003b1d665" args="" -->
-int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#a3243eeb13c8bad2cf78dcd7003b1d665">port</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">By default the port is 8883. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa3bbe30735094046913d645b6d2ae50"></a><!-- doxytag: member="ShadowParameters_t::pRootCA" ref="afa3bbe30735094046913d645b6d2ae50" args="" -->
-char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#afa3bbe30735094046913d645b6d2ae50">pRootCA</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Location with the Filename of the Root CA. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ba70adf7b2553a574d0c493815c3fde"></a><!-- doxytag: member="ShadowParameters_t::pClientCRT" ref="a9ba70adf7b2553a574d0c493815c3fde" args="" -->
-char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#a9ba70adf7b2553a574d0c493815c3fde">pClientCRT</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Location of Device certs signed by AWS IoT service. <br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0a34f1265930aec7023f625af80df7f"></a><!-- doxytag: member="ShadowParameters_t::pClientKey" ref="af0a34f1265930aec7023f625af80df7f" args="" -->
-char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#af0a34f1265930aec7023f625af80df7f">pClientKey</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Location of Device private key. <br/></td></tr>
-<tr><td colspan="2"><h2><a name="related"></a>
-Related Functions</h2></td></tr>
-<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
-<br/></td></tr>
-<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc225bbde6004034d41899a4f4b13074"></a><!-- doxytag: member="ShadowParameters_t::ShadowParametersDefault" ref="adc225bbde6004034d41899a4f4b13074" args="" -->
-const <a class="el" href="structShadowParameters__t.html">ShadowParameters_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structShadowParameters__t.html#adc225bbde6004034d41899a4f4b13074">ShadowParametersDefault</a></td></tr>
-<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">This is set to defaults from the configuration file The certs are set to NULL because they need the path to the file. <a class="el" href="shadow__sample_8c.html" title="A simple connected window example demonstrating the use of Thing Shadow.">shadow_sample.c</a> file demonstrates on how to get the relative path. <br/></td></tr>
-</table>
-<hr/><a name="_details"></a><h2>Detailed Description</h2>
-<p>As the Shadow SDK uses MQTT underneath, it could be connected and disconnected on events to save some battery. </p>
-<dl class="note"><dt><b>Note:</b></dt><dd>Always use the <code>ShadowParametersDefault</code> to initialize this struct </dd></dl>
-</div>
-<!--- 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>Data Structures</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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>
-
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="" frameborder="0" 
-        name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-
-<hr class="footer"/><address class="footer"><small>Generated on Tue Oct 6 2015 05:14:49 for AWSIoTCSDK by&#160;
-<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
-</body>
-</html>