carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
							<!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
   &#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><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="#typedef-members">Typedefs</a> &#124;
<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 &#160;</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">&#160;</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">&#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:ad4037ad983dff2d616a6fb90158baad3"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</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">&#160;</td><td class="mdescRight">gRPC Callback definition.  <a href="#ad4037ad983dff2d616a6fb90158baad3">More...</a><br/></td></tr>
<tr class="separator:ad4037ad983dff2d616a6fb90158baad3"><td class="memSeparator" colspan="2">&#160;</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>&#160;</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">&#160;</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">&#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:ac8b4ae11b78ccbded903c14f69aa7a83"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a2e26e83c3a2591cbc127dbbc50f5c504"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Initializes the iomgr.  <a href="#a2e26e83c3a2591cbc127dbbc50f5c504">More...</a><br/></td></tr>
<tr class="separator:a2e26e83c3a2591cbc127dbbc50f5c504"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a466909d4101b063c991bbb39ee38ae25"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a95b724dc6bbd9b75694251713db00619"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a6a9f23f29a410d705af2c6b6d5c3917b"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</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">&#160;</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> *&#160;</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> *&#160;</td>
          <td class="paramname"><em>iocb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>success</em>&#160;</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> *&#160;</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>&#160;</td>
          <td class="paramname"><em>cb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>cb_arg</em>&#160;</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&#160;</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&#160;</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 Thu Sep 3 2015 09:44:13 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>