blob: 7160d965a115366323457add330bf5e5dcc925a1 [file] [log] [blame]
<!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.8.6"/>
<title>GRPC Core: src/core/surface/completion_queue.h File Reference</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">GRPC Core
&#160;<span id="projectnumber">0.10.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
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.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></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_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_ea54cbef5e3ffa125df07262bbfc9627.html">surface</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">completion_queue.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="pollset_8h_source.html">src/core/iomgr/pollset.h</a>&quot;</code><br/>
<code>#include &lt;<a class="el" href="grpc_8h_source.html">grpc/grpc.h</a>&gt;</code><br/>
</div>
<p><a href="completion__queue_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:abb132fe2e37bc87bfcc83eb3cd8d3101"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#abb132fe2e37bc87bfcc83eb3cd8d3101">GRPC_CQ_INTERNAL_REF</a>(cc, reason)&#160;&#160;&#160;<a class="el" href="completion__queue_8c.html#acec06afc3d55de1701d5831e979dad02">grpc_cq_internal_ref</a>(cc)</td></tr>
<tr class="separator:abb132fe2e37bc87bfcc83eb3cd8d3101"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaceb3ef8959e5c43f6954c19a1975f63"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#aaceb3ef8959e5c43f6954c19a1975f63">GRPC_CQ_INTERNAL_UNREF</a>(cc, reason)&#160;&#160;&#160;<a class="el" href="completion__queue_8c.html#a0096a03d441f4b7cfbbe864eb122ed8e">grpc_cq_internal_unref</a>(cc)</td></tr>
<tr class="separator:aaceb3ef8959e5c43f6954c19a1975f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3695e8858dba0cab40f3becbf822e014"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#a3695e8858dba0cab40f3becbf822e014">grpc_cq_completion</a></td></tr>
<tr class="separator:a3695e8858dba0cab40f3becbf822e014"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:acec06afc3d55de1701d5831e979dad02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#acec06afc3d55de1701d5831e979dad02">grpc_cq_internal_ref</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:acec06afc3d55de1701d5831e979dad02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0096a03d441f4b7cfbbe864eb122ed8e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#a0096a03d441f4b7cfbbe864eb122ed8e">grpc_cq_internal_unref</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:a0096a03d441f4b7cfbbe864eb122ed8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0798635c22a4eaa66ed25c310b3a776"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#af0798635c22a4eaa66ed25c310b3a776">grpc_cq_begin_op</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:af0798635c22a4eaa66ed25c310b3a776"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2752dafd9e9e02bbd253578fc58b0a7e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#a2752dafd9e9e02bbd253578fc58b0a7e">grpc_cq_end_op</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc, void *tag, int success, void(*done)(void *done_arg, <a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> *storage), void *done_arg, <a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> *storage)</td></tr>
<tr class="separator:a2752dafd9e9e02bbd253578fc58b0a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ebca6cf60ce9cc92b9bfa9200fab813"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#a0ebca6cf60ce9cc92b9bfa9200fab813">grpc_cq_pollset</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:a0ebca6cf60ce9cc92b9bfa9200fab813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af56ef17bad0397c6f1305be433aeeb64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#af56ef17bad0397c6f1305be433aeeb64">grpc_cq_hack_spin_pollset</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:af56ef17bad0397c6f1305be433aeeb64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbe8f768af201e16309e240ae155ee3d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#afbe8f768af201e16309e240ae155ee3d">grpc_cq_mark_server_cq</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:afbe8f768af201e16309e240ae155ee3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02173d1bf8e55f6903d24c20107d8dbf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="completion__queue_8h.html#a02173d1bf8e55f6903d24c20107d8dbf">grpc_cq_is_server_cq</a> (<a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *cc)</td></tr>
<tr class="separator:a02173d1bf8e55f6903d24c20107d8dbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="abb132fe2e37bc87bfcc83eb3cd8d3101"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CQ_INTERNAL_REF</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cc, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">reason&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="completion__queue_8c.html#acec06afc3d55de1701d5831e979dad02">grpc_cq_internal_ref</a>(cc)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aaceb3ef8959e5c43f6954c19a1975f63"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_CQ_INTERNAL_UNREF</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">cc, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">reason&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="completion__queue_8c.html#a0096a03d441f4b7cfbbe864eb122ed8e">grpc_cq_internal_unref</a>(cc)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a3695e8858dba0cab40f3becbf822e014"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> <a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="af0798635c22a4eaa66ed25c310b3a776"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_cq_begin_op </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2752dafd9e9e02bbd253578fc58b0a7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_cq_end_op </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>success</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *done_arg, <a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> *storage)&#160;</td>
<td class="paramname"><em>done</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>done_arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> *&#160;</td>
<td class="paramname"><em>storage</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af56ef17bad0397c6f1305be433aeeb64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_cq_hack_spin_pollset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="acec06afc3d55de1701d5831e979dad02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_cq_internal_ref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0096a03d441f4b7cfbbe864eb122ed8e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_cq_internal_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a02173d1bf8e55f6903d24c20107d8dbf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_cq_is_server_cq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afbe8f768af201e16309e240ae155ee3d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_cq_mark_server_cq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0ebca6cf60ce9cc92b9bfa9200fab813"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a>* grpc_cq_pollset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__completion__queue.html">grpc_completion_queue</a> *&#160;</td>
<td class="paramname"><em>cc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>