ESP3D/docs/html/notifications__service_8cpp.html
2020-01-06 14:46:56 +01:00

349 lines
19 KiB
HTML

<!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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP3D: esp3d/src/modules/notifications/notifications_service.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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="ESP3D_social_mini.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP3D
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Firmware for ESP boards connected to 3D Printer</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('notifications__service_8cpp.html',''); initResizable(); });
/* @license-end */
</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)">
</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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">notifications_service.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="esp3d__config_8h_source.html">../../include/esp3d_config.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="notifications__service_8h_source.html">notifications_service.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="settings__esp3d_8h_source.html">../../core/settings_esp3d.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="esp3doutput_8h_source.html">../../core/esp3doutput.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="netconfig_8h_source.html">../network/netconfig.h</a>&quot;</code><br />
<code>#include &lt;base64.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for notifications_service.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="notifications__service_8cpp__incl.png" border="0" usemap="#esp3d_2src_2modules_2notifications_2notifications__service_8cpp" alt=""/></div>
<map name="esp3d_2src_2modules_2notifications_2notifications__service_8cpp" id="esp3d_2src_2modules_2notifications_2notifications__service_8cpp">
<area shape="rect" title=" " alt="" coords="935,5,1140,47"/>
<area shape="rect" href="esp3d__config_8h.html" title=" " alt="" coords="627,169,754,211"/>
<area shape="rect" href="notifications__service_8h.html" title=" " alt="" coords="728,95,877,121"/>
<area shape="rect" href="settings__esp3d_8h.html" title=" " alt="" coords="1065,169,1186,211"/>
<area shape="rect" href="esp3doutput_8h.html" title=" " alt="" coords="901,95,1059,121"/>
<area shape="rect" href="netconfig_8h.html" title=" " alt="" coords="1133,95,1280,121"/>
<area shape="rect" title=" " alt="" coords="1304,95,1379,121"/>
<area shape="rect" title=" " alt="" coords="1065,333,1143,360"/>
<area shape="rect" href="defines_8h.html" title=" " alt="" coords="5,259,136,285"/>
<area shape="rect" href="pins_8h.html" title=" " alt="" coords="160,259,275,285"/>
<area shape="rect" href="configuration_8h.html" title=" " alt="" coords="299,259,429,285"/>
<area shape="rect" href="sanity__esp3d_8h.html" title=" " alt="" coords="454,259,621,285"/>
<area shape="rect" href="hal_8h.html" title=" " alt="" coords="645,259,736,285"/>
<area shape="rect" href="debug__esp3d_8h.html" title=" " alt="" coords="761,259,911,285"/>
<area shape="rect" href="version_8h.html" title=" " alt="" coords="936,259,1067,285"/>
<area shape="rect" title=" " alt="" coords="950,177,1010,203"/>
</map>
</div>
</div>
<p><a href="notifications__service_8cpp_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a95ca12049f2b4fb72611c4967f135801"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#a95ca12049f2b4fb72611c4967f135801">PUSHOVERTIMEOUT</a>&#160;&#160;&#160;5000</td></tr>
<tr class="separator:a95ca12049f2b4fb72611c4967f135801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18457219d775184695778f3e7a9e83f5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#a18457219d775184695778f3e7a9e83f5">PUSHOVERSERVER</a>&#160;&#160;&#160;&quot;api.pushover.net&quot;</td></tr>
<tr class="separator:a18457219d775184695778f3e7a9e83f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a777249361a4ec6e6fd533a274142f81e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#a777249361a4ec6e6fd533a274142f81e">PUSHOVERPORT</a>&#160;&#160;&#160;443</td></tr>
<tr class="separator:a777249361a4ec6e6fd533a274142f81e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7b9c2c6e63804d4164599d934087a34"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#aa7b9c2c6e63804d4164599d934087a34">LINETIMEOUT</a>&#160;&#160;&#160;5000</td></tr>
<tr class="separator:aa7b9c2c6e63804d4164599d934087a34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb7de3855b71b8b0c1693a7b7d7c8fa0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#adb7de3855b71b8b0c1693a7b7d7c8fa0">LINESERVER</a>&#160;&#160;&#160;&quot;notify-api.line.me&quot;</td></tr>
<tr class="separator:adb7de3855b71b8b0c1693a7b7d7c8fa0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a763c29624ce8eab4e15c75d1d4685174"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#a763c29624ce8eab4e15c75d1d4685174">LINEPORT</a>&#160;&#160;&#160;443</td></tr>
<tr class="separator:a763c29624ce8eab4e15c75d1d4685174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4212435f161b9ecfb275f87114918c6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#aa4212435f161b9ecfb275f87114918c6">EMAILTIMEOUT</a>&#160;&#160;&#160;5000</td></tr>
<tr class="separator:aa4212435f161b9ecfb275f87114918c6"><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:a3e3b0edc476436d3429fa36baad62cec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#a3e3b0edc476436d3429fa36baad62cec">Wait4Answer</a> (TSecureClient &amp;client, const char *linetrigger, const char *expected_answer, uint32_t timeout)</td></tr>
<tr class="separator:a3e3b0edc476436d3429fa36baad62cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a32dd437e2a800eba87cc012d7873535d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_notifications_service.html">NotificationsService</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notifications__service_8cpp.html#a32dd437e2a800eba87cc012d7873535d">notificationsservice</a></td></tr>
<tr class="separator:a32dd437e2a800eba87cc012d7873535d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa4212435f161b9ecfb275f87114918c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4212435f161b9ecfb275f87114918c6">&#9670;&nbsp;</a></span>EMAILTIMEOUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define EMAILTIMEOUT&#160;&#160;&#160;5000</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00065">65</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<a id="a763c29624ce8eab4e15c75d1d4685174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a763c29624ce8eab4e15c75d1d4685174">&#9670;&nbsp;</a></span>LINEPORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LINEPORT&#160;&#160;&#160;443</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00063">63</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<a id="adb7de3855b71b8b0c1693a7b7d7c8fa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb7de3855b71b8b0c1693a7b7d7c8fa0">&#9670;&nbsp;</a></span>LINESERVER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LINESERVER&#160;&#160;&#160;&quot;notify-api.line.me&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00062">62</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<a id="aa7b9c2c6e63804d4164599d934087a34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7b9c2c6e63804d4164599d934087a34">&#9670;&nbsp;</a></span>LINETIMEOUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LINETIMEOUT&#160;&#160;&#160;5000</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00061">61</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<a id="a777249361a4ec6e6fd533a274142f81e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a777249361a4ec6e6fd533a274142f81e">&#9670;&nbsp;</a></span>PUSHOVERPORT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PUSHOVERPORT&#160;&#160;&#160;443</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00059">59</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<a id="a18457219d775184695778f3e7a9e83f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18457219d775184695778f3e7a9e83f5">&#9670;&nbsp;</a></span>PUSHOVERSERVER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PUSHOVERSERVER&#160;&#160;&#160;&quot;api.pushover.net&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00058">58</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<a id="a95ca12049f2b4fb72611c4967f135801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95ca12049f2b4fb72611c4967f135801">&#9670;&nbsp;</a></span>PUSHOVERTIMEOUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PUSHOVERTIMEOUT&#160;&#160;&#160;5000</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00057">57</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3e3b0edc476436d3429fa36baad62cec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e3b0edc476436d3429fa36baad62cec">&#9670;&nbsp;</a></span>Wait4Answer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wait4Answer </td>
<td>(</td>
<td class="paramtype">TSecureClient &amp;&#160;</td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>linetrigger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>expected_answer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>timeout</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00069">69</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="notifications__service_8cpp_a3e3b0edc476436d3429fa36baad62cec_cgraph.png" border="0" usemap="#notifications__service_8cpp_a3e3b0edc476436d3429fa36baad62cec_cgraph" alt=""/></div>
<map name="notifications__service_8cpp_a3e3b0edc476436d3429fa36baad62cec_cgraph" id="notifications__service_8cpp_a3e3b0edc476436d3429fa36baad62cec_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,104,32"/>
<area shape="rect" href="class_hal.html#ac1c708c12fe4e6de959021db039c80f1" title=" " alt="" coords="152,5,224,32"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a32dd437e2a800eba87cc012d7873535d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32dd437e2a800eba87cc012d7873535d">&#9670;&nbsp;</a></span>notificationsservice</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_notifications_service.html">NotificationsService</a> notificationsservice</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="notifications__service_8cpp_source.html#l00067">67</a> of file <a class="el" href="notifications__service_8cpp_source.html">notifications_service.cpp</a>.</p>
</div>
</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_26e324fd2d3b807b96644664d24a0768.html">esp3d</a></li><li class="navelem"><a class="el" href="dir_8d0579f238dc492a9f9393e76adf8153.html">src</a></li><li class="navelem"><a class="el" href="dir_2c1830491e0576ae3395f8c2f91c7d85.html">modules</a></li><li class="navelem"><a class="el" href="dir_a08713e997884f74a4e2cb68dc44cbb6.html">notifications</a></li><li class="navelem"><a class="el" href="notifications__service_8cpp.html">notifications_service.cpp</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>