mirror of
https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git
synced 2025-04-21 21:30:05 +08:00
184 lines
21 KiB
HTML
184 lines
21 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.h Source File</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
|
|
 <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&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&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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('notifications__service_8h_source.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="headertitle">
|
|
<div class="title">notifications_service.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="notifications__service_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> notifications_service.h - notifications service functions class</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2014 Luc Lebosse. All rights reserved.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> Lesser General Public License for more details.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> License along with this library; if not, write to the Free Software</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef _NOTIFICATIONS_SERVICE_H</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define _NOTIFICATIONS_SERVICE_H</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="class_notifications_service.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="class_notifications_service.html">NotificationsService</a></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="class_notifications_service.html#a89c8b42b0dc215e935ee18ef7e313139">NotificationsService</a>();</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="class_notifications_service.html#a951958a704169152131273910c64644d">~NotificationsService</a>();</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> <a class="code" href="class_notifications_service.html#aacc860a6d915ab772a6db24ce8ba0c35">begin</a>();</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">void</span> <a class="code" href="class_notifications_service.html#ad5f70d732b3faed49fc0b6655a6750c3">end</a>();</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> <a class="code" href="class_notifications_service.html#a8ce1b25d796c2a3620bbc5c407293c36">handle</a>();</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">bool</span> <a class="code" href="class_notifications_service.html#a7c67203100e4a0e67c13498a6f2a68db">sendMSG</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * title, <span class="keyword">const</span> <span class="keywordtype">char</span> * message);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> * <a class="code" href="class_notifications_service.html#a9c7b47610faf22f6119415f074f7e8e5">getTypeString</a>();</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordtype">bool</span> <a class="code" href="class_notifications_service.html#a7d914601a20d5e71ffae154f50cde07b">started</a>();</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="class_notifications_service.html#a0e7195f2d9bbcd06174fa4346d464fdb"> 38</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_notifications_service.html#a0e7195f2d9bbcd06174fa4346d464fdb">isAutonotification</a>()</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> _autonotification;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  };</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_notifications_service.html#a9cdc1066b9d09f8818207b65994ec3f6"> 42</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_notifications_service.html#a9cdc1066b9d09f8818207b65994ec3f6">setAutonotification</a>(<span class="keywordtype">bool</span> value)</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  _autonotification = value;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">bool</span> <a class="code" href="class_notifications_service.html#a76879e10d178ebb3b25685b98ef46713">sendAutoNotification</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> * msg);</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">bool</span> _started;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span> _autonotification;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  uint8_t _notificationType;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  String _token1;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  String _token2;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  String _settings;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  String _serveraddress;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  uint16_t _port;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">bool</span> sendPushoverMSG(<span class="keyword">const</span> <span class="keywordtype">char</span> * title, <span class="keyword">const</span> <span class="keywordtype">char</span> * message);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">bool</span> sendEmailMSG(<span class="keyword">const</span> <span class="keywordtype">char</span> * title, <span class="keyword">const</span> <span class="keywordtype">char</span> * message);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">bool</span> sendLineMSG(<span class="keyword">const</span> <span class="keywordtype">char</span> * title, <span class="keyword">const</span> <span class="keywordtype">char</span> * message);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">bool</span> getPortFromSettings();</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">bool</span> getServerAddressFromSettings();</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> getEmailFromSettings();</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> };</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">extern</span> <a class="code" href="class_notifications_service.html">NotificationsService</a> <a class="code" href="notifications__service_8h.html#a32dd437e2a800eba87cc012d7873535d">notificationsservice</a>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif //_NOTIFICATIONS_SERVICE_H</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclass_notifications_service_html_a76879e10d178ebb3b25685b98ef46713"><div class="ttname"><a href="class_notifications_service.html#a76879e10d178ebb3b25685b98ef46713">NotificationsService::sendAutoNotification</a></div><div class="ttdeci">bool sendAutoNotification(const char *msg)</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00098">notifications_service.cpp:98</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a0e7195f2d9bbcd06174fa4346d464fdb"><div class="ttname"><a href="class_notifications_service.html#a0e7195f2d9bbcd06174fa4346d464fdb">NotificationsService::isAutonotification</a></div><div class="ttdeci">bool isAutonotification()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8h_source.html#l00038">notifications_service.h:38</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_aacc860a6d915ab772a6db24ce8ba0c35"><div class="ttname"><a href="class_notifications_service.html#aacc860a6d915ab772a6db24ce8ba0c35">NotificationsService::begin</a></div><div class="ttdeci">bool begin()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00389">notifications_service.cpp:389</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a9cdc1066b9d09f8818207b65994ec3f6"><div class="ttname"><a href="class_notifications_service.html#a9cdc1066b9d09f8818207b65994ec3f6">NotificationsService::setAutonotification</a></div><div class="ttdeci">void setAutonotification(bool value)</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8h_source.html#l00042">notifications_service.h:42</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_ad5f70d732b3faed49fc0b6655a6750c3"><div class="ttname"><a href="class_notifications_service.html#ad5f70d732b3faed49fc0b6655a6750c3">NotificationsService::end</a></div><div class="ttdeci">void end()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00428">notifications_service.cpp:428</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a8ce1b25d796c2a3620bbc5c407293c36"><div class="ttname"><a href="class_notifications_service.html#a8ce1b25d796c2a3620bbc5c407293c36">NotificationsService::handle</a></div><div class="ttdeci">void handle()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00442">notifications_service.cpp:442</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a951958a704169152131273910c64644d"><div class="ttname"><a href="class_notifications_service.html#a951958a704169152131273910c64644d">NotificationsService::~NotificationsService</a></div><div class="ttdeci">~NotificationsService()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00127">notifications_service.cpp:127</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a9c7b47610faf22f6119415f074f7e8e5"><div class="ttname"><a href="class_notifications_service.html#a9c7b47610faf22f6119415f074f7e8e5">NotificationsService::getTypeString</a></div><div class="ttdeci">const char * getTypeString()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00137">notifications_service.cpp:137</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a89c8b42b0dc215e935ee18ef7e313139"><div class="ttname"><a href="class_notifications_service.html#a89c8b42b0dc215e935ee18ef7e313139">NotificationsService::NotificationsService</a></div><div class="ttdeci">NotificationsService()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00119">notifications_service.cpp:119</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a7d914601a20d5e71ffae154f50cde07b"><div class="ttname"><a href="class_notifications_service.html#a7d914601a20d5e71ffae154f50cde07b">NotificationsService::started</a></div><div class="ttdeci">bool started()</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00132">notifications_service.cpp:132</a></div></div>
|
|
<div class="ttc" id="anotifications__service_8h_html_a32dd437e2a800eba87cc012d7873535d"><div class="ttname"><a href="notifications__service_8h.html#a32dd437e2a800eba87cc012d7873535d">notificationsservice</a></div><div class="ttdeci">NotificationsService notificationsservice</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00067">notifications_service.cpp:67</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html_a7c67203100e4a0e67c13498a6f2a68db"><div class="ttname"><a href="class_notifications_service.html#a7c67203100e4a0e67c13498a6f2a68db">NotificationsService::sendMSG</a></div><div class="ttdeci">bool sendMSG(const char *title, const char *message)</div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8cpp_source.html#l00152">notifications_service.cpp:152</a></div></div>
|
|
<div class="ttc" id="aclass_notifications_service_html"><div class="ttname"><a href="class_notifications_service.html">NotificationsService</a></div><div class="ttdef"><b>Definition:</b> <a href="notifications__service_8h_source.html#l00027">notifications_service.h:27</a></div></div>
|
|
<!-- 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_8h.html">notifications_service.h</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>
|