class_grpc_1_1_rpc_server.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC PHP: Grpc\RpcServer Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC PHP
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="namespace_grpc.html">Grpc</a></li><li class="navelem"><a class="el" href="class_grpc_1_1_rpc_server.html">RpcServer</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> &#124;
  69. <a href="#pro-methods">Protected Member Functions</a> &#124;
  70. <a href="#pro-attribs">Protected Attributes</a> </div>
  71. <div class="headertitle">
  72. <div class="title">Grpc\RpcServer Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  77. Public Member Functions</h2></td></tr>
  78. <tr class="memitem:afaf6bebe4ae34481869eedfff7e9c573"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_rpc_server.html#afaf6bebe4ae34481869eedfff7e9c573">handle</a> ($service)</td></tr>
  79. <tr class="memdesc:afaf6bebe4ae34481869eedfff7e9c573"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a service to this server. <a href="class_grpc_1_1_rpc_server.html#afaf6bebe4ae34481869eedfff7e9c573">More...</a><br /></td></tr>
  80. <tr class="separator:afaf6bebe4ae34481869eedfff7e9c573"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a6376eda9f614e1c61715ebc0ae3ca746"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_rpc_server.html#a6376eda9f614e1c61715ebc0ae3ca746">run</a> ()</td></tr>
  82. <tr class="separator:a6376eda9f614e1c61715ebc0ae3ca746"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="inherit_header pub_methods_class_grpc_1_1_server"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_grpc_1_1_server')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_grpc_1_1_server.html">Grpc\Server</a></td></tr>
  84. <tr class="memitem:a109c078b8e6718a1ed777f60cb4bc958 inherit pub_methods_class_grpc_1_1_server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server.html#a109c078b8e6718a1ed777f60cb4bc958">__construct</a> ($args_array)</td></tr>
  85. <tr class="memdesc:a109c078b8e6718a1ed777f60cb4bc958 inherit pub_methods_class_grpc_1_1_server"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new instance of the <a class="el" href="class_grpc_1_1_server.html" title="class Server">Server</a> class. <a href="class_grpc_1_1_server.html#a109c078b8e6718a1ed777f60cb4bc958">More...</a><br /></td></tr>
  86. <tr class="separator:a109c078b8e6718a1ed777f60cb4bc958 inherit pub_methods_class_grpc_1_1_server"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a90ada396f37c675d70b43d4f96afe334 inherit pub_methods_class_grpc_1_1_server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server.html#a90ada396f37c675d70b43d4f96afe334">requestCall</a> ()</td></tr>
  88. <tr class="memdesc:a90ada396f37c675d70b43d4f96afe334 inherit pub_methods_class_grpc_1_1_server"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request a call on a server. <a href="class_grpc_1_1_server.html#a90ada396f37c675d70b43d4f96afe334">More...</a><br /></td></tr>
  89. <tr class="separator:a90ada396f37c675d70b43d4f96afe334 inherit pub_methods_class_grpc_1_1_server"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a5b20e4fe60663ff1cdb7e30f1995e31b inherit pub_methods_class_grpc_1_1_server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server.html#a5b20e4fe60663ff1cdb7e30f1995e31b">addHttp2Port</a> ($addr)</td></tr>
  91. <tr class="memdesc:a5b20e4fe60663ff1cdb7e30f1995e31b inherit pub_methods_class_grpc_1_1_server"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a http2 over tcp listener. <a href="class_grpc_1_1_server.html#a5b20e4fe60663ff1cdb7e30f1995e31b">More...</a><br /></td></tr>
  92. <tr class="separator:a5b20e4fe60663ff1cdb7e30f1995e31b inherit pub_methods_class_grpc_1_1_server"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a3b3120398662e298719de06716909dcd inherit pub_methods_class_grpc_1_1_server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server.html#a3b3120398662e298719de06716909dcd">addSecureHttp2Port</a> ($addr)</td></tr>
  94. <tr class="memdesc:a3b3120398662e298719de06716909dcd inherit pub_methods_class_grpc_1_1_server"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a secure http2 over tcp listener. <a href="class_grpc_1_1_server.html#a3b3120398662e298719de06716909dcd">More...</a><br /></td></tr>
  95. <tr class="separator:a3b3120398662e298719de06716909dcd inherit pub_methods_class_grpc_1_1_server"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a3c2935d3be77ea9902eaf2e20e3422b5 inherit pub_methods_class_grpc_1_1_server"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server.html#a3c2935d3be77ea9902eaf2e20e3422b5">start</a> ()</td></tr>
  97. <tr class="memdesc:a3c2935d3be77ea9902eaf2e20e3422b5 inherit pub_methods_class_grpc_1_1_server"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a server - tells all listeners to start listening. <a href="class_grpc_1_1_server.html#a3c2935d3be77ea9902eaf2e20e3422b5">More...</a><br /></td></tr>
  98. <tr class="separator:a3c2935d3be77ea9902eaf2e20e3422b5 inherit pub_methods_class_grpc_1_1_server"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  101. Protected Member Functions</h2></td></tr>
  102. <tr class="memitem:a0ac7dbf6a7d3b5512252605c1c9e2332"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_rpc_server.html#a0ac7dbf6a7d3b5512252605c1c9e2332">sendOkResponse</a> ($response)</td></tr>
  103. <tr class="separator:a0ac7dbf6a7d3b5512252605c1c9e2332"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table><table class="memberdecls">
  105. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  106. Protected Attributes</h2></td></tr>
  107. <tr class="memitem:a7ea2734edfe8b09681972bf5e5d7a6f0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_rpc_server.html#a7ea2734edfe8b09681972bf5e5d7a6f0">$call</a></td></tr>
  108. <tr class="separator:a7ea2734edfe8b09681972bf5e5d7a6f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a9c6119bd94888c4d6202a1205c296794"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_rpc_server.html#a9c6119bd94888c4d6202a1205c296794">$paths_map</a></td></tr>
  110. <tr class="separator:a9c6119bd94888c4d6202a1205c296794"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <h2 class="groupheader">Member Function Documentation</h2>
  113. <a id="afaf6bebe4ae34481869eedfff7e9c573"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#afaf6bebe4ae34481869eedfff7e9c573">&#9670;&nbsp;</a></span>handle()</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">Grpc\RpcServer::handle </td>
  120. <td>(</td>
  121. <td class="paramtype">&#160;</td>
  122. <td class="paramname"><em>$service</em></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </div><div class="memdoc">
  127. <p>Add a service to this server. </p>
  128. <dl class="params"><dt>Parameters</dt><dd>
  129. <table class="params">
  130. <tr><td class="paramtype">Object</td><td class="paramname">$service</td><td>The service to be added </td></tr>
  131. </table>
  132. </dd>
  133. </dl>
  134. </div>
  135. </div>
  136. <a id="a6376eda9f614e1c61715ebc0ae3ca746"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#a6376eda9f614e1c61715ebc0ae3ca746">&#9670;&nbsp;</a></span>run()</h2>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">Grpc\RpcServer::run </td>
  143. <td>(</td>
  144. <td class="paramname"></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. </div>
  150. </div>
  151. <a id="a0ac7dbf6a7d3b5512252605c1c9e2332"></a>
  152. <h2 class="memtitle"><span class="permalink"><a href="#a0ac7dbf6a7d3b5512252605c1c9e2332">&#9670;&nbsp;</a></span>sendOkResponse()</h2>
  153. <div class="memitem">
  154. <div class="memproto">
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">Grpc\RpcServer::sendOkResponse </td>
  161. <td>(</td>
  162. <td class="paramtype">&#160;</td>
  163. <td class="paramname"><em>$response</em></td><td>)</td>
  164. <td></td>
  165. </tr>
  166. </table>
  167. </td>
  168. <td class="mlabels-right">
  169. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. </div>
  174. </div>
  175. <h2 class="groupheader">Field Documentation</h2>
  176. <a id="a7ea2734edfe8b09681972bf5e5d7a6f0"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#a7ea2734edfe8b09681972bf5e5d7a6f0">&#9670;&nbsp;</a></span>$call</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">Grpc\RpcServer::$call</td>
  186. </tr>
  187. </table>
  188. </td>
  189. <td class="mlabels-right">
  190. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. </div>
  195. </div>
  196. <a id="a9c6119bd94888c4d6202a1205c296794"></a>
  197. <h2 class="memtitle"><span class="permalink"><a href="#a9c6119bd94888c4d6202a1205c296794">&#9670;&nbsp;</a></span>$paths_map</h2>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">Grpc\RpcServer::$paths_map</td>
  206. </tr>
  207. </table>
  208. </td>
  209. <td class="mlabels-right">
  210. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. </div>
  215. </div>
  216. <hr/>The documentation for this class was generated from the following file:<ul>
  217. <li>src/php/lib/Grpc/<a class="el" href="_rpc_server_8php.html">RpcServer.php</a></li>
  218. </ul>
  219. </div><!-- contents -->
  220. <!-- start footer part -->
  221. <hr class="footer"/><address class="footer"><small>
  222. Generated on Wed Mar 3 2021 19:20:18 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
  223. <img class="footer" src="doxygen.png" alt="doxygen"/>
  224. </a> 1.8.17
  225. </small></address>
  226. </body>
  227. </html>