boost/redis
2
0
Fork 0
mirror of https://github.com/boostorg/redis.git synced 2026-01-19 04:42:09 +00:00
Code Issues Projects Releases Wiki Activity
Files
gh-pages
redis/group__sync.html
Marcelo Zimbres 9ea19dd5dc v1.0.0
2022-08-21 13:08:26 +02:00

326 lines
16 KiB
HTML
Raw Permalink Blame History

<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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>Aedis: Synchronous functions</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="aedis.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 bgcolor="#346295" cellspacing="0" cellpadding="6">
<tbody>
<tr>
<td valign="middle" style="color: #FFFFFF" nowrap="nowrap"><font size="6">Aedis 0.3.0</font> &#160; <br> High level Redis client </td>
<td style="width:100%"> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</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>
</div><!-- top -->
<!-- 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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Synchronous functions</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae67e66eea857a5457d7a0e2c0bc832dd"><td class="memTemplParams" colspan="2">template&lt;class Connection , class ResponseAdapter &gt; </td></tr>
<tr class="memitem:gae67e66eea857a5457d7a0e2c0bc832dd"><td class="memTemplItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__sync.html#gae67e66eea857a5457d7a0e2c0bc832dd">aedis::experimental::exec</a> (Connection &amp;conn, <a class="el" href="classaedis_1_1resp3_1_1request.html">resp3::request</a> const &amp;req, ResponseAdapter adapter, boost::system::error_code &amp;ec)</td></tr>
<tr class="memdesc:gae67e66eea857a5457d7a0e2c0bc832dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes a command. <a href="group__sync.html#gae67e66eea857a5457d7a0e2c0bc832dd">More...</a><br /></td></tr>
<tr class="separator:gae67e66eea857a5457d7a0e2c0bc832dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ad4c13154f198cc6bdf4b33ec244827"><td class="memTemplParams" colspan="2">template&lt;class Connection , class ResponseAdapter = aedis::detail::response_traits&lt;void&gt;::adapter_type&gt; </td></tr>
<tr class="memitem:ga9ad4c13154f198cc6bdf4b33ec244827"><td class="memTemplItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__sync.html#ga9ad4c13154f198cc6bdf4b33ec244827">aedis::experimental::exec</a> (Connection &amp;conn, <a class="el" href="classaedis_1_1resp3_1_1request.html">resp3::request</a> const &amp;req, ResponseAdapter adapter=aedis::adapt())</td></tr>
<tr class="memdesc:ga9ad4c13154f198cc6bdf4b33ec244827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes a command. <a href="group__sync.html#ga9ad4c13154f198cc6bdf4b33ec244827">More...</a><br /></td></tr>
<tr class="separator:ga9ad4c13154f198cc6bdf4b33ec244827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa572f99b1f771e2c0d22827c7d28c96c"><td class="memTemplParams" colspan="2"><a id="gaa572f99b1f771e2c0d22827c7d28c96c"></a>
template&lt;class Connection &gt; </td></tr>
<tr class="memitem:gaa572f99b1f771e2c0d22827c7d28c96c"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__sync.html#gaa572f99b1f771e2c0d22827c7d28c96c">aedis::experimental::receive_event</a> (Connection &amp;conn)</td></tr>
<tr class="memdesc:gaa572f99b1f771e2c0d22827c7d28c96c"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO. <br /></td></tr>
<tr class="separator:gaa572f99b1f771e2c0d22827c7d28c96c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9c6c8c1b39d34a70519ef46dac57ddd"><td class="memTemplParams" colspan="2">template&lt;class Connection &gt; </td></tr>
<tr class="memitem:gaf9c6c8c1b39d34a70519ef46dac57ddd"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__sync.html#gaf9c6c8c1b39d34a70519ef46dac57ddd">aedis::experimental::receive_event</a> (Connection &amp;conn, boost::system::error_code &amp;ec)</td></tr>
<tr class="memdesc:gaf9c6c8c1b39d34a70519ef46dac57ddd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives events. <a href="group__sync.html#gaf9c6c8c1b39d34a70519ef46dac57ddd">More...</a><br /></td></tr>
<tr class="separator:gaf9c6c8c1b39d34a70519ef46dac57ddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76ddf0e456d852c47b94ba3f3e86dc22"><td class="memTemplParams" colspan="2">template&lt;class Connection , class ResponseAdapter &gt; </td></tr>
<tr class="memitem:ga76ddf0e456d852c47b94ba3f3e86dc22"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__sync.html#ga76ddf0e456d852c47b94ba3f3e86dc22">aedis::experimental::receive_push</a> (Connection &amp;conn, ResponseAdapter adapter, boost::system::error_code &amp;ec)</td></tr>
<tr class="memdesc:ga76ddf0e456d852c47b94ba3f3e86dc22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives server pushes synchronusly. <a href="group__sync.html#ga76ddf0e456d852c47b94ba3f3e86dc22">More...</a><br /></td></tr>
<tr class="separator:ga76ddf0e456d852c47b94ba3f3e86dc22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0d82e24f85bf081caa6dd90d168f669"><td class="memTemplParams" colspan="2"><a id="gab0d82e24f85bf081caa6dd90d168f669"></a>
template&lt;class Connection , class ResponseAdapter = aedis::detail::response_traits&lt;void&gt;::adapter_type&gt; </td></tr>
<tr class="memitem:gab0d82e24f85bf081caa6dd90d168f669"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__sync.html#gab0d82e24f85bf081caa6dd90d168f669">aedis::experimental::receive_push</a> (Connection &amp;conn, ResponseAdapter adapter=aedis::adapt())</td></tr>
<tr class="memdesc:gab0d82e24f85bf081caa6dd90d168f669"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO. <br /></td></tr>
<tr class="separator:gab0d82e24f85bf081caa6dd90d168f669"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Descriptions </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae67e66eea857a5457d7a0e2c0bc832dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae67e66eea857a5457d7a0e2c0bc832dd">&#9670;&nbsp;</a></span>exec() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Connection , class ResponseAdapter &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::size_t aedis::experimental::exec </td>
<td>(</td>
<td class="paramtype">Connection &amp;&#160;</td>
<td class="paramname"><em>conn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classaedis_1_1resp3_1_1request.html">resp3::request</a> const &amp;&#160;</td>
<td class="paramname"><em>req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ResponseAdapter&#160;</td>
<td class="paramname"><em>adapter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes a command. </p>
<p>This function will block until execution completes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conn</td><td>The connection. </td></tr>
<tr><td class="paramname">req</td><td>The request. </td></tr>
<tr><td class="paramname">adapter</td><td>The response adapter. </td></tr>
<tr><td class="paramname">ec</td><td>Error code in case of error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes of the response. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sync_8hpp_source.html#l00043">43</a> of file <a class="el" href="sync_8hpp_source.html">sync.hpp</a>.</p>
</div>
</div>
<a id="ga9ad4c13154f198cc6bdf4b33ec244827"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ad4c13154f198cc6bdf4b33ec244827">&#9670;&nbsp;</a></span>exec() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Connection , class ResponseAdapter = aedis::detail::response_traits&lt;void&gt;::adapter_type&gt; </div>
<table class="memname">
<tr>
<td class="memname">std::size_t aedis::experimental::exec </td>
<td>(</td>
<td class="paramtype">Connection &amp;&#160;</td>
<td class="paramname"><em>conn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classaedis_1_1resp3_1_1request.html">resp3::request</a> const &amp;&#160;</td>
<td class="paramname"><em>req</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ResponseAdapter&#160;</td>
<td class="paramname"><em>adapter</em> = <code>aedis::adapt()</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes a command. </p>
<p>This function will block until execution completes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conn</td><td>The connection. </td></tr>
<tr><td class="paramname">req</td><td>The request. </td></tr>
<tr><td class="paramname">adapter</td><td>The response adapter. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::system_error</td><td>in case of error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes of the response. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sync_8hpp_source.html#l00084">84</a> of file <a class="el" href="sync_8hpp_source.html">sync.hpp</a>.</p>
</div>
</div>
<a id="gaf9c6c8c1b39d34a70519ef46dac57ddd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9c6c8c1b39d34a70519ef46dac57ddd">&#9670;&nbsp;</a></span>receive_event()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Connection &gt; </div>
<table class="memname">
<tr>
<td class="memname">auto aedis::experimental::receive_event </td>
<td>(</td>
<td class="paramtype">Connection &amp;&#160;</td>
<td class="paramname"><em>conn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives events. </p>
<p>This function will block until execution completes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conn</td><td>The connection. </td></tr>
<tr><td class="paramname">ec</td><td>Error code in case of error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The event received. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sync_8hpp_source.html#l00158">158</a> of file <a class="el" href="sync_8hpp_source.html">sync.hpp</a>.</p>
</div>
</div>
<a id="ga76ddf0e456d852c47b94ba3f3e86dc22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga76ddf0e456d852c47b94ba3f3e86dc22">&#9670;&nbsp;</a></span>receive_push()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Connection , class ResponseAdapter &gt; </div>
<table class="memname">
<tr>
<td class="memname">auto aedis::experimental::receive_push </td>
<td>(</td>
<td class="paramtype">Connection &amp;&#160;</td>
<td class="paramname"><em>conn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ResponseAdapter&#160;</td>
<td class="paramname"><em>adapter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::system::error_code &amp;&#160;</td>
<td class="paramname"><em>ec</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives server pushes synchronusly. </p>
<p>This function will block until execution completes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">conn</td><td>The connection. </td></tr>
<tr><td class="paramname">adapter</td><td>The response adapter. </td></tr>
<tr><td class="paramname">ec</td><td>Error code in case of error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes of the response. </dd></dl>
<p class="definition">Definition at line <a class="el" href="sync_8hpp_source.html#l00106">106</a> of file <a class="el" href="sync_8hpp_source.html">sync.hpp</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<hr class="footer"/><address class="footer">
Author: Marcelo Zimbres Silva.
</address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink