grpc__posix_8h.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. <!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: include/grpc/grpc_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">4.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">
  36. var 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="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li class="current"><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="files.html"><span>File&#160;List</span></a></li>
  66. <li><a href="globals.html"><span>Globals</span></a></li>
  67. </ul>
  68. </div>
  69. <!-- window showing the filter options -->
  70. <div id="MSearchSelectWindow"
  71. onmouseover="return searchBox.OnSearchSelectShow()"
  72. onmouseout="return searchBox.OnSearchSelectHide()"
  73. onkeydown="return searchBox.OnSearchSelectKey(event)">
  74. <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>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  75. <!-- iframe showing the search results (closed by default) -->
  76. <div id="MSearchResultsWindow">
  77. <iframe src="javascript:void(0)" frameborder="0"
  78. name="MSearchResults" id="MSearchResults">
  79. </iframe>
  80. </div>
  81. <div id="nav-path" class="navpath">
  82. <ul>
  83. <li class="navelem"><a class="el" href="dir_bda73758a0a4d8c0ff603a7983866e1c.html">include</a></li><li class="navelem"><a class="el" href="dir_8ae8e534eeef321a81935092729b7078.html">grpc</a></li> </ul>
  84. </div>
  85. </div><!-- top -->
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#func-members">Functions</a> </div>
  89. <div class="headertitle">
  90. <div class="title">grpc_posix.h File Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <div class="textblock"><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc/impl/codegen/grpc_types.h</a>&gt;</code><br/>
  94. <code>#include &lt;<a class="el" href="support_2port__platform_8h_source.html">grpc/support/port_platform.h</a>&gt;</code><br/>
  95. <code>#include &lt;stddef.h&gt;</code><br/>
  96. </div>
  97. <p><a href="grpc__posix_8h_source.html">Go to the source code of this file.</a></p>
  98. <table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  100. Functions</h2></td></tr>
  101. <tr class="memitem:ae01dba904905ef6ad2298f4a85233a41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__types_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__posix_8h.html#ae01dba904905ef6ad2298f4a85233a41">grpc_insecure_channel_create_from_fd</a> (const char *target, int fd, const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *args)</td></tr>
  102. <tr class="memdesc:ae01dba904905ef6ad2298f4a85233a41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a client channel to 'target' using file descriptor 'fd'. <a href="#ae01dba904905ef6ad2298f4a85233a41">More...</a><br/></td></tr>
  103. <tr class="separator:ae01dba904905ef6ad2298f4a85233a41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a9a7bbbb272a485556cf84f96905b1c78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__posix_8h.html#a9a7bbbb272a485556cf84f96905b1c78">grpc_server_add_insecure_channel_from_fd</a> (<a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> *server, void *reserved, int fd)</td></tr>
  105. <tr class="memdesc:a9a7bbbb272a485556cf84f96905b1c78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the connected communication channel based on file descriptor 'fd' to the 'server'. <a href="#a9a7bbbb272a485556cf84f96905b1c78">More...</a><br/></td></tr>
  106. <tr class="separator:a9a7bbbb272a485556cf84f96905b1c78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a0dd4f6903c0919775d45189990067d14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grpc__posix_8h.html#a0dd4f6903c0919775d45189990067d14">grpc_use_signal</a> (int signum)</td></tr>
  108. <tr class="memdesc:a0dd4f6903c0919775d45189990067d14"><td class="mdescLeft">&#160;</td><td class="mdescRight">GRPC Core POSIX library may internally use signals to optimize some work. <a href="#a0dd4f6903c0919775d45189990067d14">More...</a><br/></td></tr>
  109. <tr class="separator:a0dd4f6903c0919775d45189990067d14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table>
  111. <h2 class="groupheader">Function Documentation</h2>
  112. <a class="anchor" id="ae01dba904905ef6ad2298f4a85233a41"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> <a class="el" href="grpc__types_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a>* grpc_insecure_channel_create_from_fd </td>
  118. <td>(</td>
  119. <td class="paramtype">const char *&#160;</td>
  120. <td class="paramname"><em>target</em>, </td>
  121. </tr>
  122. <tr>
  123. <td class="paramkey"></td>
  124. <td></td>
  125. <td class="paramtype">int&#160;</td>
  126. <td class="paramname"><em>fd</em>, </td>
  127. </tr>
  128. <tr>
  129. <td class="paramkey"></td>
  130. <td></td>
  131. <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
  132. <td class="paramname"><em>args</em>&#160;</td>
  133. </tr>
  134. <tr>
  135. <td></td>
  136. <td>)</td>
  137. <td></td><td></td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Create a client channel to 'target' using file descriptor 'fd'. </p>
  142. <p>The 'target' argument will be used to indicate the name for this channel. See the comment for grpc_insecure_channel_create for description of 'args' argument. </p>
  143. </div>
  144. </div>
  145. <a class="anchor" id="a9a7bbbb272a485556cf84f96905b1c78"></a>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_server_add_insecure_channel_from_fd </td>
  151. <td>(</td>
  152. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a2bbbaad8f7a806f6c834b68c5dd916d8">grpc_server</a> *&#160;</td>
  153. <td class="paramname"><em>server</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">void *&#160;</td>
  159. <td class="paramname"><em>reserved</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype">int&#160;</td>
  165. <td class="paramname"><em>fd</em>&#160;</td>
  166. </tr>
  167. <tr>
  168. <td></td>
  169. <td>)</td>
  170. <td></td><td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Add the connected communication channel based on file descriptor 'fd' to the 'server'. </p>
  175. <p>The 'fd' must be an open file descriptor corresponding to a connected socket. Events from the file descriptor may come on any of the server completion queues (i.e completion queues registered via the grpc_server_register_completion_queue API).</p>
  176. <p>The 'reserved' pointer MUST be NULL. </p>
  177. </div>
  178. </div>
  179. <a class="anchor" id="a0dd4f6903c0919775d45189990067d14"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname"><a class="el" href="impl_2codegen_2port__platform_8h.html#a2865c3b28ea7db75be4c725adb1edc7d">GRPCAPI</a> void grpc_use_signal </td>
  185. <td>(</td>
  186. <td class="paramtype">int&#160;</td>
  187. <td class="paramname"><em>signum</em></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>GRPC Core POSIX library may internally use signals to optimize some work. </p>
  193. <p>The library uses (SIGRTMIN + 6) signal by default. Use this API to instruct the library to use a different signal i.e 'signum' instead. Note:</p>
  194. <ul>
  195. <li>To prevent GRPC library from using any signals, pass a 'signum' of -1</li>
  196. <li>This API is optional but if called, it MUST be called before <a class="el" href="grpc_8h.html#a573aed8e200997856a227c7eb798a185" title="Initialize the grpc library. ">grpc_init()</a> </li>
  197. </ul>
  198. </div>
  199. </div>
  200. </div><!-- contents -->
  201. <!-- start footer part -->
  202. <hr class="footer"/><address class="footer"><small>
  203. Generated on Wed Jun 21 2017 14:13:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  204. <img class="footer" src="doxygen.png" alt="doxygen"/>
  205. </a> 1.8.6
  206. </small></address>
  207. </body>
  208. </html>