Skip to content

Commit

Permalink
deploy: 56b94c4
Browse files Browse the repository at this point in the history
  • Loading branch information
cziter15 committed Jun 10, 2024
1 parent 95cf7da commit f60c969
Show file tree
Hide file tree
Showing 2 changed files with 3,939 additions and 3,946 deletions.
16 changes: 8 additions & 8 deletions ks_w_s_server_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,16 +139,16 @@
</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>}</div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html">ksf::misc::ksWSServer</a></div><div class="ttdoc">Wrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling.</div><div class="ttdef"><b>Definition</b> ksWSServer.h:30</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a2224ec4f425cd7938cd89880cb5ce771"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a2224ec4f425cd7938cd89880cb5ce771">ksf::misc::ksWSServer::~ksWSServer</a></div><div class="ttdeci">virtual ~ksWSServer()</div><div class="ttdoc">Destructs the server, releasing the resources.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:21</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a30264ac138648d3ee913519cec7c5920"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a30264ac138648d3ee913519cec7c5920">ksf::misc::ksWSServer::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">Starts the server.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:26</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a3807612909de8c2469cde02d7bcb3ab0"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a3807612909de8c2469cde02d7bcb3ab0">ksf::misc::ksWSServer::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Handles WebSocket server logic.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:59</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a450f4ebefd18543c646d577136774e72"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a450f4ebefd18543c646d577136774e72">ksf::misc::ksWSServer::ksWSServer</a></div><div class="ttdeci">ksWSServer(uint16_t port)</div><div class="ttdoc">Prepares ksWebServer on specified port without actually starting it.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:16</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a2224ec4f425cd7938cd89880cb5ce771"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a2224ec4f425cd7938cd89880cb5ce771">ksf::misc::ksWSServer::~ksWSServer</a></div><div class="ttdeci">virtual ~ksWSServer()</div><div class="ttdoc">Destructs the server, releasing the resources.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:22</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a30264ac138648d3ee913519cec7c5920"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a30264ac138648d3ee913519cec7c5920">ksf::misc::ksWSServer::begin</a></div><div class="ttdeci">void begin()</div><div class="ttdoc">Starts the server.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:27</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a3807612909de8c2469cde02d7bcb3ab0"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a3807612909de8c2469cde02d7bcb3ab0">ksf::misc::ksWSServer::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Handles WebSocket server logic.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:60</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a450f4ebefd18543c646d577136774e72"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a450f4ebefd18543c646d577136774e72">ksf::misc::ksWSServer::ksWSServer</a></div><div class="ttdeci">ksWSServer(uint16_t port)</div><div class="ttdoc">Prepares ksWebServer on specified port without actually starting it.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:17</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a507b6d18fbe0c211bec2bb593173d885"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a507b6d18fbe0c211bec2bb593173d885">ksf::misc::ksWSServer::onWebsocketTextMessage</a></div><div class="ttdeci">ksWsServerMessageFunc_t onWebsocketTextMessage</div><div class="ttdoc">Callback function to receive messages.</div><div class="ttdef"><b>Definition</b> ksWSServer.h:34</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a81b95552fd9f0e4c49d59259ca5be2f0"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a81b95552fd9f0e4c49d59259ca5be2f0">ksf::misc::ksWSServer::getRequiredAuthToken</a></div><div class="ttdeci">uint64_t getRequiredAuthToken() const</div><div class="ttdoc">Returns simple authentication token for WebSocket authentication process.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:82</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_a81b95552fd9f0e4c49d59259ca5be2f0"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#a81b95552fd9f0e4c49d59259ca5be2f0">ksf::misc::ksWSServer::getRequiredAuthToken</a></div><div class="ttdeci">uint64_t getRequiredAuthToken() const</div><div class="ttdoc">Returns simple authentication token for WebSocket authentication process.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:83</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_aa70db8c4e6820c660c1654807276b9c6"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#aa70db8c4e6820c660c1654807276b9c6">ksf::misc::ksWSServer::wsListener</a></div><div class="ttdeci">std::unique_ptr&lt; WiFiServer &gt; wsListener</div><div class="ttdoc">WS server (listener).</div><div class="ttdef"><b>Definition</b> ksWSServer.h:32</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_ab6465499a17fef0e369e9f0f5802ef13"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#ab6465499a17fef0e369e9f0f5802ef13">ksf::misc::ksWSServer::setMessageHandler</a></div><div class="ttdeci">void setMessageHandler(ksWsServerMessageFunc_t func)</div><div class="ttdoc">Installs a message handler to receive WebSocket text messages.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:77</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_ad15ba719689c843931612f3c9d41111b"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#ad15ba719689c843931612f3c9d41111b">ksf::misc::ksWSServer::handleNonWebsocketConnection</a></div><div class="ttdeci">void handleNonWebsocketConnection(WSclient_t *client) override</div><div class="ttdoc">Handler for non-WebSocket connections on websocket port.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:92</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_ad7c5303434271a77957a113dad7a2c37"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#ad7c5303434271a77957a113dad7a2c37">ksf::misc::ksWSServer::setRequiredAuthToken</a></div><div class="ttdeci">void setRequiredAuthToken(uint64_t authToken)</div><div class="ttdoc">Sets simple authtoken for WebSocket authentication.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:87</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_ab6465499a17fef0e369e9f0f5802ef13"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#ab6465499a17fef0e369e9f0f5802ef13">ksf::misc::ksWSServer::setMessageHandler</a></div><div class="ttdeci">void setMessageHandler(ksWsServerMessageFunc_t func)</div><div class="ttdoc">Installs a message handler to receive WebSocket text messages.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:78</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_ad15ba719689c843931612f3c9d41111b"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#ad15ba719689c843931612f3c9d41111b">ksf::misc::ksWSServer::handleNonWebsocketConnection</a></div><div class="ttdeci">void handleNonWebsocketConnection(WSclient_t *client) override</div><div class="ttdoc">Handler for non-WebSocket connections on websocket port.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:93</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_ad7c5303434271a77957a113dad7a2c37"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#ad7c5303434271a77957a113dad7a2c37">ksf::misc::ksWSServer::setRequiredAuthToken</a></div><div class="ttdeci">void setRequiredAuthToken(uint64_t authToken)</div><div class="ttdoc">Sets simple authtoken for WebSocket authentication.</div><div class="ttdef"><b>Definition</b> ksWSServer.cpp:88</div></div>
<div class="ttc" id="aclassksf_1_1misc_1_1ks_w_s_server_html_af459c67b491ce00347a590de9dcee044"><div class="ttname"><a href="classksf_1_1misc_1_1ks_w_s_server.html#af459c67b491ce00347a590de9dcee044">ksf::misc::ksWSServer::requriedAuthToken</a></div><div class="ttdeci">uint64_t requriedAuthToken</div><div class="ttdoc">WS auth token.</div><div class="ttdef"><b>Definition</b> ksWSServer.h:33</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit f60c969

Please sign in to comment.