| <!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/iomgr.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 |
|  <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 Page</span></a></li> |
| <li><a href="annotated.html"><span>Data 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 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">iomgr.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a href="iomgr_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A closure over a grpc_iomgr_cb_func. <a href="structgrpc__iomgr__closure.html#details">More...</a><br/></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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:ad4037ad983dff2d616a6fb90158baad3"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a> )(void *<a class="el" href="structarg.html">arg</a>, int success)</td></tr> |
| <tr class="memdesc:ad4037ad983dff2d616a6fb90158baad3"><td class="mdescLeft"> </td><td class="mdescRight">gRPC Callback definition. <a href="#ad4037ad983dff2d616a6fb90158baad3">More...</a><br/></td></tr> |
| <tr class="separator:ad4037ad983dff2d616a6fb90158baad3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab34430c3d713794f01b7d6114ad4db87"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#ab34430c3d713794f01b7d6114ad4db87">grpc_iomgr_closure</a></td></tr> |
| <tr class="memdesc:ab34430c3d713794f01b7d6114ad4db87"><td class="mdescLeft"> </td><td class="mdescRight">A closure over a grpc_iomgr_cb_func. <a href="#ab34430c3d713794f01b7d6114ad4db87">More...</a><br/></td></tr> |
| <tr class="separator:ab34430c3d713794f01b7d6114ad4db87"><td class="memSeparator" colspan="2"> </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:ac8b4ae11b78ccbded903c14f69aa7a83"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#ac8b4ae11b78ccbded903c14f69aa7a83">grpc_iomgr_closure_init</a> (<a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> *closure, <a class="el" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a> cb, void *cb_arg)</td></tr> |
| <tr class="memdesc:ac8b4ae11b78ccbded903c14f69aa7a83"><td class="mdescLeft"> </td><td class="mdescRight">Initializes <em>closure</em> with <em>cb</em> and <em>cb_arg</em>. <a href="#ac8b4ae11b78ccbded903c14f69aa7a83">More...</a><br/></td></tr> |
| <tr class="separator:ac8b4ae11b78ccbded903c14f69aa7a83"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2e26e83c3a2591cbc127dbbc50f5c504"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#a2e26e83c3a2591cbc127dbbc50f5c504">grpc_iomgr_init</a> (void)</td></tr> |
| <tr class="memdesc:a2e26e83c3a2591cbc127dbbc50f5c504"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the iomgr. <a href="#a2e26e83c3a2591cbc127dbbc50f5c504">More...</a><br/></td></tr> |
| <tr class="separator:a2e26e83c3a2591cbc127dbbc50f5c504"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a466909d4101b063c991bbb39ee38ae25"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#a466909d4101b063c991bbb39ee38ae25">grpc_iomgr_shutdown</a> (void)</td></tr> |
| <tr class="memdesc:a466909d4101b063c991bbb39ee38ae25"><td class="mdescLeft"> </td><td class="mdescRight">Signals the intention to shutdown the iomgr. <a href="#a466909d4101b063c991bbb39ee38ae25">More...</a><br/></td></tr> |
| <tr class="separator:a466909d4101b063c991bbb39ee38ae25"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a95b724dc6bbd9b75694251713db00619"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#a95b724dc6bbd9b75694251713db00619">grpc_iomgr_add_callback</a> (<a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> *closure)</td></tr> |
| <tr class="memdesc:a95b724dc6bbd9b75694251713db00619"><td class="mdescLeft"> </td><td class="mdescRight">Registers a closure to be invoked at some point in the future. <a href="#a95b724dc6bbd9b75694251713db00619">More...</a><br/></td></tr> |
| <tr class="separator:a95b724dc6bbd9b75694251713db00619"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6a9f23f29a410d705af2c6b6d5c3917b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iomgr_8h.html#a6a9f23f29a410d705af2c6b6d5c3917b">grpc_iomgr_add_delayed_callback</a> (<a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> *iocb, int success)</td></tr> |
| <tr class="memdesc:a6a9f23f29a410d705af2c6b6d5c3917b"><td class="mdescLeft"> </td><td class="mdescRight">As per grpc_iomgr_add_callback, with the ability to set the success argument. <a href="#a6a9f23f29a410d705af2c6b6d5c3917b">More...</a><br/></td></tr> |
| <tr class="separator:a6a9f23f29a410d705af2c6b6d5c3917b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Typedef Documentation</h2> |
| <a class="anchor" id="ad4037ad983dff2d616a6fb90158baad3"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef void(* grpc_iomgr_cb_func)(void *<a class="el" href="structarg.html">arg</a>, int success)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>gRPC Callback definition. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">arg</td><td>Arbitrary input. </td></tr> |
| <tr><td class="paramname">success</td><td>An indication on the state of the iomgr. On false, cleanup actions should be taken (eg, shutdown). </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab34430c3d713794f01b7d6114ad4db87"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef struct <a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> <a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A closure over a grpc_iomgr_cb_func. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a95b724dc6bbd9b75694251713db00619"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc_iomgr_add_callback </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> * </td> |
| <td class="paramname"><em>closure</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Registers a closure to be invoked at some point in the future. </p> |
| <p>Can be called from within a callback or from anywhere else </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a6a9f23f29a410d705af2c6b6d5c3917b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc_iomgr_add_delayed_callback </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> * </td> |
| <td class="paramname"><em>iocb</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>success</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>As per grpc_iomgr_add_callback, with the ability to set the success argument. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac8b4ae11b78ccbded903c14f69aa7a83"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc_iomgr_closure_init </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> * </td> |
| <td class="paramname"><em>closure</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="iomgr_8h.html#ad4037ad983dff2d616a6fb90158baad3">grpc_iomgr_cb_func</a> </td> |
| <td class="paramname"><em>cb</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>cb_arg</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes <em>closure</em> with <em>cb</em> and <em>cb_arg</em>. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2e26e83c3a2591cbc127dbbc50f5c504"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc_iomgr_init </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the iomgr. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a466909d4101b063c991bbb39ee38ae25"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void grpc_iomgr_shutdown </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signals the intention to shutdown the iomgr. </p> |
| |
| </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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |