| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=9"/><meta name="generator" content="Doxygen 1.8.17"/><meta name="viewport" content="width=device-width, initial-scale=1"/><title>GRPC PHP: Grpc\Interceptor Class Reference</title><link href="tabs.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="dynsections.js"></script><link href="search/search.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="search/searchdata.js"></script><script type="text/javascript" src="search/search.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css" /></head><body><div id="top"><!-- do not remove this div, it is closed by doxygen! --><div id="titlearea"><table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;">  <td id="projectalign" style="padding-left: 0.5em;">   <div id="projectname">GRPC PHP    <span id="projectnumber">1.31.0</span>   </div>  </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.17 --><script type="text/javascript">/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */var searchBox = new SearchBox("searchBox", "search",false,'Search');/* @license-end */</script><script type="text/javascript" src="menudata.js"></script><script type="text/javascript" src="menu.js"></script><script type="text/javascript">/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */$(function() {  initMenu('',true,false,'search.php','Search');  $(document).ready(function() { init_search(); });});/* @license-end */</script><div id="main-nav"></div><!-- window showing the filter options --><div id="MSearchSelectWindow"     onmouseover="return searchBox.OnSearchSelectShow()"     onmouseout="return searchBox.OnSearchSelectHide()"     onkeydown="return searchBox.OnSearchSelectKey(event)"></div><!-- iframe showing the search results (closed by default) --><div id="MSearchResultsWindow"><iframe src="javascript:void(0)" frameborder="0"         name="MSearchResults" id="MSearchResults"></iframe></div><div id="nav-path" class="navpath">  <ul><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></div></div><!-- top --><div class="header">  <div class="summary"><a href="#pub-methods">Public Member Functions</a> |<a href="#pub-static-methods">Static Public Member Functions</a>  </div>  <div class="headertitle"><div class="title">Grpc\Interceptor Class Reference</div>  </div></div><!--header--><div class="contents"><p>Represents an interceptor that intercept RPC invocations before call starts.   <a href="class_grpc_1_1_interceptor.html#details">More...</a></p><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>Public Member Functions</h2></td></tr><tr class="memitem:aec9c69861997289db3efd2abb5d0f58c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#aec9c69861997289db3efd2abb5d0f58c">interceptUnaryUnary</a> ( $method, $argument, $deserialize, array $metadata=[], array $options=[], $continuation)</td></tr><tr class="separator:aec9c69861997289db3efd2abb5d0f58c"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a795ddc43e1701df83b01731d7cbd6b04"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#a795ddc43e1701df83b01731d7cbd6b04">interceptStreamUnary</a> ( $method, $deserialize, array $metadata=[], array $options=[], $continuation)</td></tr><tr class="separator:a795ddc43e1701df83b01731d7cbd6b04"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a209c18987ef9abed720b658b803bb1cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#a209c18987ef9abed720b658b803bb1cb">interceptUnaryStream</a> ( $method, $argument, $deserialize, array $metadata=[], array $options=[], $continuation)</td></tr><tr class="separator:a209c18987ef9abed720b658b803bb1cb"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a4c6b68d9d0a4c7f26b838cee67de9fba"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#a4c6b68d9d0a4c7f26b838cee67de9fba">interceptStreamStream</a> ( $method, $deserialize, array $metadata=[], array $options=[], $continuation)</td></tr><tr class="separator:a4c6b68d9d0a4c7f26b838cee67de9fba"><td class="memSeparator" colspan="2"> </td></tr></table><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>Static Public Member Functions</h2></td></tr><tr class="memitem:afcc5cdc7a13e5f36a8aed380a132f701"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html#afcc5cdc7a13e5f36a8aed380a132f701">intercept</a> ($channel, $interceptors)</td></tr><tr class="memdesc:afcc5cdc7a13e5f36a8aed380a132f701"><td class="mdescLeft"> </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><tr class="separator:afcc5cdc7a13e5f36a8aed380a132f701"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>Represents an interceptor that intercept RPC invocations before call starts. </p><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></div><h2 class="groupheader">Member Function Documentation</h2><a id="afcc5cdc7a13e5f36a8aed380a132f701"></a><h2 class="memtitle"><span class="permalink"><a href="#afcc5cdc7a13e5f36a8aed380a132f701">◆ </a></span>intercept()</h2><div class="memitem"><div class="memproto"><table class="mlabels">  <tr>  <td class="mlabels-left">      <table class="memname">        <tr>          <td class="memname">static Grpc\Interceptor::intercept </td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname"><em>$channel</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$interceptors</em> </td>        </tr>        <tr>          <td></td>          <td>)</td>          <td></td><td></td>        </tr>      </table>  </td>  <td class="mlabels-right"><span class="mlabels"><span class="mlabel">static</span></span>  </td>  </tr></table></div><div class="memdoc"><p>Intercept the methods with <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>. </p><dl class="params"><dt>Parameters</dt><dd>  <table class="params">    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> | 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>    <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> | <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>  </table>  </dd></dl><dl class="section return"><dt>Returns</dt><dd>InterceptorChannel </dd></dl></div></div><a id="a4c6b68d9d0a4c7f26b838cee67de9fba"></a><h2 class="memtitle"><span class="permalink"><a href="#a4c6b68d9d0a4c7f26b838cee67de9fba">◆ </a></span>interceptStreamStream()</h2><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">Grpc\Interceptor::interceptStreamStream </td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname"><em>$method</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$deserialize</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$options</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$continuation</em> </td>        </tr>        <tr>          <td></td>          <td>)</td>          <td></td><td></td>        </tr>      </table></div><div class="memdoc"></div></div><a id="a795ddc43e1701df83b01731d7cbd6b04"></a><h2 class="memtitle"><span class="permalink"><a href="#a795ddc43e1701df83b01731d7cbd6b04">◆ </a></span>interceptStreamUnary()</h2><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">Grpc\Interceptor::interceptStreamUnary </td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname"><em>$method</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$deserialize</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$options</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$continuation</em> </td>        </tr>        <tr>          <td></td>          <td>)</td>          <td></td><td></td>        </tr>      </table></div><div class="memdoc"></div></div><a id="a209c18987ef9abed720b658b803bb1cb"></a><h2 class="memtitle"><span class="permalink"><a href="#a209c18987ef9abed720b658b803bb1cb">◆ </a></span>interceptUnaryStream()</h2><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">Grpc\Interceptor::interceptUnaryStream </td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname"><em>$method</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$argument</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$deserialize</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$options</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$continuation</em> </td>        </tr>        <tr>          <td></td>          <td>)</td>          <td></td><td></td>        </tr>      </table></div><div class="memdoc"></div></div><a id="aec9c69861997289db3efd2abb5d0f58c"></a><h2 class="memtitle"><span class="permalink"><a href="#aec9c69861997289db3efd2abb5d0f58c">◆ </a></span>interceptUnaryUnary()</h2><div class="memitem"><div class="memproto">      <table class="memname">        <tr>          <td class="memname">Grpc\Interceptor::interceptUnaryUnary </td>          <td>(</td>          <td class="paramtype"> </td>          <td class="paramname"><em>$method</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$argument</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$deserialize</em>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$metadata</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype">array </td>          <td class="paramname"><em>$options</em> = <code>[]</code>, </td>        </tr>        <tr>          <td class="paramkey"></td>          <td></td>          <td class="paramtype"> </td>          <td class="paramname"><em>$continuation</em> </td>        </tr>        <tr>          <td></td>          <td>)</td>          <td></td><td></td>        </tr>      </table></div><div class="memdoc"></div></div><hr/>The documentation for this class was generated from the following file:<ul><li>src/php/lib/Grpc/<a class="el" href="_interceptor_8php.html">Interceptor.php</a></li></ul></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Fri Aug 14 2020 19:53:54 for GRPC PHP by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17</small></address></body></html>
 |