blob: 4e5b32723bfe1da69b6af5e358e80734d3b07655 [file] [log] [blame]
Craig Tiller68f4e0f2015-08-05 08:18:21 -07001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.6"/>
7<title>GRPC Core: src/core/iomgr/pollset_posix.h File Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="search/search.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="search/search.js"></script>
13<script type="text/javascript">
14 $(document).ready(function() { searchBox.OnSelectItem(0); });
15</script>
16<link href="doxygen.css" rel="stylesheet" type="text/css" />
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24 <td style="padding-left: 0.5em;">
25 <div id="projectname">GRPC Core
26 &#160;<span id="projectnumber">0.10.0.0</span>
27 </div>
28 </td>
29 </tr>
30 </tbody>
31</table>
32</div>
33<!-- end header part -->
34<!-- Generated by Doxygen 1.8.6 -->
35<script type="text/javascript">
36var searchBox = new SearchBox("searchBox", "search",false,'Search');
37</script>
38 <div id="navrow1" class="tabs">
39 <ul class="tablist">
40 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
41 <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
42 <li class="current"><a href="files.html"><span>Files</span></a></li>
43 <li>
44 <div id="MSearchBox" class="MSearchBoxInactive">
45 <span class="left">
46 <img id="MSearchSelect" src="search/mag_sel.png"
47 onmouseover="return searchBox.OnSearchSelectShow()"
48 onmouseout="return searchBox.OnSearchSelectHide()"
49 alt=""/>
50 <input type="text" id="MSearchField" value="Search" accesskey="S"
51 onfocus="searchBox.OnSearchFieldFocus(true)"
52 onblur="searchBox.OnSearchFieldFocus(false)"
53 onkeyup="searchBox.OnSearchFieldChange(event)"/>
54 </span><span class="right">
55 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
56 </span>
57 </div>
58 </li>
59 </ul>
60 </div>
61 <div id="navrow2" class="tabs2">
62 <ul class="tablist">
63 <li><a href="files.html"><span>File&#160;List</span></a></li>
64 <li><a href="globals.html"><span>Globals</span></a></li>
65 </ul>
66 </div>
67<!-- window showing the filter options -->
68<div id="MSearchSelectWindow"
69 onmouseover="return searchBox.OnSearchSelectShow()"
70 onmouseout="return searchBox.OnSearchSelectHide()"
71 onkeydown="return searchBox.OnSearchSelectKey(event)">
72<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>
73
74<!-- iframe showing the search results (closed by default) -->
75<div id="MSearchResultsWindow">
76<iframe src="javascript:void(0)" frameborder="0"
77 name="MSearchResults" id="MSearchResults">
78</iframe>
79</div>
80
81<div id="nav-path" class="navpath">
82 <ul>
83<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_3f1a464cbd6442b4d6b6ee306c9b0460.html">iomgr</a></li> </ul>
84</div>
85</div><!-- top -->
86<div class="header">
87 <div class="summary">
88<a href="#nested-classes">Data Structures</a> &#124;
89<a href="#define-members">Macros</a> &#124;
90<a href="#typedef-members">Typedefs</a> &#124;
91<a href="#func-members">Functions</a> &#124;
92<a href="#var-members">Variables</a> </div>
93 <div class="headertitle">
94<div class="title">pollset_posix.h File Reference</div> </div>
95</div><!--header-->
96<div class="contents">
97<div class="textblock"><code>#include &lt;<a class="el" href="sync_8h_source.html">grpc/support/sync.h</a>&gt;</code><br/>
98<code>#include &quot;<a class="el" href="pollset__kick__posix_8h_source.html">src/core/iomgr/pollset_kick_posix.h</a>&quot;</code><br/>
99</div>
100<p><a href="pollset__posix_8h_source.html">Go to the source code of this file.</a></p>
101<table class="memberdecls">
102<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
103Data Structures</h2></td></tr>
104<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a></td></tr>
105<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__pollset__vtable.html">grpc_pollset_vtable</a></td></tr>
107<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
108</table><table class="memberdecls">
109<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
110Macros</h2></td></tr>
111<tr class="memitem:a717ebde9fd8a72d07e06d2255ee7b50f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a717ebde9fd8a72d07e06d2255ee7b50f">GRPC_POLLSET_MU</a>(pollset)&#160;&#160;&#160;(&amp;(pollset)-&gt;mu)</td></tr>
112<tr class="separator:a717ebde9fd8a72d07e06d2255ee7b50f"><td class="memSeparator" colspan="2">&#160;</td></tr>
113</table><table class="memberdecls">
114<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
115Typedefs</h2></td></tr>
116<tr class="memitem:a93b9c2aef29b7ffe733779b8d4c32db1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__pollset__vtable.html">grpc_pollset_vtable</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a93b9c2aef29b7ffe733779b8d4c32db1">grpc_pollset_vtable</a></td></tr>
117<tr class="separator:a93b9c2aef29b7ffe733779b8d4c32db1"><td class="memSeparator" colspan="2">&#160;</td></tr>
118<tr class="memitem:a3651117ed8881e20c179f0c677c622ad"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__pollset.html">grpc_pollset</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a3651117ed8881e20c179f0c677c622ad">grpc_pollset</a></td></tr>
119<tr class="separator:a3651117ed8881e20c179f0c677c622ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
120<tr class="memitem:a9b5fd5fc969bf6e0c45e5f49b1827bbd"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a9b5fd5fc969bf6e0c45e5f49b1827bbd">grpc_platform_become_multipoller_type</a> )(<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset, struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> **fds, size_t fd_count)</td></tr>
121<tr class="separator:a9b5fd5fc969bf6e0c45e5f49b1827bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
122</table><table class="memberdecls">
123<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
124Functions</h2></td></tr>
125<tr class="memitem:add4b6bbce2371decdb574d68b15a81e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#add4b6bbce2371decdb574d68b15a81e8">grpc_pollset_add_fd</a> (<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset, struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> *fd)</td></tr>
126<tr class="separator:add4b6bbce2371decdb574d68b15a81e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:a84e9698eaa1ae735fc13d9faf7e073ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a84e9698eaa1ae735fc13d9faf7e073ea">grpc_pollset_del_fd</a> (<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset, struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> *fd)</td></tr>
128<tr class="separator:a84e9698eaa1ae735fc13d9faf7e073ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
129<tr class="memitem:a1dcd57a12b81e4369bc4c6957ff3837e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a1dcd57a12b81e4369bc4c6957ff3837e">grpc_pollset_force_kick</a> (<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset)</td></tr>
130<tr class="separator:a1dcd57a12b81e4369bc4c6957ff3837e"><td class="memSeparator" colspan="2">&#160;</td></tr>
131<tr class="memitem:af74c66d9afaf90a2134f209dfb41f91b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#af74c66d9afaf90a2134f209dfb41f91b">grpc_kick_read_fd</a> (<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *p)</td></tr>
132<tr class="separator:af74c66d9afaf90a2134f209dfb41f91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
133<tr class="memitem:a36baf579c30c8dba9a6c68f1f9dd979c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#a36baf579c30c8dba9a6c68f1f9dd979c">grpc_kick_drain</a> (<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *p)</td></tr>
134<tr class="separator:a36baf579c30c8dba9a6c68f1f9dd979c"><td class="memSeparator" colspan="2">&#160;</td></tr>
135<tr class="memitem:ab8e35054e04edb42c1e665ef6a896fc0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#ab8e35054e04edb42c1e665ef6a896fc0">grpc_poll_deadline_to_millis_timeout</a> (<a class="el" href="structgpr__timespec.html">gpr_timespec</a> deadline, <a class="el" href="structgpr__timespec.html">gpr_timespec</a> now)</td></tr>
136<tr class="separator:ab8e35054e04edb42c1e665ef6a896fc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<tr class="memitem:ae03dc91376fc7bfb279e74a955782102"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#ae03dc91376fc7bfb279e74a955782102">grpc_poll_become_multipoller</a> (<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset, struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> **fds, size_t fd_count)</td></tr>
138<tr class="separator:ae03dc91376fc7bfb279e74a955782102"><td class="memSeparator" colspan="2">&#160;</td></tr>
139</table><table class="memberdecls">
140<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
141Variables</h2></td></tr>
142<tr class="memitem:aabee8316b743b1cc1673093989a7104a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pollset__posix_8h.html#a9b5fd5fc969bf6e0c45e5f49b1827bbd">grpc_platform_become_multipoller_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pollset__posix_8h.html#aabee8316b743b1cc1673093989a7104a">grpc_platform_become_multipoller</a></td></tr>
143<tr class="separator:aabee8316b743b1cc1673093989a7104a"><td class="memSeparator" colspan="2">&#160;</td></tr>
144</table>
145<h2 class="groupheader">Macro Definition Documentation</h2>
146<a class="anchor" id="a717ebde9fd8a72d07e06d2255ee7b50f"></a>
147<div class="memitem">
148<div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname">#define GRPC_POLLSET_MU</td>
152 <td>(</td>
153 <td class="paramtype">&#160;</td>
154 <td class="paramname">pollset</td><td>)</td>
155 <td>&#160;&#160;&#160;(&amp;(pollset)-&gt;mu)</td>
156 </tr>
157 </table>
158</div><div class="memdoc">
159
160</div>
161</div>
162<h2 class="groupheader">Typedef Documentation</h2>
163<a class="anchor" id="a9b5fd5fc969bf6e0c45e5f49b1827bbd"></a>
164<div class="memitem">
165<div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">typedef void(* grpc_platform_become_multipoller_type)(<a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *pollset, struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> **fds, size_t fd_count)</td>
169 </tr>
170 </table>
171</div><div class="memdoc">
172
173</div>
174</div>
175<a class="anchor" id="a3651117ed8881e20c179f0c677c622ad"></a>
176<div class="memitem">
177<div class="memproto">
178 <table class="memname">
179 <tr>
180 <td class="memname">typedef struct <a class="el" href="structgrpc__pollset.html">grpc_pollset</a> <a class="el" href="structgrpc__pollset.html">grpc_pollset</a></td>
181 </tr>
182 </table>
183</div><div class="memdoc">
184
185</div>
186</div>
187<a class="anchor" id="a93b9c2aef29b7ffe733779b8d4c32db1"></a>
188<div class="memitem">
189<div class="memproto">
190 <table class="memname">
191 <tr>
192 <td class="memname">typedef struct <a class="el" href="structgrpc__pollset__vtable.html">grpc_pollset_vtable</a> <a class="el" href="structgrpc__pollset__vtable.html">grpc_pollset_vtable</a></td>
193 </tr>
194 </table>
195</div><div class="memdoc">
196
197</div>
198</div>
199<h2 class="groupheader">Function Documentation</h2>
200<a class="anchor" id="a36baf579c30c8dba9a6c68f1f9dd979c"></a>
201<div class="memitem">
202<div class="memproto">
203 <table class="memname">
204 <tr>
205 <td class="memname">void grpc_kick_drain </td>
206 <td>(</td>
207 <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
208 <td class="paramname"><em>p</em></td><td>)</td>
209 <td></td>
210 </tr>
211 </table>
212</div><div class="memdoc">
213
214</div>
215</div>
216<a class="anchor" id="af74c66d9afaf90a2134f209dfb41f91b"></a>
217<div class="memitem">
218<div class="memproto">
219 <table class="memname">
220 <tr>
221 <td class="memname">int grpc_kick_read_fd </td>
222 <td>(</td>
223 <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
224 <td class="paramname"><em>p</em></td><td>)</td>
225 <td></td>
226 </tr>
227 </table>
228</div><div class="memdoc">
229
230</div>
231</div>
232<a class="anchor" id="ae03dc91376fc7bfb279e74a955782102"></a>
233<div class="memitem">
234<div class="memproto">
235 <table class="memname">
236 <tr>
237 <td class="memname">void grpc_poll_become_multipoller </td>
238 <td>(</td>
239 <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
240 <td class="paramname"><em>pollset</em>, </td>
241 </tr>
242 <tr>
243 <td class="paramkey"></td>
244 <td></td>
245 <td class="paramtype">struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> **&#160;</td>
246 <td class="paramname"><em>fds</em>, </td>
247 </tr>
248 <tr>
249 <td class="paramkey"></td>
250 <td></td>
251 <td class="paramtype">size_t&#160;</td>
252 <td class="paramname"><em>fd_count</em>&#160;</td>
253 </tr>
254 <tr>
255 <td></td>
256 <td>)</td>
257 <td></td><td></td>
258 </tr>
259 </table>
260</div><div class="memdoc">
261
262</div>
263</div>
264<a class="anchor" id="ab8e35054e04edb42c1e665ef6a896fc0"></a>
265<div class="memitem">
266<div class="memproto">
267 <table class="memname">
268 <tr>
269 <td class="memname">int grpc_poll_deadline_to_millis_timeout </td>
270 <td>(</td>
271 <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
272 <td class="paramname"><em>deadline</em>, </td>
273 </tr>
274 <tr>
275 <td class="paramkey"></td>
276 <td></td>
277 <td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
278 <td class="paramname"><em>now</em>&#160;</td>
279 </tr>
280 <tr>
281 <td></td>
282 <td>)</td>
283 <td></td><td></td>
284 </tr>
285 </table>
286</div><div class="memdoc">
287
288</div>
289</div>
290<a class="anchor" id="add4b6bbce2371decdb574d68b15a81e8"></a>
291<div class="memitem">
292<div class="memproto">
293 <table class="memname">
294 <tr>
295 <td class="memname">void grpc_pollset_add_fd </td>
296 <td>(</td>
297 <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
298 <td class="paramname"><em>pollset</em>, </td>
299 </tr>
300 <tr>
301 <td class="paramkey"></td>
302 <td></td>
303 <td class="paramtype">struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> *&#160;</td>
304 <td class="paramname"><em>fd</em>&#160;</td>
305 </tr>
306 <tr>
307 <td></td>
308 <td>)</td>
309 <td></td><td></td>
310 </tr>
311 </table>
312</div><div class="memdoc">
313
314</div>
315</div>
316<a class="anchor" id="a84e9698eaa1ae735fc13d9faf7e073ea"></a>
317<div class="memitem">
318<div class="memproto">
319 <table class="memname">
320 <tr>
321 <td class="memname">void grpc_pollset_del_fd </td>
322 <td>(</td>
323 <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
324 <td class="paramname"><em>pollset</em>, </td>
325 </tr>
326 <tr>
327 <td class="paramkey"></td>
328 <td></td>
329 <td class="paramtype">struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> *&#160;</td>
330 <td class="paramname"><em>fd</em>&#160;</td>
331 </tr>
332 <tr>
333 <td></td>
334 <td>)</td>
335 <td></td><td></td>
336 </tr>
337 </table>
338</div><div class="memdoc">
339
340</div>
341</div>
342<a class="anchor" id="a1dcd57a12b81e4369bc4c6957ff3837e"></a>
343<div class="memitem">
344<div class="memproto">
345 <table class="memname">
346 <tr>
347 <td class="memname">void grpc_pollset_force_kick </td>
348 <td>(</td>
349 <td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
350 <td class="paramname"><em>pollset</em></td><td>)</td>
351 <td></td>
352 </tr>
353 </table>
354</div><div class="memdoc">
355
356</div>
357</div>
358<h2 class="groupheader">Variable Documentation</h2>
359<a class="anchor" id="aabee8316b743b1cc1673093989a7104a"></a>
360<div class="memitem">
361<div class="memproto">
362 <table class="memname">
363 <tr>
364 <td class="memname"><a class="el" href="pollset__posix_8h.html#a9b5fd5fc969bf6e0c45e5f49b1827bbd">grpc_platform_become_multipoller_type</a> grpc_platform_become_multipoller</td>
365 </tr>
366 </table>
367</div><div class="memdoc">
368
369</div>
370</div>
371</div><!-- contents -->
372<!-- start footer part -->
373<hr class="footer"/><address class="footer"><small>
374Generated on Wed Aug 5 2015 08:17:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
375<img class="footer" src="doxygen.png" alt="doxygen"/>
376</a> 1.8.6
377</small></address>
378</body>
379</html>