123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570 |
- <!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\BaseStub 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.36.1</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_base_stub.html">BaseStub</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> |
- <a href="#pro-methods">Protected Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">Grpc\BaseStub Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Base class for generated client stubs.
- <a href="class_grpc_1_1_base_stub.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:a87b837ef58d4806ac090010b235bf6dd"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="separator:a87b837ef58d4806ac090010b235bf6dd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae2b85e451fac182cfc57b63c39d7e59a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#ae2b85e451fac182cfc57b63c39d7e59a">getTarget</a> ()</td></tr>
- <tr class="separator:ae2b85e451fac182cfc57b63c39d7e59a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a808c89a725b15d850fa2096cd6bd104d"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="separator:a808c89a725b15d850fa2096cd6bd104d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a78f84743a824f0eb3087dcb0fb8d0d41"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a78f84743a824f0eb3087dcb0fb8d0d41">waitForReady</a> ($timeout)</td></tr>
- <tr class="separator:a78f84743a824f0eb3087dcb0fb8d0d41"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13ca38aea857a61f57019228f0b6f2bc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html#a13ca38aea857a61f57019228f0b6f2bc">close</a> ()</td></tr>
- <tr class="memdesc:a13ca38aea857a61f57019228f0b6f2bc"><td class="mdescLeft"> </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>
- <tr class="separator:a13ca38aea857a61f57019228f0b6f2bc"><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:a35a01a2eeff8d1f90939c361729f2396"><td class="memItemLeft" align="right" valign="top">static </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>
- <tr class="memdesc:a35a01a2eeff8d1f90939c361729f2396"><td class="mdescLeft"> </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>
- <tr class="separator:a35a01a2eeff8d1f90939c361729f2396"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a3a70a435fb6cbee2456386507a3a9533"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:a3a70a435fb6cbee2456386507a3a9533"><td class="mdescLeft"> </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>
- <tr class="separator:a3a70a435fb6cbee2456386507a3a9533"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acc4e0f5775d36cbed3ebdebd0491835e"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:acc4e0f5775d36cbed3ebdebd0491835e"><td class="mdescLeft"> </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>
- <tr class="separator:acc4e0f5775d36cbed3ebdebd0491835e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5e798fc84d42462dce6a8e38dcc005a3"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:a5e798fc84d42462dce6a8e38dcc005a3"><td class="mdescLeft"> </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>
- <tr class="separator:a5e798fc84d42462dce6a8e38dcc005a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a06273f329dc2e0086c61f6534288277b"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:a06273f329dc2e0086c61f6534288277b"><td class="mdescLeft"> </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>
- <tr class="separator:a06273f329dc2e0086c61f6534288277b"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Base class for generated client stubs. </p>
- <p>Stub methods are expected to call _simpleRequest or _streamRequest and return the result. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a87b837ef58d4806ac090010b235bf6dd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a87b837ef58d4806ac090010b235bf6dd">◆ </a></span>__construct()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::__construct </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$hostname</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$opts</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$channel</em> = <code>null</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$hostname</td><td></td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$opts</td><td><ul>
- <li>'update_metadata': (optional) a callback function which takes in a metadata array, and returns an updated metadata array</li>
- <li>'grpc.primary_user_agent': (optional) a user-agent string </li>
- </ul>
- </td></tr>
- <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>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a06273f329dc2e0086c61f6534288277b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a06273f329dc2e0086c61f6534288277b">◆ </a></span>_bidiRequest()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::_bidiRequest </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></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
- <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the responses </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="acc4e0f5775d36cbed3ebdebd0491835e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acc4e0f5775d36cbed3ebdebd0491835e">◆ </a></span>_clientStreamRequest()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::_clientStreamRequest </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></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
- <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the response </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="a5e798fc84d42462dce6a8e38dcc005a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5e798fc84d42462dce6a8e38dcc005a3">◆ </a></span>_serverStreamRequest()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::_serverStreamRequest </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></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
- <tr><td class="paramtype">mixed</td><td class="paramname">$argument</td><td>The argument to the method </td></tr>
- <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the responses </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="a3a70a435fb6cbee2456386507a3a9533"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3a70a435fb6cbee2456386507a3a9533">◆ </a></span>_simpleRequest()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::_simpleRequest </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></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The name of the method to call </td></tr>
- <tr><td class="paramtype">mixed</td><td class="paramname">$argument</td><td>The argument to the method </td></tr>
- <tr><td class="paramtype">callable</td><td class="paramname">$deserialize</td><td>A function that deserializes the response </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>A metadata map to send to the server (optional) </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options (optional)</td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="a13ca38aea857a61f57019228f0b6f2bc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13ca38aea857a61f57019228f0b6f2bc">◆ </a></span>close()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::close </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Close the communication channel associated with this stub. </p>
- </div>
- </div>
- <a id="a808c89a725b15d850fa2096cd6bd104d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a808c89a725b15d850fa2096cd6bd104d">◆ </a></span>getConnectivityState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::getConnectivityState </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$try_to_connect</em> = <code>false</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">bool</td><td class="paramname">$try_to_connect</td><td>(optional)</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>int The grpc connectivity state </dd></dl>
- </div>
- </div>
- <a id="a35a01a2eeff8d1f90939c361729f2396"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a35a01a2eeff8d1f90939c361729f2396">◆ </a></span>getDefaultChannel()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static Grpc\BaseStub::getDefaultChannel </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$hostname</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">array </td>
- <td class="paramname"><em>$opts</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>Creates and returns the default <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">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>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a id="ae2b85e451fac182cfc57b63c39d7e59a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae2b85e451fac182cfc57b63c39d7e59a">◆ </a></span>getTarget()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::getTarget </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>string The URI of the endpoint </dd></dl>
- </div>
- </div>
- <a id="a78f84743a824f0eb3087dcb0fb8d0d41"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a78f84743a824f0eb3087dcb0fb8d0d41">◆ </a></span>waitForReady()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\BaseStub::waitForReady </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$timeout</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">int</td><td class="paramname">$timeout</td><td>in microseconds</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>bool true if channel is ready </dd></dl>
- <dl class="exception"><dt>Exceptions</dt><dd>
- <table class="exception">
- <tr><td class="paramname">Exception</td><td>if channel is in FATAL_ERROR state </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>src/php/lib/Grpc/<a class="el" href="_base_stub_8php.html">BaseStub.php</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:20:18 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>
|