Skip to content

Commit

Permalink
Deployed c8f4380 to 1.2.1 with MkDocs 1.6.1 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs committed Feb 4, 2025
1 parent 5d0dcdc commit 1afba40
Show file tree
Hide file tree
Showing 16 changed files with 2,177 additions and 2,209 deletions.
2 changes: 1 addition & 1 deletion 1.2.1/reference/app_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a479d0a674825fb289848dad8
<div class="line"> <span class="keywordflow">return</span> <span class="stringliteral">&quot;&lt;h1&gt;Hello, world!&lt;/h1&gt;&quot;</span>;</div>
<div class="line">});</div>
<div class="ttc" id="aapp_8h_html_a479d0a674825fb289848dad80379efc7"><div class="ttname"><a href="app_8h.html#a479d0a674825fb289848dad80379efc7">CROW_BP_ROUTE</a></div><div class="ttdeci">#define CROW_BP_ROUTE(blueprint, url)</div><div class="ttdoc">Creates a route for a blueprint using a rule.</div><div class="ttdef"><b>Definition</b> app.h:94</div></div>
<div class="ttc" id="aclasscrow_1_1_blueprint_html"><div class="ttname"><a href="classcrow_1_1_blueprint.html">crow::Blueprint</a></div><div class="ttdoc">A blueprint can be considered a smaller section of a Crow app, specifically where the router is conce...</div><div class="ttdef"><b>Definition</b> routing.h:1091</div></div>
<div class="ttc" id="aclasscrow_1_1_blueprint_html"><div class="ttname"><a href="classcrow_1_1_blueprint.html">crow::Blueprint</a></div><div class="ttdoc">A blueprint can be considered a smaller section of a Crow app, specifically where the router is conce...</div><div class="ttdef"><b>Definition</b> routing.h:1084</div></div>
</div><!-- fragment --><p>This is the recommended way to define routes in a crow blueprint because of its compile-time capabilities.</p>
<dl class="section see"><dt>See also</dt><dd><a href="https://crowcpp.org/master/guides/blueprints/">Page of the guide "Blueprints"</a>. </dd></dl>

Expand Down
6 changes: 3 additions & 3 deletions 1.2.1/reference/app_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -958,7 +958,7 @@
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno"> 782</span><span class="comment"> /// an Crow application that doesn&#39;t require of Middlewares</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno"><a class="line" href="namespacecrow.html#a3603179c9794548cac2c9990685178b4"> 783</a></span><span class="comment"></span> <span class="keyword">using </span><a class="code hl_class" href="classcrow_1_1_crow.html">SimpleApp</a> = <a class="code hl_class" href="classcrow_1_1_crow.html">Crow&lt;&gt;</a>;</div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno"> 784</span>} <span class="comment">// namespace crow</span></div>
<div class="ttc" id="aclasscrow_1_1_blueprint_html"><div class="ttname"><a href="classcrow_1_1_blueprint.html">crow::Blueprint</a></div><div class="ttdoc">A blueprint can be considered a smaller section of a Crow app, specifically where the router is conce...</div><div class="ttdef"><b>Definition</b> routing.h:1091</div></div>
<div class="ttc" id="aclasscrow_1_1_blueprint_html"><div class="ttname"><a href="classcrow_1_1_blueprint.html">crow::Blueprint</a></div><div class="ttdoc">A blueprint can be considered a smaller section of a Crow app, specifically where the router is conce...</div><div class="ttdef"><b>Definition</b> routing.h:1084</div></div>
<div class="ttc" id="aclasscrow_1_1_catchall_rule_html"><div class="ttname"><a href="classcrow_1_1_catchall_rule.html">crow::CatchallRule</a></div><div class="ttdef"><b>Definition</b> routing.h:339</div></div>
<div class="ttc" id="aclasscrow_1_1_crow_html"><div class="ttname"><a href="classcrow_1_1_crow.html">crow::Crow</a></div><div class="ttdoc">The main server application class.</div><div class="ttdef"><b>Definition</b> app.h:199</div></div>
<div class="ttc" id="aclasscrow_1_1_crow_html_a0266672657128919ab9a067d93f3868f"><div class="ttname"><a href="classcrow_1_1_crow.html#a0266672657128919ab9a067d93f3868f">crow::Crow::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stop the server.</div><div class="ttdef"><b>Definition</b> app.h:549</div></div>
Expand Down Expand Up @@ -999,8 +999,8 @@
<div class="ttc" id="aclasscrow_1_1_crow_html_af2a46207b71be452e8514146a83a9868"><div class="ttname"><a href="classcrow_1_1_crow.html#af2a46207b71be452e8514146a83a9868">crow::Crow::route</a></div><div class="ttdeci">auto route(const std::string &amp;rule) -&gt; typename std::invoke_result&lt; decltype(&amp;Router::new_rule_tagged&lt; Tag &gt;), Router, const std::string &amp; &gt;::type</div><div class="ttdoc">Create a route using a rule (Use CROW_ROUTE instead)</div><div class="ttdef"><b>Definition</b> app.h:257</div></div>
<div class="ttc" id="aclasscrow_1_1_crow_html_af35a53c39414aa79446690fea359e573"><div class="ttname"><a href="classcrow_1_1_crow.html#af35a53c39414aa79446690fea359e573">crow::Crow::stream_threshold</a></div><div class="ttdeci">size_t &amp; stream_threshold()</div><div class="ttdoc">Get the response body size (in bytes) beyond which Crow automatically streams responses.</div><div class="ttdef"><b>Definition</b> app.h:397</div></div>
<div class="ttc" id="aclasscrow_1_1_crow_html_afd29cf4e11557abfd7bce88b84af9b99"><div class="ttname"><a href="classcrow_1_1_crow.html#afd29cf4e11557abfd7bce88b84af9b99">crow::Crow::run_async</a></div><div class="ttdeci">std::future&lt; void &gt; run_async()</div><div class="ttdoc">Non-blocking version of run()</div><div class="ttdef"><b>Definition</b> app.h:541</div></div>
<div class="ttc" id="aclasscrow_1_1_dynamic_rule_html"><div class="ttname"><a href="classcrow_1_1_dynamic_rule.html">crow::DynamicRule</a></div><div class="ttdoc">A rule that can change its parameters during runtime.</div><div class="ttdef"><b>Definition</b> routing.h:568</div></div>
<div class="ttc" id="aclasscrow_1_1_router_html"><div class="ttname"><a href="classcrow_1_1_router.html">crow::Router</a></div><div class="ttdoc">Handles matching requests to existing rules and upgrade requests.</div><div class="ttdef"><b>Definition</b> routing.h:1245</div></div>
<div class="ttc" id="aclasscrow_1_1_dynamic_rule_html"><div class="ttname"><a href="classcrow_1_1_dynamic_rule.html">crow::DynamicRule</a></div><div class="ttdoc">A rule that can change its parameters during runtime.</div><div class="ttdef"><b>Definition</b> routing.h:561</div></div>
<div class="ttc" id="aclasscrow_1_1_router_html"><div class="ttname"><a href="classcrow_1_1_router.html">crow::Router</a></div><div class="ttdoc">Handles matching requests to existing rules and upgrade requests.</div><div class="ttdef"><b>Definition</b> routing.h:1238</div></div>
<div class="ttc" id="aclasscrow_1_1_server_html"><div class="ttname"><a href="classcrow_1_1_server.html">crow::Server</a></div><div class="ttdef"><b>Definition</b> http_server.h:43</div></div>
<div class="ttc" id="anamespacecrow_html"><div class="ttname"><a href="namespacecrow.html">crow</a></div><div class="ttdoc">The main namespace of the library. In this namespace is defined the most important classes and functi...</div></div>
<div class="ttc" id="astructcrow_1_1_s_s_l_adaptor_html"><div class="ttname"><a href="structcrow_1_1_s_s_l_adaptor.html">crow::SSLAdaptor</a></div><div class="ttdef"><b>Definition</b> socket_adaptors.h:107</div></div>
Expand Down
2 changes: 0 additions & 2 deletions 1.2.1/reference/classcrow_1_1_web_socket_rule-members.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,6 @@
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>max_payload_override_</b> (defined in <a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>message_handler_</b> (defined in <a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>methods_</b> (defined in <a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>mirror_protocols_</b> (defined in <a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>mirrorprotocols</b>(bool mirror_protocols=true) (defined in <a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>mw_indices_</b> (defined in <a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>name_</b> (defined in <a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>onaccept</b>(Func f) (defined in <a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a>)</td><td class="entry"><a class="el" href="classcrow_1_1_web_socket_rule.html">crow::WebSocketRule&lt; App &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
Expand Down
6 changes: 0 additions & 6 deletions 1.2.1/reference/classcrow_1_1_web_socket_rule.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,6 @@
template&lt;typename Func &gt; </td></tr>
<tr class="memitem:a28a36f9503ccafa4b60108dc4748b867"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classcrow_1_1_web_socket_rule.html">self_t</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>onaccept</b> (Func f)</td></tr>
<tr class="separator:a28a36f9503ccafa4b60108dc4748b867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88c782e8f7de236562799b314f88f28f" id="r_a88c782e8f7de236562799b314f88f28f"><td class="memItemLeft" align="right" valign="top"><a id="a88c782e8f7de236562799b314f88f28f" name="a88c782e8f7de236562799b314f88f28f"></a>
<a class="el" href="classcrow_1_1_web_socket_rule.html">self_t</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>mirrorprotocols</b> (bool mirror_protocols=true)</td></tr>
<tr class="separator:a88c782e8f7de236562799b314f88f28f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcrow_1_1_base_rule"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcrow_1_1_base_rule')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcrow_1_1_base_rule.html">crow::BaseRule</a></td></tr>
<tr class="memitem:ada4c61f94eb32ebbb5d553cacbc83013 inherit pub_methods_classcrow_1_1_base_rule" id="r_ada4c61f94eb32ebbb5d553cacbc83013"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>BaseRule</b> (std::string rule)</td></tr>
Expand Down Expand Up @@ -208,9 +205,6 @@
<tr class="memitem:a08de36976f908322a8ee86edb4a8ba23" id="r_a08de36976f908322a8ee86edb4a8ba23"><td class="memItemLeft" align="right" valign="top"><a id="a08de36976f908322a8ee86edb4a8ba23" name="a08de36976f908322a8ee86edb4a8ba23"></a>
std::function&lt; bool(const <a class="el" href="structcrow_1_1request.html">crow::request</a> &amp;, void **)&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>accept_handler_</b></td></tr>
<tr class="separator:a08de36976f908322a8ee86edb4a8ba23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d6477a52aa5f7db2ae94b747649e146" id="r_a3d6477a52aa5f7db2ae94b747649e146"><td class="memItemLeft" align="right" valign="top"><a id="a3d6477a52aa5f7db2ae94b747649e146" name="a3d6477a52aa5f7db2ae94b747649e146"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>mirror_protocols_</b> = false</td></tr>
<tr class="separator:a3d6477a52aa5f7db2ae94b747649e146"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ee993bdbed14eccd5232ba8cc472d52" id="r_a9ee993bdbed14eccd5232ba8cc472d52"><td class="memItemLeft" align="right" valign="top"><a id="a9ee993bdbed14eccd5232ba8cc472d52" name="a9ee993bdbed14eccd5232ba8cc472d52"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><b>max_payload_</b></td></tr>
<tr class="separator:a9ee993bdbed14eccd5232ba8cc472d52"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<tr class="even"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#a2fc995281b9452b56f743294baa7ed17">build_header</a>(int opcode, size_t size)</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#ad13e9b7b8a2a551056b34495cb334124">check_destroy</a>(websocket::CloseStatusCode code=CloseStatusCode::ClosedAbnormally)</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#a4fab99ae7f8e269480d5842cff1daf88">close</a>(std::string const &amp;msg, uint16_t status_code) override</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#aebaa108174ae0efc3c59c80c4552ba4d">Connection</a>(const crow::request &amp;req, Adaptor &amp;&amp;adaptor, Handler *handler, uint64_t max_payload, const std::vector&lt; std::string &gt; &amp;subprotocols, std::function&lt; void(crow::websocket::connection &amp;)&gt; open_handler, std::function&lt; void(crow::websocket::connection &amp;, const std::string &amp;, bool)&gt; message_handler, std::function&lt; void(crow::websocket::connection &amp;, const std::string &amp;, uint16_t)&gt; close_handler, std::function&lt; void(crow::websocket::connection &amp;, const std::string &amp;)&gt; error_handler, std::function&lt; bool(const crow::request &amp;, void **)&gt; accept_handler, bool mirror_protocols)</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#a12834b0aaac5b236a8784a1b131d1fa9">Connection</a>(const crow::request &amp;req, Adaptor &amp;&amp;adaptor, Handler *handler, uint64_t max_payload, const std::vector&lt; std::string &gt; &amp;subprotocols, std::function&lt; void(crow::websocket::connection &amp;)&gt; open_handler, std::function&lt; void(crow::websocket::connection &amp;, const std::string &amp;, bool)&gt; message_handler, std::function&lt; void(crow::websocket::connection &amp;, const std::string &amp;, uint16_t)&gt; close_handler, std::function&lt; void(crow::websocket::connection &amp;, const std::string &amp;)&gt; error_handler, std::function&lt; bool(const crow::request &amp;, void **)&gt; accept_handler)</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#a0d7758d7d22d74ee9ed17c8c7df0a380">dispatch</a>(CompletionHandler &amp;&amp;handler)</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#a1049d7689f068379e98954bfb04bee5c">do_read</a>()</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html#a787dde96965bf30d994bbc5fb3388281">do_write</a>()</td><td class="entry"><a class="el" href="classcrow_1_1websocket_1_1_connection.html">crow::websocket::Connection&lt; Adaptor, Handler &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
Expand Down
Loading

0 comments on commit 1afba40

Please sign in to comment.