class_grpc_1_1_base_stub.html 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570
  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\BaseStub 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_base_stub.html">BaseStub</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="#pub-static-methods">Static Public Member Functions</a> &#124;
  70. <a href="#pro-methods">Protected Member Functions</a> </div>
  71. <div class="headertitle">
  72. <div class="title">Grpc\BaseStub Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p>Base class for generated client stubs.
  76. <a href="class_grpc_1_1_base_stub.html#details">More...</a></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:a87b837ef58d4806ac090010b235bf6dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a87b837ef58d4806ac090010b235bf6dd">__construct</a> ($hostname, $opts, $channel=null)</td></tr>
  81. <tr class="separator:a87b837ef58d4806ac090010b235bf6dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ae2b85e451fac182cfc57b63c39d7e59a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#ae2b85e451fac182cfc57b63c39d7e59a">getTarget</a> ()</td></tr>
  83. <tr class="separator:ae2b85e451fac182cfc57b63c39d7e59a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a808c89a725b15d850fa2096cd6bd104d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a808c89a725b15d850fa2096cd6bd104d">getConnectivityState</a> ($try_to_connect=false)</td></tr>
  85. <tr class="separator:a808c89a725b15d850fa2096cd6bd104d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a78f84743a824f0eb3087dcb0fb8d0d41"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a78f84743a824f0eb3087dcb0fb8d0d41">waitForReady</a> ($timeout)</td></tr>
  87. <tr class="separator:a78f84743a824f0eb3087dcb0fb8d0d41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a13ca38aea857a61f57019228f0b6f2bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a13ca38aea857a61f57019228f0b6f2bc">close</a> ()</td></tr>
  89. <tr class="memdesc:a13ca38aea857a61f57019228f0b6f2bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the communication channel associated with this stub. <a href="class_grpc_1_1_base_stub.html#a13ca38aea857a61f57019228f0b6f2bc">More...</a><br /></td></tr>
  90. <tr class="separator:a13ca38aea857a61f57019228f0b6f2bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table><table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  93. Static Public Member Functions</h2></td></tr>
  94. <tr class="memitem:a35a01a2eeff8d1f90939c361729f2396"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a35a01a2eeff8d1f90939c361729f2396">getDefaultChannel</a> ($hostname, array $opts)</td></tr>
  95. <tr class="memdesc:a35a01a2eeff8d1f90939c361729f2396"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns the default <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>. <a href="class_grpc_1_1_base_stub.html#a35a01a2eeff8d1f90939c361729f2396">More...</a><br /></td></tr>
  96. <tr class="separator:a35a01a2eeff8d1f90939c361729f2396"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  99. Protected Member Functions</h2></td></tr>
  100. <tr class="memitem:a3a70a435fb6cbee2456386507a3a9533"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a3a70a435fb6cbee2456386507a3a9533">_simpleRequest</a> ( $method, $argument, $deserialize, array $metadata=[], array $options=[])</td></tr>
  101. <tr class="memdesc:a3a70a435fb6cbee2456386507a3a9533"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method that takes a single argument and has a single output. <a href="class_grpc_1_1_base_stub.html#a3a70a435fb6cbee2456386507a3a9533">More...</a><br /></td></tr>
  102. <tr class="separator:a3a70a435fb6cbee2456386507a3a9533"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:acc4e0f5775d36cbed3ebdebd0491835e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#acc4e0f5775d36cbed3ebdebd0491835e">_clientStreamRequest</a> ( $method, $deserialize, array $metadata=[], array $options=[])</td></tr>
  104. <tr class="memdesc:acc4e0f5775d36cbed3ebdebd0491835e"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method that takes a stream of arguments and has a single output. <a href="class_grpc_1_1_base_stub.html#acc4e0f5775d36cbed3ebdebd0491835e">More...</a><br /></td></tr>
  105. <tr class="separator:acc4e0f5775d36cbed3ebdebd0491835e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5e798fc84d42462dce6a8e38dcc005a3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a5e798fc84d42462dce6a8e38dcc005a3">_serverStreamRequest</a> ( $method, $argument, $deserialize, array $metadata=[], array $options=[])</td></tr>
  107. <tr class="memdesc:a5e798fc84d42462dce6a8e38dcc005a3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method that takes a single argument and returns a stream of responses. <a href="class_grpc_1_1_base_stub.html#a5e798fc84d42462dce6a8e38dcc005a3">More...</a><br /></td></tr>
  108. <tr class="separator:a5e798fc84d42462dce6a8e38dcc005a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a06273f329dc2e0086c61f6534288277b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a06273f329dc2e0086c61f6534288277b">_bidiRequest</a> ( $method, $deserialize, array $metadata=[], array $options=[])</td></tr>
  110. <tr class="memdesc:a06273f329dc2e0086c61f6534288277b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method with messages streaming in both directions. <a href="class_grpc_1_1_base_stub.html#a06273f329dc2e0086c61f6534288277b">More...</a><br /></td></tr>
  111. <tr class="separator:a06273f329dc2e0086c61f6534288277b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table>
  113. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  114. <div class="textblock"><p>Base class for generated client stubs. </p>
  115. <p>Stub methods are expected to call _simpleRequest or _streamRequest and return the result. </p>
  116. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  117. <a id="a87b837ef58d4806ac090010b235bf6dd"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#a87b837ef58d4806ac090010b235bf6dd">&#9670;&nbsp;</a></span>__construct()</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">Grpc\BaseStub::__construct </td>
  124. <td>(</td>
  125. <td class="paramtype">&#160;</td>
  126. <td class="paramname"><em>$hostname</em>, </td>
  127. </tr>
  128. <tr>
  129. <td class="paramkey"></td>
  130. <td></td>
  131. <td class="paramtype">&#160;</td>
  132. <td class="paramname"><em>$opts</em>, </td>
  133. </tr>
  134. <tr>
  135. <td class="paramkey"></td>
  136. <td></td>
  137. <td class="paramtype">&#160;</td>
  138. <td class="paramname"><em>$channel</em> = <code>null</code>&#160;</td>
  139. </tr>
  140. <tr>
  141. <td></td>
  142. <td>)</td>
  143. <td></td><td></td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <dl class="params"><dt>Parameters</dt><dd>
  148. <table class="params">
  149. <tr><td class="paramtype">string</td><td class="paramname">$hostname</td><td></td></tr>
  150. <tr><td class="paramtype">array</td><td class="paramname">$opts</td><td><ul>
  151. <li>'update_metadata': (optional) a callback function which takes in a metadata array, and returns an updated metadata array</li>
  152. <li>'grpc.primary_user_agent': (optional) a user-agent string </li>
  153. </ul>
  154. </td></tr>
  155. <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>&#160;|&#160;InterceptorChannel</td><td class="paramname">$channel</td><td>An already created <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> or InterceptorChannel object (optional) </td></tr>
  156. </table>
  157. </dd>
  158. </dl>
  159. </div>
  160. </div>
  161. <h2 class="groupheader">Member Function Documentation</h2>
  162. <a id="a06273f329dc2e0086c61f6534288277b"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#a06273f329dc2e0086c61f6534288277b">&#9670;&nbsp;</a></span>_bidiRequest()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">Grpc\BaseStub::_bidiRequest </td>
  172. <td>(</td>
  173. <td class="paramtype">&#160;</td>
  174. <td class="paramname"><em>$method</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">&#160;</td>
  180. <td class="paramname"><em>$deserialize</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">array&#160;</td>
  186. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  187. </tr>
  188. <tr>
  189. <td class="paramkey"></td>
  190. <td></td>
  191. <td class="paramtype">array&#160;</td>
  192. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  193. </tr>
  194. <tr>
  195. <td></td>
  196. <td>)</td>
  197. <td></td><td></td>
  198. </tr>
  199. </table>
  200. </td>
  201. <td class="mlabels-right">
  202. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method with messages streaming in both directions. </p>
  207. <dl class="params"><dt>Parameters</dt><dd>
  208. <table class="params">
  209. <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
  210. <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the responses </td></tr>
  211. <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
  212. <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
  213. </table>
  214. </dd>
  215. </dl>
  216. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_bidi_streaming_call.html" title="Represents an active call that allows for sending and receiving messages in streams in any order.">BidiStreamingCall</a> The active call object </dd></dl>
  217. </div>
  218. </div>
  219. <a id="acc4e0f5775d36cbed3ebdebd0491835e"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#acc4e0f5775d36cbed3ebdebd0491835e">&#9670;&nbsp;</a></span>_clientStreamRequest()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">Grpc\BaseStub::_clientStreamRequest </td>
  229. <td>(</td>
  230. <td class="paramtype">&#160;</td>
  231. <td class="paramname"><em>$method</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">&#160;</td>
  237. <td class="paramname"><em>$deserialize</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype">array&#160;</td>
  243. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  244. </tr>
  245. <tr>
  246. <td class="paramkey"></td>
  247. <td></td>
  248. <td class="paramtype">array&#160;</td>
  249. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  250. </tr>
  251. <tr>
  252. <td></td>
  253. <td>)</td>
  254. <td></td><td></td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method that takes a stream of arguments and has a single output. </p>
  264. <dl class="params"><dt>Parameters</dt><dd>
  265. <table class="params">
  266. <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
  267. <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the response </td></tr>
  268. <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
  269. <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
  270. </table>
  271. </dd>
  272. </dl>
  273. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_client_streaming_call.html" title="Represents an active call that sends a stream of messages and then gets a single response.">ClientStreamingCall</a> The active call object </dd></dl>
  274. </div>
  275. </div>
  276. <a id="a5e798fc84d42462dce6a8e38dcc005a3"></a>
  277. <h2 class="memtitle"><span class="permalink"><a href="#a5e798fc84d42462dce6a8e38dcc005a3">&#9670;&nbsp;</a></span>_serverStreamRequest()</h2>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="mlabels">
  281. <tr>
  282. <td class="mlabels-left">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">Grpc\BaseStub::_serverStreamRequest </td>
  286. <td>(</td>
  287. <td class="paramtype">&#160;</td>
  288. <td class="paramname"><em>$method</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype">&#160;</td>
  294. <td class="paramname"><em>$argument</em>, </td>
  295. </tr>
  296. <tr>
  297. <td class="paramkey"></td>
  298. <td></td>
  299. <td class="paramtype">&#160;</td>
  300. <td class="paramname"><em>$deserialize</em>, </td>
  301. </tr>
  302. <tr>
  303. <td class="paramkey"></td>
  304. <td></td>
  305. <td class="paramtype">array&#160;</td>
  306. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">array&#160;</td>
  312. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  313. </tr>
  314. <tr>
  315. <td></td>
  316. <td>)</td>
  317. <td></td><td></td>
  318. </tr>
  319. </table>
  320. </td>
  321. <td class="mlabels-right">
  322. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method that takes a single argument and returns a stream of responses. </p>
  327. <dl class="params"><dt>Parameters</dt><dd>
  328. <table class="params">
  329. <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
  330. <tr><td class="paramtype">mixed</td><td class="paramname">$argument</td><td>The argument to the method </td></tr>
  331. <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the responses </td></tr>
  332. <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
  333. <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_server_streaming_call.html" title="Represents an active call that sends a single message and then gets a stream of responses.">ServerStreamingCall</a> The active call object </dd></dl>
  338. </div>
  339. </div>
  340. <a id="a3a70a435fb6cbee2456386507a3a9533"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#a3a70a435fb6cbee2456386507a3a9533">&#9670;&nbsp;</a></span>_simpleRequest()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="mlabels">
  345. <tr>
  346. <td class="mlabels-left">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">Grpc\BaseStub::_simpleRequest </td>
  350. <td>(</td>
  351. <td class="paramtype">&#160;</td>
  352. <td class="paramname"><em>$method</em>, </td>
  353. </tr>
  354. <tr>
  355. <td class="paramkey"></td>
  356. <td></td>
  357. <td class="paramtype">&#160;</td>
  358. <td class="paramname"><em>$argument</em>, </td>
  359. </tr>
  360. <tr>
  361. <td class="paramkey"></td>
  362. <td></td>
  363. <td class="paramtype">&#160;</td>
  364. <td class="paramname"><em>$deserialize</em>, </td>
  365. </tr>
  366. <tr>
  367. <td class="paramkey"></td>
  368. <td></td>
  369. <td class="paramtype">array&#160;</td>
  370. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  371. </tr>
  372. <tr>
  373. <td class="paramkey"></td>
  374. <td></td>
  375. <td class="paramtype">array&#160;</td>
  376. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  377. </tr>
  378. <tr>
  379. <td></td>
  380. <td>)</td>
  381. <td></td><td></td>
  382. </tr>
  383. </table>
  384. </td>
  385. <td class="mlabels-right">
  386. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p><a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> a remote method that takes a single argument and has a single output. </p>
  391. <dl class="params"><dt>Parameters</dt><dd>
  392. <table class="params">
  393. <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
  394. <tr><td class="paramtype">mixed</td><td class="paramname">$argument</td><td>The argument to the method </td></tr>
  395. <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the response </td></tr>
  396. <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
  397. <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
  398. </table>
  399. </dd>
  400. </dl>
  401. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_unary_call.html" title="Represents an active call that sends a single message and then gets a single response.">UnaryCall</a> The active call object </dd></dl>
  402. </div>
  403. </div>
  404. <a id="a13ca38aea857a61f57019228f0b6f2bc"></a>
  405. <h2 class="memtitle"><span class="permalink"><a href="#a13ca38aea857a61f57019228f0b6f2bc">&#9670;&nbsp;</a></span>close()</h2>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <table class="memname">
  409. <tr>
  410. <td class="memname">Grpc\BaseStub::close </td>
  411. <td>(</td>
  412. <td class="paramname"></td><td>)</td>
  413. <td></td>
  414. </tr>
  415. </table>
  416. </div><div class="memdoc">
  417. <p>Close the communication channel associated with this stub. </p>
  418. </div>
  419. </div>
  420. <a id="a808c89a725b15d850fa2096cd6bd104d"></a>
  421. <h2 class="memtitle"><span class="permalink"><a href="#a808c89a725b15d850fa2096cd6bd104d">&#9670;&nbsp;</a></span>getConnectivityState()</h2>
  422. <div class="memitem">
  423. <div class="memproto">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">Grpc\BaseStub::getConnectivityState </td>
  427. <td>(</td>
  428. <td class="paramtype">&#160;</td>
  429. <td class="paramname"><em>$try_to_connect</em> = <code>false</code></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <dl class="params"><dt>Parameters</dt><dd>
  435. <table class="params">
  436. <tr><td class="paramtype">bool</td><td class="paramname">$try_to_connect</td><td>(optional)</td></tr>
  437. </table>
  438. </dd>
  439. </dl>
  440. <dl class="section return"><dt>Returns</dt><dd>int The grpc connectivity state </dd></dl>
  441. </div>
  442. </div>
  443. <a id="a35a01a2eeff8d1f90939c361729f2396"></a>
  444. <h2 class="memtitle"><span class="permalink"><a href="#a35a01a2eeff8d1f90939c361729f2396">&#9670;&nbsp;</a></span>getDefaultChannel()</h2>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="mlabels">
  448. <tr>
  449. <td class="mlabels-left">
  450. <table class="memname">
  451. <tr>
  452. <td class="memname">static Grpc\BaseStub::getDefaultChannel </td>
  453. <td>(</td>
  454. <td class="paramtype">&#160;</td>
  455. <td class="paramname"><em>$hostname</em>, </td>
  456. </tr>
  457. <tr>
  458. <td class="paramkey"></td>
  459. <td></td>
  460. <td class="paramtype">array&#160;</td>
  461. <td class="paramname"><em>$opts</em>&#160;</td>
  462. </tr>
  463. <tr>
  464. <td></td>
  465. <td>)</td>
  466. <td></td><td></td>
  467. </tr>
  468. </table>
  469. </td>
  470. <td class="mlabels-right">
  471. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  472. </tr>
  473. </table>
  474. </div><div class="memdoc">
  475. <p>Creates and returns the default <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>. </p>
  476. <dl class="params"><dt>Parameters</dt><dd>
  477. <table class="params">
  478. <tr><td class="paramtype">array</td><td class="paramname">$opts</td><td><a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> constructor options</td></tr>
  479. </table>
  480. </dd>
  481. </dl>
  482. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> The channel </dd></dl>
  483. </div>
  484. </div>
  485. <a id="ae2b85e451fac182cfc57b63c39d7e59a"></a>
  486. <h2 class="memtitle"><span class="permalink"><a href="#ae2b85e451fac182cfc57b63c39d7e59a">&#9670;&nbsp;</a></span>getTarget()</h2>
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">Grpc\BaseStub::getTarget </td>
  492. <td>(</td>
  493. <td class="paramname"></td><td>)</td>
  494. <td></td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <dl class="section return"><dt>Returns</dt><dd>string The URI of the endpoint </dd></dl>
  499. </div>
  500. </div>
  501. <a id="a78f84743a824f0eb3087dcb0fb8d0d41"></a>
  502. <h2 class="memtitle"><span class="permalink"><a href="#a78f84743a824f0eb3087dcb0fb8d0d41">&#9670;&nbsp;</a></span>waitForReady()</h2>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="memname">
  506. <tr>
  507. <td class="memname">Grpc\BaseStub::waitForReady </td>
  508. <td>(</td>
  509. <td class="paramtype">&#160;</td>
  510. <td class="paramname"><em>$timeout</em></td><td>)</td>
  511. <td></td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. <dl class="params"><dt>Parameters</dt><dd>
  516. <table class="params">
  517. <tr><td class="paramtype">int</td><td class="paramname">$timeout</td><td>in microseconds</td></tr>
  518. </table>
  519. </dd>
  520. </dl>
  521. <dl class="section return"><dt>Returns</dt><dd>bool true if channel is ready </dd></dl>
  522. <dl class="exception"><dt>Exceptions</dt><dd>
  523. <table class="exception">
  524. <tr><td class="paramname">Exception</td><td>if channel is in FATAL_ERROR state </td></tr>
  525. </table>
  526. </dd>
  527. </dl>
  528. </div>
  529. </div>
  530. <hr/>The documentation for this class was generated from the following file:<ul>
  531. <li>src/php/lib/Grpc/<a class="el" href="_base_stub_8php.html">BaseStub.php</a></li>
  532. </ul>
  533. </div><!-- contents -->
  534. <!-- start footer part -->
  535. <hr class="footer"/><address class="footer"><small>
  536. Generated on Wed Mar 3 2021 19:20:18 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
  537. <img class="footer" src="doxygen.png" alt="doxygen"/>
  538. </a> 1.8.17
  539. </small></address>
  540. </body>
  541. </html>