uvw/request_8hpp_source.html
2023-05-22 11:13:58 +02:00

129 lines
12 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" lang="en-US">
<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.6"/>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">uvw<span id="projectnumber">&#160;3.1.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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 id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef UVW_REQUEST_INCLUDE_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define UVW_REQUEST_INCLUDE_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;type_traits&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;utility&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;uv.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;config.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;resource.hpp&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceuvw.html">uvw</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U, <span class="keyword">typename</span>... E&gt;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="classuvw_1_1request.html"> 19</a></span><span class="keyword">class </span><a class="code hl_class" href="classuvw_1_1request.html">request</a>: <span class="keyword">public</span> <a class="code hl_class" href="classuvw_1_1resource.html">resource</a>&lt;T, U, E...&gt; {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">static</span> <span class="keyword">auto</span> reserve(U *req) {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <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 id="l00023" name="l00023"></a><span class="lineno"> 23</span> ptr-&gt;self_reset();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordflow">return</span> ptr;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using </span><a class="code hl_class" href="classuvw_1_1resource.html">resource</a>&lt;T, U, E...&gt;::resource;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classuvw_1_1request.html#a797d174e440e302a5727161d76b8618d"> 42</a></span> <span class="keywordtype">int</span> <a class="code hl_function" href="classuvw_1_1request.html#a797d174e440e302a5727161d76b8618d">cancel</a>() {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordflow">return</span> uv_cancel(<span class="keyword">reinterpret_cast&lt;</span>uv_req_t *<span class="keyword">&gt;</span>(this-&gt;<a class="code hl_function" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a>()));</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classuvw_1_1request.html#a88400234f18c2f0b285695eab8e55d6c"> 50</a></span> std::size_t <a class="code hl_function" href="classuvw_1_1request.html#a88400234f18c2f0b285695eab8e55d6c">size</a>() const noexcept {</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">return</span> uv_req_size(<span class="keyword">reinterpret_cast&lt;</span><span class="keyword">const </span>uv_req_t *<span class="keyword">&gt;</span>(this-&gt;<a class="code hl_function" href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">raw</a>())-&gt;<a class="code hl_function" href="namespaceuvw.html#accb319301464a2946fc3cf88218fed01">type</a>);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> }</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>};</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>} <span class="comment">// namespace uvw</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#endif </span><span class="comment">// UVW_REQUEST_INCLUDE_H</span></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#l00019">request.hpp:19</a></div></div>
<div class="ttc" id="aclassuvw_1_1request_html_a797d174e440e302a5727161d76b8618d"><div class="ttname"><a href="classuvw_1_1request.html#a797d174e440e302a5727161d76b8618d">uvw::request::cancel</a></div><div class="ttdeci">int cancel()</div><div class="ttdoc">Cancels a pending request.</div><div class="ttdef"><b>Definition:</b> <a href="request_8hpp_source.html#l00042">request.hpp:42</a></div></div>
<div class="ttc" id="aclassuvw_1_1request_html_a88400234f18c2f0b285695eab8e55d6c"><div class="ttname"><a href="classuvw_1_1request.html#a88400234f18c2f0b285695eab8e55d6c">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#l00050">request.hpp:50</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#l00018">resource.hpp:18</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_1uv__type_html_a06a6cb7ebde27aa348e340b76e49c6ae"><div class="ttname"><a href="structuvw_1_1uv__type.html#a06a6cb7ebde27aa348e340b76e49c6ae">uvw::uv_type::raw</a></div><div class="ttdeci">const U * raw() const noexcept</div><div class="ttdoc">Gets the underlying raw data structure.</div><div class="ttdef"><b>Definition:</b> <a href="uv__type_8hpp_source.html#l00059">uv_type.hpp:59</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.6
</small></address>
</body>
</html>