uvw/request_8hpp_source.html
2022-03-10 13:48:56 +01:00

146 lines
14 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uvw: src/uvw/request.hpp 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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">uvw
&#160;<span id="projectnumber">2.12.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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: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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_98934c98f70735fe3a272005a9eb8736.html">uvw</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">request.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef UVW_REQUEST_INCLUDE_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define UVW_REQUEST_INCLUDE_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;uv.h&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;resource.hpp&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceuvw.html">uvw</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U&gt;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classuvw_1_1Request.html"> 18</a></span>&#160;<span class="keyword">class </span><a class="code" href="classuvw_1_1Request.html">Request</a>: <span class="keyword">public</span> <a class="code" href="classuvw_1_1Resource.html">Resource</a>&lt;T, U&gt; {</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">static</span> <span class="keyword">auto</span> reserve(U *req) {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">auto</span> ptr = <span class="keyword">static_cast&lt;</span>T *<span class="keyword">&gt;</span>(req-&gt;data)-&gt;shared_from_this();</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; ptr-&gt;reset();</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> ptr;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; }</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> E&gt;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> defaultCallback(U *req, <span class="keywordtype">int</span> status) {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">if</span>(<span class="keyword">auto</span> ptr = reserve(req); status) {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; ptr-&gt;publish(<a class="code" href="structuvw_1_1ErrorEvent.html">ErrorEvent</a>{status});</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; ptr-&gt;publish(E{});</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> F, <span class="keyword">typename</span>... Args&gt;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">auto</span> invoke(F &amp;&amp;f, Args &amp;&amp;...args) {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">if</span> constexpr(std::is_void_v&lt;std::invoke_result_t&lt;F, Args...&gt;&gt;) {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; std::forward&lt;F&gt;(f)(std::forward&lt;Args&gt;(args)...);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; this-&gt;leak();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span>(<span class="keyword">auto</span> err = std::forward&lt;F&gt;(f)(std::forward&lt;Args&gt;(args)...); err) {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classuvw_1_1Emitter.html">Emitter&lt;T&gt;::publish</a>(<a class="code" href="structuvw_1_1ErrorEvent.html">ErrorEvent</a>{err});</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; this-&gt;leak();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; }</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">using</span> <a class="code" href="classuvw_1_1Resource.html">Resource&lt;T, U&gt;::Resource</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classuvw_1_1Request.html#a27f8819a0dff5c3bec4812409884c398"> 65</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classuvw_1_1Request.html#a27f8819a0dff5c3bec4812409884c398">cancel</a>() {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">return</span> (0 == uv_cancel(this-&gt;<span class="keyword">template</span> get&lt;uv_req_t&gt;()));</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classuvw_1_1Request.html#a8eb66ee3f2602eb89367167fb08f73e6"> 73</a></span>&#160; std::size_t <a class="code" href="classuvw_1_1Request.html#a8eb66ee3f2602eb89367167fb08f73e6">size</a>() const noexcept {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordflow">return</span> uv_req_size(this-&gt;<span class="keyword">template</span> get&lt;uv_req_t&gt;()-&gt;<a class="code" href="namespaceuvw.html#accb319301464a2946fc3cf88218fed01">type</a>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; }</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;};</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;} <span class="comment">// namespace uvw</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// UVW_REQUEST_INCLUDE_H</span></div>
<div class="ttc" id="aclassuvw_1_1Emitter_html"><div class="ttname"><a href="classuvw_1_1Emitter.html">uvw::Emitter</a></div><div class="ttdoc">Event emitter base class.</div><div class="ttdef"><b>Definition:</b> <a href="emitter_8h_source.html#l00082">emitter.h:82</a></div></div>
<div class="ttc" id="aclassuvw_1_1Request_html"><div class="ttname"><a href="classuvw_1_1Request.html">uvw::Request</a></div><div class="ttdoc">Request base class.</div><div class="ttdef"><b>Definition:</b> <a href="request_8hpp_source.html#l00018">request.hpp:18</a></div></div>
<div class="ttc" id="aclassuvw_1_1Request_html_a27f8819a0dff5c3bec4812409884c398"><div class="ttname"><a href="classuvw_1_1Request.html#a27f8819a0dff5c3bec4812409884c398">uvw::Request::cancel</a></div><div class="ttdeci">bool cancel()</div><div class="ttdoc">Cancels a pending request.</div><div class="ttdef"><b>Definition:</b> <a href="request_8hpp_source.html#l00065">request.hpp:65</a></div></div>
<div class="ttc" id="aclassuvw_1_1Request_html_a8eb66ee3f2602eb89367167fb08f73e6"><div class="ttname"><a href="classuvw_1_1Request.html#a8eb66ee3f2602eb89367167fb08f73e6">uvw::Request::size</a></div><div class="ttdeci">std::size_t size() const noexcept</div><div class="ttdoc">Returns the size of the underlying request type.</div><div class="ttdef"><b>Definition:</b> <a href="request_8hpp_source.html#l00073">request.hpp:73</a></div></div>
<div class="ttc" id="aclassuvw_1_1Resource_html"><div class="ttname"><a href="classuvw_1_1Resource.html">uvw::Resource</a></div><div class="ttdoc">Common class for almost all the resources available in uvw.</div><div class="ttdef"><b>Definition:</b> <a href="resource_8hpp_source.html#l00017">resource.hpp:17</a></div></div>
<div class="ttc" id="anamespaceuvw_html"><div class="ttname"><a href="namespaceuvw.html">uvw</a></div><div class="ttdoc">uvw default namespace.</div><div class="ttdef"><b>Definition:</b> <a href="async_8h_source.html#l00008">async.h:8</a></div></div>
<div class="ttc" id="anamespaceuvw_html_accb319301464a2946fc3cf88218fed01"><div class="ttname"><a href="namespaceuvw.html#accb319301464a2946fc3cf88218fed01">uvw::type</a></div><div class="ttdeci">static constexpr std::uint32_t type() noexcept</div><div class="ttdoc">Returns a numerical identifier for a given type.</div><div class="ttdef"><b>Definition:</b> <a href="type__info_8hpp_source.html#l00053">type_info.hpp:53</a></div></div>
<div class="ttc" id="astructuvw_1_1ErrorEvent_html"><div class="ttname"><a href="structuvw_1_1ErrorEvent.html">uvw::ErrorEvent</a></div><div class="ttdoc">The ErrorEvent event.</div><div class="ttdef"><b>Definition:</b> <a href="emitter_8h_source.html#l00022">emitter.h:22</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>