blob: 4e5b32723bfe1da69b6af5e358e80734d3b07655 [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/iomgr/pollset_posix.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_3f1a464cbd6442b4d6b6ee306c9b0460.html">iomgr</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> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">pollset_posix.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="sync_8h_source.html">grpc/support/sync.h</a>&gt;</code><br/>
<code>#include &quot;<a class="el" href="pollset__kick__posix_8h_source.html">src/core/iomgr/pollset_kick_posix.h</a>&quot;</code><br/>
</div>
<p><a href="pollset__posix_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__pollset.html">grpc_pollset</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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__pollset__vtable.html">grpc_pollset_vtable</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: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>
<tr class="separator:a717ebde9fd8a72d07e06d2255ee7b50f"><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: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>
<tr class="separator:a93b9c2aef29b7ffe733779b8d4c32db1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a3651117ed8881e20c179f0c677c622ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a9b5fd5fc969bf6e0c45e5f49b1827bbd"><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: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>
<tr class="separator:add4b6bbce2371decdb574d68b15a81e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a84e9698eaa1ae735fc13d9faf7e073ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a1dcd57a12b81e4369bc4c6957ff3837e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:af74c66d9afaf90a2134f209dfb41f91b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a36baf579c30c8dba9a6c68f1f9dd979c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ab8e35054e04edb42c1e665ef6a896fc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ae03dc91376fc7bfb279e74a955782102"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<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>
<tr class="separator:aabee8316b743b1cc1673093989a7104a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a717ebde9fd8a72d07e06d2255ee7b50f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_POLLSET_MU</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">pollset</td><td>)</td>
<td>&#160;&#160;&#160;(&amp;(pollset)-&gt;mu)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a9b5fd5fc969bf6e0c45e5f49b1827bbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3651117ed8881e20c179f0c677c622ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a93b9c2aef29b7ffe733779b8d4c32db1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a36baf579c30c8dba9a6c68f1f9dd979c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_kick_drain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af74c66d9afaf90a2134f209dfb41f91b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_kick_read_fd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae03dc91376fc7bfb279e74a955782102"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_poll_become_multipoller </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> **&#160;</td>
<td class="paramname"><em>fds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>fd_count</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="ab8e35054e04edb42c1e665ef6a896fc0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int grpc_poll_deadline_to_millis_timeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
<td class="paramname"><em>deadline</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgpr__timespec.html">gpr_timespec</a>&#160;</td>
<td class="paramname"><em>now</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="add4b6bbce2371decdb574d68b15a81e8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_pollset_add_fd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> *&#160;</td>
<td class="paramname"><em>fd</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="a84e9698eaa1ae735fc13d9faf7e073ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_pollset_del_fd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structgrpc__fd.html">grpc_fd</a> *&#160;</td>
<td class="paramname"><em>fd</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="a1dcd57a12b81e4369bc4c6957ff3837e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_pollset_force_kick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__pollset.html">grpc_pollset</a> *&#160;</td>
<td class="paramname"><em>pollset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="aabee8316b743b1cc1673093989a7104a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="pollset__posix_8h.html#a9b5fd5fc969bf6e0c45e5f49b1827bbd">grpc_platform_become_multipoller_type</a> grpc_platform_become_multipoller</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>