133 lines
13 KiB
HTML
133 lines
13 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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ESP32/ESP8266 Firewall: Member List</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">ESP32/ESP8266 Firewall<span id="projectnumber"> 1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">a software firewall for ESP23 or ESP8266</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'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&dn=expat.txt MIT */
|
|
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('classfw_1_1_a_p_i.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">fw::API Member List</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This is the complete list of members for <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>, including all inherited members.</p>
|
|
<table class="directory">
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#aad90a1bfa8e00c4e25a091e5e9a61772">add_endpoint_to_list</a>(const String uri, const char *method, const char *description)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a033d5efd077dfad456cb6e6e7dd2baca">API</a>(Firewall *, const char *cert, const char *key, const char *username, const char *password, const String ip, const uint16_t port=8080)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>api_ip</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>api_port</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#adc9523a1b6e6a6e8f57a514a25c35b8c">check_auth</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#aa541a477e14a992b55e3f75351887cab">construct_json_api</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a175d139d29530e2946f67789c9652da8">construct_json_api_endpoint</a>(api_endpoint_t *api_ptr)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a682ec7e09a230507c39cbc7d7c7427d5">construct_json_firewall</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#ac249b6e7533414d0296bde477cecac1b">construct_json_firewall_rule</a>(firewall_rule_t *rule_ptr)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>credentials</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a592c2aa501ff920ebcc125f8d5635deb">delete_firewall_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>endpoint_head</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>firewall</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a734cbd9da536fb297da87b4310f20ba1">get_endpoint_list_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#ac76f5a6c9c28d71772b238a51b122e4a">get_firewall_rule_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#ab904f77fa777a1c8c19deb8e39cf89e8">get_firewall_rules_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#af5dc938ae5a274e3599d637e672b8d07">get_url_base</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a1892bc26b882b055853e26ed95d8d802">json_array_response</a>(String serialized_string, const uint16_t response_code)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#acbebab924241292706c0287dca5c3ff5">json_generic_response</a>(String serialized_string, const uint16_t response_code)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a6b7d4ce75b9cdba0dd39c6c949ef1c15">json_message_response</a>(String message, const uint16_t response_code)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a0ff5aeb3b916dae9219041dc240d9156">json_new_attribute</a>(String key, String value, bool last=false)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#aba378d97c999dda14ef2e4e97a9948f5">json_new_attribute</a>(String key, uint32_t value, bool last=false)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>json_response_type</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#aeb74e3b9efc2305c943683b14957ac9d">not_found_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a2d78e9dd43abb72da8872cb207db25e3">post_firewall_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a6ce4a9dd9afae493f6639b6fb3f6ba45">put_firewall_handler</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#abab79e90786d14836dcf113077891c50">request_has_all_firewall_parameter</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>server</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="even"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a45dcdd4969f70a7f1a02e49a47b16a1d">setup_auth</a>(const char *username, const char *password)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a90986dc50f303564e6f5af6d3707dd20">setup_routing</a>(const char *cert, const char *key)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>TAG</b> (defined in <a class="el" href="classfw_1_1_a_p_i.html">fw::API</a>)</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
|
|
<tr class="odd"><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html#a66ac0bd592bb08d069aea199668670ab">~API</a>()</td><td class="entry"><a class="el" href="classfw_1_1_a_p_i.html">fw::API</a></td><td class="entry"></td></tr>
|
|
</table></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|