aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/ref/core.internal/html/structgrpc__completion__queue.html
blob: 732551c75537a7b5ff833450fa327d0427ba56e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<!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: grpc_completion_queue Struct 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.11.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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">grpc_completion_queue Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a484ad9fad34b51c8ab2e0f6a144e6d5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#a484ad9fad34b51c8ab2e0f6a144e6d5e">completed_head</a></td></tr>
<tr class="memdesc:a484ad9fad34b51c8ab2e0f6a144e6d5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">completed events  <a href="#a484ad9fad34b51c8ab2e0f6a144e6d5e">More...</a><br/></td></tr>
<tr class="separator:a484ad9fad34b51c8ab2e0f6a144e6d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82c067060ebf5ff91bc9ec961b414fa2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#a82c067060ebf5ff91bc9ec961b414fa2">completed_tail</a></td></tr>
<tr class="separator:a82c067060ebf5ff91bc9ec961b414fa2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a613cc61628fa742f363fb3125e8550db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__refcount.html">gpr_refcount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#a613cc61628fa742f363fb3125e8550db">pending_events</a></td></tr>
<tr class="memdesc:a613cc61628fa742f363fb3125e8550db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of pending events (+1 if we're not shutdown)  <a href="#a613cc61628fa742f363fb3125e8550db">More...</a><br/></td></tr>
<tr class="separator:a613cc61628fa742f363fb3125e8550db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae47cbaaca85ca3f9e7cb2317709f8e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__refcount.html">gpr_refcount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#aae47cbaaca85ca3f9e7cb2317709f8e6">owning_refs</a></td></tr>
<tr class="memdesc:aae47cbaaca85ca3f9e7cb2317709f8e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Once owning_refs drops to zero, we will destroy the cq.  <a href="#aae47cbaaca85ca3f9e7cb2317709f8e6">More...</a><br/></td></tr>
<tr class="separator:aae47cbaaca85ca3f9e7cb2317709f8e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea3ae4f771564833e6082e50c4ebbbdc"><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="structgrpc__completion__queue.html#aea3ae4f771564833e6082e50c4ebbbdc">pollset</a></td></tr>
<tr class="memdesc:aea3ae4f771564833e6082e50c4ebbbdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">the set of low level i/o things that concern this cq  <a href="#aea3ae4f771564833e6082e50c4ebbbdc">More...</a><br/></td></tr>
<tr class="separator:aea3ae4f771564833e6082e50c4ebbbdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d6f10502b79874124dc63169f4366d6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#a4d6f10502b79874124dc63169f4366d6">shutdown</a></td></tr>
<tr class="memdesc:a4d6f10502b79874124dc63169f4366d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">0 initially, 1 once we've begun shutting down  <a href="#a4d6f10502b79874124dc63169f4366d6">More...</a><br/></td></tr>
<tr class="separator:a4d6f10502b79874124dc63169f4366d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81ae0a3f77b40e2a21370e641e9f73e4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#a81ae0a3f77b40e2a21370e641e9f73e4">shutdown_called</a></td></tr>
<tr class="separator:a81ae0a3f77b40e2a21370e641e9f73e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a495f730490aa5625bb7ce2604ee8e6d7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#a495f730490aa5625bb7ce2604ee8e6d7">is_server_cq</a></td></tr>
<tr class="separator:a495f730490aa5625bb7ce2604ee8e6d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac25a7e4a6b32001d5f30abf698d7cfa6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#ac25a7e4a6b32001d5f30abf698d7cfa6">num_pluckers</a></td></tr>
<tr class="separator:ac25a7e4a6b32001d5f30abf698d7cfa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac421b4efba690c5cff76570781f13c87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structplucker.html">plucker</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__completion__queue.html#ac421b4efba690c5cff76570781f13c87">pluckers</a> [<a class="el" href="grpc_8h.html#a7fa47963513b9ce50ca4006b9db94c5e">GRPC_MAX_COMPLETION_QUEUE_PLUCKERS</a>]</td></tr>
<tr class="separator:ac421b4efba690c5cff76570781f13c87"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a484ad9fad34b51c8ab2e0f6a144e6d5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a> grpc_completion_queue::completed_head</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>completed events </p>

</div>
</div>
<a class="anchor" id="a82c067060ebf5ff91bc9ec961b414fa2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__cq__completion.html">grpc_cq_completion</a>* grpc_completion_queue::completed_tail</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a495f730490aa5625bb7ce2604ee8e6d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int grpc_completion_queue::is_server_cq</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ac25a7e4a6b32001d5f30abf698d7cfa6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int grpc_completion_queue::num_pluckers</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aae47cbaaca85ca3f9e7cb2317709f8e6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> grpc_completion_queue::owning_refs</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Once owning_refs drops to zero, we will destroy the cq. </p>

</div>
</div>
<a class="anchor" id="a613cc61628fa742f363fb3125e8550db"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgpr__refcount.html">gpr_refcount</a> grpc_completion_queue::pending_events</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of pending events (+1 if we're not shutdown) </p>

</div>
</div>
<a class="anchor" id="ac421b4efba690c5cff76570781f13c87"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structplucker.html">plucker</a> grpc_completion_queue::pluckers[<a class="el" href="grpc_8h.html#a7fa47963513b9ce50ca4006b9db94c5e">GRPC_MAX_COMPLETION_QUEUE_PLUCKERS</a>]</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aea3ae4f771564833e6082e50c4ebbbdc"></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_completion_queue::pollset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the set of low level i/o things that concern this cq </p>

</div>
</div>
<a class="anchor" id="a4d6f10502b79874124dc63169f4366d6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int grpc_completion_queue::shutdown</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>0 initially, 1 once we've begun shutting down </p>

</div>
</div>
<a class="anchor" id="a81ae0a3f77b40e2a21370e641e9f73e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int grpc_completion_queue::shutdown_called</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/core/surface/<a class="el" href="completion__queue_8c.html">completion_queue.c</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 3 2015 09:44:14 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>