class_grpc_1_1_unary_call.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  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\UnaryCall 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_unary_call.html">UnaryCall</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> </div>
  69. <div class="headertitle">
  70. <div class="title">Grpc\UnaryCall Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>Represents an active call that sends a single message and then gets a single response.
  74. <a href="class_grpc_1_1_unary_call.html#details">More...</a></p>
  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:a08ec57a768664dc428637bdf55742ca0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_unary_call.html#a08ec57a768664dc428637bdf55742ca0">start</a> ($data, array $metadata=[], array $options=[])</td></tr>
  79. <tr class="memdesc:a08ec57a768664dc428637bdf55742ca0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the call. <a href="class_grpc_1_1_unary_call.html#a08ec57a768664dc428637bdf55742ca0">More...</a><br /></td></tr>
  80. <tr class="separator:a08ec57a768664dc428637bdf55742ca0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a7947c58bacabc0267c79de33277440c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_unary_call.html#a7947c58bacabc0267c79de33277440c5">wait</a> ()</td></tr>
  82. <tr class="memdesc:a7947c58bacabc0267c79de33277440c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for the server to respond with data and a status. <a href="class_grpc_1_1_unary_call.html#a7947c58bacabc0267c79de33277440c5">More...</a><br /></td></tr>
  83. <tr class="separator:a7947c58bacabc0267c79de33277440c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ae65d18a70f9cee4505283b19d235360c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_unary_call.html#ae65d18a70f9cee4505283b19d235360c">getMetadata</a> ()</td></tr>
  85. <tr class="separator:ae65d18a70f9cee4505283b19d235360c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="inherit_header pub_methods_class_grpc_1_1_abstract_call"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_grpc_1_1_abstract_call')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_grpc_1_1_abstract_call.html">Grpc\AbstractCall</a></td></tr>
  87. <tr class="memitem:a98c8526df813acd6a775cf90a31af18e inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a98c8526df813acd6a775cf90a31af18e">__construct</a> (<a class="el" href="class_grpc_1_1_channel.html">Channel</a> $channel, $method, $deserialize, array $options=[])</td></tr>
  88. <tr class="memdesc:a98c8526df813acd6a775cf90a31af18e inherit pub_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> wrapper object. <a href="class_grpc_1_1_abstract_call.html#a98c8526df813acd6a775cf90a31af18e">More...</a><br /></td></tr>
  89. <tr class="separator:a98c8526df813acd6a775cf90a31af18e inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a8de5e451ba9a414d7a58a7d7c5fcc764 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a8de5e451ba9a414d7a58a7d7c5fcc764">getTrailingMetadata</a> ()</td></tr>
  91. <tr class="separator:a8de5e451ba9a414d7a58a7d7c5fcc764 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a188fc7298f9b52fb0eee7d3901281cdc inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a188fc7298f9b52fb0eee7d3901281cdc">getPeer</a> ()</td></tr>
  93. <tr class="separator:a188fc7298f9b52fb0eee7d3901281cdc inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a088115c12c3af171fe7e99078595d6c0 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a088115c12c3af171fe7e99078595d6c0">cancel</a> ()</td></tr>
  95. <tr class="memdesc:a088115c12c3af171fe7e99078595d6c0 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancels the call. <a href="class_grpc_1_1_abstract_call.html#a088115c12c3af171fe7e99078595d6c0">More...</a><br /></td></tr>
  96. <tr class="separator:a088115c12c3af171fe7e99078595d6c0 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a88c9af5ba3c7ede0dc5342363af5e9a2 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a88c9af5ba3c7ede0dc5342363af5e9a2">setCallCredentials</a> ($call_credentials)</td></tr>
  98. <tr class="memdesc:a88c9af5ba3c7ede0dc5342363af5e9a2 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the <a class="el" href="class_grpc_1_1_call_credentials.html" title="class CallCredentials">CallCredentials</a> for the underlying <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a>. <a href="class_grpc_1_1_abstract_call.html#a88c9af5ba3c7ede0dc5342363af5e9a2">More...</a><br /></td></tr>
  99. <tr class="separator:a88c9af5ba3c7ede0dc5342363af5e9a2 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table><table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  102. Additional Inherited Members</h2></td></tr>
  103. <tr class="inherit_header pro_methods_class_grpc_1_1_abstract_call"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_grpc_1_1_abstract_call')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_grpc_1_1_abstract_call.html">Grpc\AbstractCall</a></td></tr>
  104. <tr class="memitem:ac6b4a554e5be5fd57ee05610e25d4d05 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#ac6b4a554e5be5fd57ee05610e25d4d05">_serializeMessage</a> ($data)</td></tr>
  105. <tr class="memdesc:ac6b4a554e5be5fd57ee05610e25d4d05 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a message to the protobuf binary format. <a href="class_grpc_1_1_abstract_call.html#ac6b4a554e5be5fd57ee05610e25d4d05">More...</a><br /></td></tr>
  106. <tr class="separator:ac6b4a554e5be5fd57ee05610e25d4d05 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a413e87bcf0475cd8c627fd16919fda98 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a413e87bcf0475cd8c627fd16919fda98">_deserializeResponse</a> ($value)</td></tr>
  108. <tr class="memdesc:a413e87bcf0475cd8c627fd16919fda98 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserialize a response value to an object. <a href="class_grpc_1_1_abstract_call.html#a413e87bcf0475cd8c627fd16919fda98">More...</a><br /></td></tr>
  109. <tr class="separator:a413e87bcf0475cd8c627fd16919fda98 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="inherit_header pro_attribs_class_grpc_1_1_abstract_call"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_grpc_1_1_abstract_call')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_grpc_1_1_abstract_call.html">Grpc\AbstractCall</a></td></tr>
  111. <tr class="memitem:a722dd807b08d990d3f9816202627d701 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a722dd807b08d990d3f9816202627d701">$call</a></td></tr>
  112. <tr class="separator:a722dd807b08d990d3f9816202627d701 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:aa10e9fd56d64bc2167bb65129e212c9b inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#aa10e9fd56d64bc2167bb65129e212c9b">$deserialize</a></td></tr>
  114. <tr class="separator:aa10e9fd56d64bc2167bb65129e212c9b inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:aabc4e33a97415326e10596675f790328 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#aabc4e33a97415326e10596675f790328">$metadata</a></td></tr>
  116. <tr class="separator:aabc4e33a97415326e10596675f790328 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a35264eb899b5c6d320433741202924d2 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a35264eb899b5c6d320433741202924d2">$trailing_metadata</a></td></tr>
  118. <tr class="separator:a35264eb899b5c6d320433741202924d2 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table>
  120. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  121. <div class="textblock"><p>Represents an active call that sends a single message and then gets a single response. </p>
  122. </div><h2 class="groupheader">Member Function Documentation</h2>
  123. <a id="ae65d18a70f9cee4505283b19d235360c"></a>
  124. <h2 class="memtitle"><span class="permalink"><a href="#ae65d18a70f9cee4505283b19d235360c">&#9670;&nbsp;</a></span>getMetadata()</h2>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">Grpc\UnaryCall::getMetadata </td>
  130. <td>(</td>
  131. <td class="paramname"></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <dl class="section return"><dt>Returns</dt><dd>mixed The metadata sent by the server </dd></dl>
  137. <p>Reimplemented from <a class="el" href="class_grpc_1_1_abstract_call.html#ac5d4f130fc35450d4a5b0bfd0a918ff4">Grpc\AbstractCall</a>.</p>
  138. </div>
  139. </div>
  140. <a id="a08ec57a768664dc428637bdf55742ca0"></a>
  141. <h2 class="memtitle"><span class="permalink"><a href="#a08ec57a768664dc428637bdf55742ca0">&#9670;&nbsp;</a></span>start()</h2>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">Grpc\UnaryCall::start </td>
  147. <td>(</td>
  148. <td class="paramtype">&#160;</td>
  149. <td class="paramname"><em>$data</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">array&#160;</td>
  155. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  156. </tr>
  157. <tr>
  158. <td class="paramkey"></td>
  159. <td></td>
  160. <td class="paramtype">array&#160;</td>
  161. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  162. </tr>
  163. <tr>
  164. <td></td>
  165. <td>)</td>
  166. <td></td><td></td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. <p>Start the call. </p>
  171. <dl class="params"><dt>Parameters</dt><dd>
  172. <table class="params">
  173. <tr><td class="paramtype">mixed</td><td class="paramname">$data</td><td>The data to send </td></tr>
  174. <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>Metadata to send with the call, if applicable (optional) </td></tr>
  175. <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options, possible keys: 'flags' =&gt; a number (optional) </td></tr>
  176. </table>
  177. </dd>
  178. </dl>
  179. </div>
  180. </div>
  181. <a id="a7947c58bacabc0267c79de33277440c5"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#a7947c58bacabc0267c79de33277440c5">&#9670;&nbsp;</a></span>wait()</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">Grpc\UnaryCall::wait </td>
  188. <td>(</td>
  189. <td class="paramname"></td><td>)</td>
  190. <td></td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>Wait for the server to respond with data and a status. </p>
  195. <dl class="section return"><dt>Returns</dt><dd>array [response data, status] </dd></dl>
  196. </div>
  197. </div>
  198. <hr/>The documentation for this class was generated from the following file:<ul>
  199. <li>src/php/lib/Grpc/<a class="el" href="_unary_call_8php.html">UnaryCall.php</a></li>
  200. </ul>
  201. </div><!-- contents -->
  202. <!-- start footer part -->
  203. <hr class="footer"/><address class="footer"><small>
  204. Generated on Wed Mar 3 2021 19:20:18 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
  205. <img class="footer" src="doxygen.png" alt="doxygen"/>
  206. </a> 1.8.17
  207. </small></address>
  208. </body>
  209. </html>