carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
							<!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\Call 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
   &#160;<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&amp;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&amp;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_call.html">Call</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\Call Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>class <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a>  
 <a href="class_grpc_1_1_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:a1e427a3545ad6116b06788ac453a8503"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call.html#a1e427a3545ad6116b06788ac453a8503">__construct</a> ($channel_obj, $method, $deadline_obj, $host_override=&quot;&quot;)</td></tr>
<tr class="memdesc:a1e427a3545ad6116b06788ac453a8503"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new instance of the <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> class.  <a href="class_grpc_1_1_call.html#a1e427a3545ad6116b06788ac453a8503">More...</a><br /></td></tr>
<tr class="separator:a1e427a3545ad6116b06788ac453a8503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0026968f6868365e3ba910f5b30416c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call.html#a0026968f6868365e3ba910f5b30416c5">startBatch</a> ($array)</td></tr>
<tr class="memdesc:a0026968f6868365e3ba910f5b30416c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a batch of RPC actions.  <a href="class_grpc_1_1_call.html#a0026968f6868365e3ba910f5b30416c5">More...</a><br /></td></tr>
<tr class="separator:a0026968f6868365e3ba910f5b30416c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6aa5fa913c3175b4c029e372112a777"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call.html#ab6aa5fa913c3175b4c029e372112a777">getPeer</a> ()</td></tr>
<tr class="memdesc:ab6aa5fa913c3175b4c029e372112a777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the endpoint this call/stream is connected to.  <a href="class_grpc_1_1_call.html#ab6aa5fa913c3175b4c029e372112a777">More...</a><br /></td></tr>
<tr class="separator:ab6aa5fa913c3175b4c029e372112a777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc7c962d3288c3483ea4ce6ed1cfe9f7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call.html#afc7c962d3288c3483ea4ce6ed1cfe9f7">cancel</a> ()</td></tr>
<tr class="memdesc:afc7c962d3288c3483ea4ce6ed1cfe9f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the call.  <a href="class_grpc_1_1_call.html#afc7c962d3288c3483ea4ce6ed1cfe9f7">More...</a><br /></td></tr>
<tr class="separator:afc7c962d3288c3483ea4ce6ed1cfe9f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a547de08c2c0712561250ff01c32a9b90"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call.html#a547de08c2c0712561250ff01c32a9b90">setCredentials</a> ($creds_obj)</td></tr>
<tr class="memdesc:a547de08c2c0712561250ff01c32a9b90"><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 this call.  <a href="class_grpc_1_1_call.html#a547de08c2c0712561250ff01c32a9b90">More...</a><br /></td></tr>
<tr class="separator:a547de08c2c0712561250ff01c32a9b90"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>class <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/call.c">https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/call.c</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1e427a3545ad6116b06788ac453a8503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e427a3545ad6116b06788ac453a8503">&#9670;&nbsp;</a></span>__construct()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Call::__construct </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$channel_obj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$method</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$deadline_obj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$host_override</em> = <code>&quot;&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a new instance of the <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> class. </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></td><td class="paramname">$channel_obj</td><td>The channel to associate the call with. Must not be closed. </td></tr>
    <tr><td class="paramtype">string</td><td class="paramname">$method</td><td>The method to call </td></tr>
    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_timeval.html" title="class Timeval">Timeval</a></td><td class="paramname">$deadline_obj</td><td>The deadline for completing the call </td></tr>
    <tr><td class="paramtype">string</td><td class="paramname">$host_override</td><td>= "" The host is set by user (optional) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afc7c962d3288c3483ea4ce6ed1cfe9f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc7c962d3288c3483ea4ce6ed1cfe9f7">&#9670;&nbsp;</a></span>cancel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Call::cancel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Cancel the call. </p>
<p>This will cause the call to end with STATUS_CANCELLED if it has not already ended with another status. </p><dl class="section return"><dt>Returns</dt><dd>void </dd></dl>

</div>
</div>
<a id="ab6aa5fa913c3175b4c029e372112a777"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6aa5fa913c3175b4c029e372112a777">&#9670;&nbsp;</a></span>getPeer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Call::getPeer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the endpoint this call/stream is connected to. </p>
<dl class="section return"><dt>Returns</dt><dd>string The URI of the endpoint </dd></dl>

</div>
</div>
<a id="a547de08c2c0712561250ff01c32a9b90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a547de08c2c0712561250ff01c32a9b90">&#9670;&nbsp;</a></span>setCredentials()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Call::setCredentials </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$creds_obj</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the <a class="el" href="class_grpc_1_1_call_credentials.html" title="class CallCredentials">CallCredentials</a> for this call. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_call_credentials.html" title="class CallCredentials">CallCredentials</a></td><td class="paramname">$creds_obj</td><td>The <a class="el" href="class_grpc_1_1_call_credentials.html" title="class CallCredentials">CallCredentials</a> object </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int The error code </dd></dl>

</div>
</div>
<a id="a0026968f6868365e3ba910f5b30416c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0026968f6868365e3ba910f5b30416c5">&#9670;&nbsp;</a></span>startBatch()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Call::startBatch </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$array</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start a batch of RPC actions. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">array</td><td class="paramname">$array</td><td>Array of actions to take </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>object Object with results of all actions </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="_call_8php.html">Call.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>