123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221 |
- <!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\UnaryCall 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_unary_call.html">UnaryCall</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">Grpc\UnaryCall Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Represents an active call that sends a single message and then gets a single response.
- <a href="class_grpc_1_1_unary_call.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:a08ec57a768664dc428637bdf55742ca0"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:a08ec57a768664dc428637bdf55742ca0"><td class="mdescLeft"> </td><td class="mdescRight">Start the call. <a href="class_grpc_1_1_unary_call.html#a08ec57a768664dc428637bdf55742ca0">More...</a><br /></td></tr>
- <tr class="separator:a08ec57a768664dc428637bdf55742ca0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7947c58bacabc0267c79de33277440c5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_unary_call.html#a7947c58bacabc0267c79de33277440c5">wait</a> ()</td></tr>
- <tr class="memdesc:a7947c58bacabc0267c79de33277440c5"><td class="mdescLeft"> </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>
- <tr class="separator:a7947c58bacabc0267c79de33277440c5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae65d18a70f9cee4505283b19d235360c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_unary_call.html#ae65d18a70f9cee4505283b19d235360c">getMetadata</a> ()</td></tr>
- <tr class="separator:ae65d18a70f9cee4505283b19d235360c"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Public Member Functions inherited from <a class="el" href="class_grpc_1_1_abstract_call.html">Grpc\AbstractCall</a></td></tr>
- <tr class="memitem:a98c8526df813acd6a775cf90a31af18e inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="memdesc:a98c8526df813acd6a775cf90a31af18e inherit pub_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft"> </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>
- <tr class="separator:a98c8526df813acd6a775cf90a31af18e inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8de5e451ba9a414d7a58a7d7c5fcc764 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a8de5e451ba9a414d7a58a7d7c5fcc764">getTrailingMetadata</a> ()</td></tr>
- <tr class="separator:a8de5e451ba9a414d7a58a7d7c5fcc764 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a188fc7298f9b52fb0eee7d3901281cdc inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a188fc7298f9b52fb0eee7d3901281cdc">getPeer</a> ()</td></tr>
- <tr class="separator:a188fc7298f9b52fb0eee7d3901281cdc inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a088115c12c3af171fe7e99078595d6c0 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a088115c12c3af171fe7e99078595d6c0">cancel</a> ()</td></tr>
- <tr class="memdesc:a088115c12c3af171fe7e99078595d6c0 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft"> </td><td class="mdescRight">Cancels the call. <a href="class_grpc_1_1_abstract_call.html#a088115c12c3af171fe7e99078595d6c0">More...</a><br /></td></tr>
- <tr class="separator:a088115c12c3af171fe7e99078595d6c0 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88c9af5ba3c7ede0dc5342363af5e9a2 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a88c9af5ba3c7ede0dc5342363af5e9a2">setCallCredentials</a> ($call_credentials)</td></tr>
- <tr class="memdesc:a88c9af5ba3c7ede0dc5342363af5e9a2 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft"> </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>
- <tr class="separator:a88c9af5ba3c7ede0dc5342363af5e9a2 inherit pub_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <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="-"/> Protected Member Functions inherited from <a class="el" href="class_grpc_1_1_abstract_call.html">Grpc\AbstractCall</a></td></tr>
- <tr class="memitem:ac6b4a554e5be5fd57ee05610e25d4d05 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#ac6b4a554e5be5fd57ee05610e25d4d05">_serializeMessage</a> ($data)</td></tr>
- <tr class="memdesc:ac6b4a554e5be5fd57ee05610e25d4d05 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft"> </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>
- <tr class="separator:ac6b4a554e5be5fd57ee05610e25d4d05 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a413e87bcf0475cd8c627fd16919fda98 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a413e87bcf0475cd8c627fd16919fda98">_deserializeResponse</a> ($value)</td></tr>
- <tr class="memdesc:a413e87bcf0475cd8c627fd16919fda98 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="mdescLeft"> </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>
- <tr class="separator:a413e87bcf0475cd8c627fd16919fda98 inherit pro_methods_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <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="-"/> Protected Attributes inherited from <a class="el" href="class_grpc_1_1_abstract_call.html">Grpc\AbstractCall</a></td></tr>
- <tr class="memitem:a722dd807b08d990d3f9816202627d701 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a722dd807b08d990d3f9816202627d701">$call</a></td></tr>
- <tr class="separator:a722dd807b08d990d3f9816202627d701 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa10e9fd56d64bc2167bb65129e212c9b inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#aa10e9fd56d64bc2167bb65129e212c9b">$deserialize</a></td></tr>
- <tr class="separator:aa10e9fd56d64bc2167bb65129e212c9b inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aabc4e33a97415326e10596675f790328 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#aabc4e33a97415326e10596675f790328">$metadata</a></td></tr>
- <tr class="separator:aabc4e33a97415326e10596675f790328 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a35264eb899b5c6d320433741202924d2 inherit pro_attribs_class_grpc_1_1_abstract_call"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html#a35264eb899b5c6d320433741202924d2">$trailing_metadata</a></td></tr>
- <tr class="separator:a35264eb899b5c6d320433741202924d2 inherit pro_attribs_class_grpc_1_1_abstract_call"><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 active call that sends a single message and then gets a single response. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="ae65d18a70f9cee4505283b19d235360c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae65d18a70f9cee4505283b19d235360c">◆ </a></span>getMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\UnaryCall::getMetadata </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>mixed The metadata sent by the server </dd></dl>
- <p>Reimplemented from <a class="el" href="class_grpc_1_1_abstract_call.html#ac5d4f130fc35450d4a5b0bfd0a918ff4">Grpc\AbstractCall</a>.</p>
- </div>
- </div>
- <a id="a08ec57a768664dc428637bdf55742ca0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a08ec57a768664dc428637bdf55742ca0">◆ </a></span>start()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\UnaryCall::start </td>
- <td>(</td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>$data</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>
- </div><div class="memdoc">
- <p>Start the call. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramtype">mixed</td><td class="paramname">$data</td><td>The data to send </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$metadata</td><td>Metadata to send with the call, if applicable (optional) </td></tr>
- <tr><td class="paramtype">array</td><td class="paramname">$options</td><td>An array of options, possible keys: 'flags' => a number (optional) </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a7947c58bacabc0267c79de33277440c5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7947c58bacabc0267c79de33277440c5">◆ </a></span>wait()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Grpc\UnaryCall::wait </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Wait for the server to respond with data and a status. </p>
- <dl class="section return"><dt>Returns</dt><dd>array [response data, status] </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="_unary_call_8php.html">UnaryCall.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>
|