class_grpc_1_1_interceptor.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  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\Interceptor 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_interceptor.html">Interceptor</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> </div>
  70. <div class="headertitle">
  71. <div class="title">Grpc\Interceptor Class Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Represents an interceptor that intercept RPC invocations before call starts.
  75. <a href="class_grpc_1_1_interceptor.html#details">More...</a></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:ad5be9dff122fb7deda65621de274267e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#ad5be9dff122fb7deda65621de274267e">interceptUnaryUnary</a> ( $method, $argument, $deserialize, $continuation, array $metadata=[], array $options=[])</td></tr>
  80. <tr class="separator:ad5be9dff122fb7deda65621de274267e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ab8a381279249e91313395a5ee174951f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#ab8a381279249e91313395a5ee174951f">interceptStreamUnary</a> ( $method, $deserialize, $continuation, array $metadata=[], array $options=[])</td></tr>
  82. <tr class="separator:ab8a381279249e91313395a5ee174951f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:afe75564510d738e1f0c01a0c103c9236"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#afe75564510d738e1f0c01a0c103c9236">interceptUnaryStream</a> ( $method, $argument, $deserialize, $continuation, array $metadata=[], array $options=[])</td></tr>
  84. <tr class="separator:afe75564510d738e1f0c01a0c103c9236"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a5ecd46cde9453e5654184a0b1a94de5e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#a5ecd46cde9453e5654184a0b1a94de5e">interceptStreamStream</a> ( $method, $deserialize, $continuation, array $metadata=[], array $options=[])</td></tr>
  86. <tr class="separator:a5ecd46cde9453e5654184a0b1a94de5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  89. Static Public Member Functions</h2></td></tr>
  90. <tr class="memitem:afcc5cdc7a13e5f36a8aed380a132f701"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#afcc5cdc7a13e5f36a8aed380a132f701">intercept</a> ($channel, $interceptors)</td></tr>
  91. <tr class="memdesc:afcc5cdc7a13e5f36a8aed380a132f701"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intercept the methods with <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>. <a href="class_grpc_1_1_interceptor.html#afcc5cdc7a13e5f36a8aed380a132f701">More...</a><br /></td></tr>
  92. <tr class="separator:afcc5cdc7a13e5f36a8aed380a132f701"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  95. <div class="textblock"><p>Represents an interceptor that intercept RPC invocations before call starts. </p>
  96. <p>There is one proposal related to the argument $deserialize under the review. The proposal link is <a href="https://github.com/grpc/proposal/pull/86">https://github.com/grpc/proposal/pull/86</a>. This is an EXPERIMENTAL API. </p>
  97. </div><h2 class="groupheader">Member Function Documentation</h2>
  98. <a id="afcc5cdc7a13e5f36a8aed380a132f701"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#afcc5cdc7a13e5f36a8aed380a132f701">&#9670;&nbsp;</a></span>intercept()</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="mlabels">
  103. <tr>
  104. <td class="mlabels-left">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">static Grpc\Interceptor::intercept </td>
  108. <td>(</td>
  109. <td class="paramtype">&#160;</td>
  110. <td class="paramname"><em>$channel</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype">&#160;</td>
  116. <td class="paramname"><em>$interceptors</em>&#160;</td>
  117. </tr>
  118. <tr>
  119. <td></td>
  120. <td>)</td>
  121. <td></td><td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Intercept the methods with <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>. </p>
  131. <dl class="params"><dt>Parameters</dt><dd>
  132. <table class="params">
  133. <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>
  134. <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_interceptor.html" title="Represents an interceptor that intercept RPC invocations before call starts.">Interceptor</a>&#160;|&#160;<a class="el" href="class_grpc_1_1_interceptor.html" title="Represents an interceptor that intercept RPC invocations before call starts.">Interceptor</a>[]</td><td class="paramname">$interceptors</td><td>interceptors to be added</td></tr>
  135. </table>
  136. </dd>
  137. </dl>
  138. <dl class="section return"><dt>Returns</dt><dd>InterceptorChannel </dd></dl>
  139. </div>
  140. </div>
  141. <a id="a5ecd46cde9453e5654184a0b1a94de5e"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#a5ecd46cde9453e5654184a0b1a94de5e">&#9670;&nbsp;</a></span>interceptStreamStream()</h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">Grpc\Interceptor::interceptStreamStream </td>
  148. <td>(</td>
  149. <td class="paramtype">&#160;</td>
  150. <td class="paramname"><em>$method</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">&#160;</td>
  156. <td class="paramname"><em>$deserialize</em>, </td>
  157. </tr>
  158. <tr>
  159. <td class="paramkey"></td>
  160. <td></td>
  161. <td class="paramtype">&#160;</td>
  162. <td class="paramname"><em>$continuation</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype">array&#160;</td>
  168. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  169. </tr>
  170. <tr>
  171. <td class="paramkey"></td>
  172. <td></td>
  173. <td class="paramtype">array&#160;</td>
  174. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  175. </tr>
  176. <tr>
  177. <td></td>
  178. <td>)</td>
  179. <td></td><td></td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. </div>
  184. </div>
  185. <a id="ab8a381279249e91313395a5ee174951f"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#ab8a381279249e91313395a5ee174951f">&#9670;&nbsp;</a></span>interceptStreamUnary()</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">Grpc\Interceptor::interceptStreamUnary </td>
  192. <td>(</td>
  193. <td class="paramtype">&#160;</td>
  194. <td class="paramname"><em>$method</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">&#160;</td>
  200. <td class="paramname"><em>$deserialize</em>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype">&#160;</td>
  206. <td class="paramname"><em>$continuation</em>, </td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey"></td>
  210. <td></td>
  211. <td class="paramtype">array&#160;</td>
  212. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">array&#160;</td>
  218. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. </div>
  228. </div>
  229. <a id="afe75564510d738e1f0c01a0c103c9236"></a>
  230. <h2 class="memtitle"><span class="permalink"><a href="#afe75564510d738e1f0c01a0c103c9236">&#9670;&nbsp;</a></span>interceptUnaryStream()</h2>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">Grpc\Interceptor::interceptUnaryStream </td>
  236. <td>(</td>
  237. <td class="paramtype">&#160;</td>
  238. <td class="paramname"><em>$method</em>, </td>
  239. </tr>
  240. <tr>
  241. <td class="paramkey"></td>
  242. <td></td>
  243. <td class="paramtype">&#160;</td>
  244. <td class="paramname"><em>$argument</em>, </td>
  245. </tr>
  246. <tr>
  247. <td class="paramkey"></td>
  248. <td></td>
  249. <td class="paramtype">&#160;</td>
  250. <td class="paramname"><em>$deserialize</em>, </td>
  251. </tr>
  252. <tr>
  253. <td class="paramkey"></td>
  254. <td></td>
  255. <td class="paramtype">&#160;</td>
  256. <td class="paramname"><em>$continuation</em>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype">array&#160;</td>
  262. <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>
  263. </tr>
  264. <tr>
  265. <td class="paramkey"></td>
  266. <td></td>
  267. <td class="paramtype">array&#160;</td>
  268. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  269. </tr>
  270. <tr>
  271. <td></td>
  272. <td>)</td>
  273. <td></td><td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. </div>
  278. </div>
  279. <a id="ad5be9dff122fb7deda65621de274267e"></a>
  280. <h2 class="memtitle"><span class="permalink"><a href="#ad5be9dff122fb7deda65621de274267e">&#9670;&nbsp;</a></span>interceptUnaryUnary()</h2>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">Grpc\Interceptor::interceptUnaryUnary </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">&#160;</td>
  306. <td class="paramname"><em>$continuation</em>, </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>$metadata</em> = <code>[]</code>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">array&#160;</td>
  318. <td class="paramname"><em>$options</em> = <code>[]</code>&#160;</td>
  319. </tr>
  320. <tr>
  321. <td></td>
  322. <td>)</td>
  323. <td></td><td></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. </div>
  328. </div>
  329. <hr/>The documentation for this class was generated from the following file:<ul>
  330. <li>src/php/lib/Grpc/<a class="el" href="_interceptor_8php.html">Interceptor.php</a></li>
  331. </ul>
  332. </div><!-- contents -->
  333. <!-- start footer part -->
  334. <hr class="footer"/><address class="footer"><small>
  335. Generated on Wed Mar 3 2021 19:20:18 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
  336. <img class="footer" src="doxygen.png" alt="doxygen"/>
  337. </a> 1.8.17
  338. </small></address>
  339. </body>
  340. </html>