carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535
							<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>Class Grpc\AbstractCall</title>

	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
				<h3>Namespaces</h3>
			<ul>
				<li class="active">
					<a href="namespace-Grpc.html">
						Grpc					</a>

						</li>
			</ul>
		</div>

		<hr>


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-Grpc.AbstractCall.html">AbstractCall</a></li>
				<li><a href="class-Grpc.BaseStub.html">BaseStub</a></li>
				<li><a href="class-Grpc.BidiStreamingCall.html">BidiStreamingCall</a></li>
				<li><a href="class-Grpc.ClientStreamingCall.html">ClientStreamingCall</a></li>
				<li><a href="class-Grpc.ServerStreamingCall.html">ServerStreamingCall</a></li>
				<li><a href="class-Grpc.UnaryCall.html">UnaryCall</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="">
		<input type="hidden" name="ie" value="UTF-8">
		<input type="text" name="q" class="text" placeholder="Search">
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-Grpc.html" title="Summary of Grpc"><span>Namespace</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class AbstractCall</h1>


	<div class="description">
	<p>Class AbstractCall.</p>
	</div>


	<div>
		<h4>Direct known subclasses</h4>
			<a href="class-Grpc.BidiStreamingCall.html">Grpc\BidiStreamingCall</a>, 
			<a href="class-Grpc.ClientStreamingCall.html">Grpc\ClientStreamingCall</a>, 
			<a href="class-Grpc.ServerStreamingCall.html">Grpc\ServerStreamingCall</a>, 
			<a href="class-Grpc.UnaryCall.html">Grpc\UnaryCall</a>
	</div>


	<div class="info">
		<b>Abstract</b><br>
		
		<b>Namespace:</b> <a href="namespace-Grpc.html">Grpc</a><br>
		<b>Package:</b> Grpc<br>

			<b>Located at</b> <a href="source-class-Grpc.AbstractCall.html#37-175" title="Go to source code">AbstractCall.php</a>
		<br>
	</div>


	<table class="summary methods" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#51-88" title="Go to source code">__construct</a>( <span>Grpc\Channel <var>$channel</var></span>, <span>string <var>$method</var></span>, <span>callable <var>$deserialize</var></span>, <span>array <var>$options</var> = []</span> )</code>

		<div class="description short">
			<p>Create a new Call wrapper object.</p>
		</div>

		<div class="description detailed hidden">
			<p>Create a new Call wrapper object.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$channel</var></dt>
					<dd>The channel to communicate on</dd>
					<dt><var>$method</var></dt>
					<dd><p>The method to call on the
                             remote server</p></dd>
					<dt><var>$deserialize</var></dt>
					<dd><p>A callback function to deserialize
                             the response</p></dd>
					<dt><var>$options</var></dt>
					<dd>Call options (optional)</dd>
				</dl></div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getMetadata" id="_getMetadata">

		<td class="attributes"><code>
			 public 

			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getMetadata">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#90-96" title="Go to source code">getMetadata</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			

				<h4>Returns</h4>
				<div class="list">
					mixed<br>The metadata sent by the server
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getTrailingMetadata" id="_getTrailingMetadata">

		<td class="attributes"><code>
			 public 

			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getTrailingMetadata">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#98-104" title="Go to source code">getTrailingMetadata</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			

				<h4>Returns</h4>
				<div class="list">
					mixed<br>The trailing metadata sent by the server
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getPeer" id="_getPeer">

		<td class="attributes"><code>
			 public 

			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getPeer">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#106-112" title="Go to source code">getPeer</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			

				<h4>Returns</h4>
				<div class="list">
					string<br>The URI of the endpoint
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="cancel" id="_cancel">

		<td class="attributes"><code>
			 public 

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_cancel">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#114-120" title="Go to source code">cancel</a>( )</code>

		<div class="description short">
			<p>Cancels the call.</p>
		</div>

		<div class="description detailed hidden">
			<p>Cancels the call.</p>


		</div>
		</div></td>
	</tr>
	<tr data-order="_serializeMessage" id="__serializeMessage">

		<td class="attributes"><code>
			 protected 

			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__serializeMessage">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#122-138" title="Go to source code">_serializeMessage</a>( <span>mixed <var>$data</var></span> )</code>

		<div class="description short">
			<p>Serialize a message to the protobuf binary format.</p>
		</div>

		<div class="description detailed hidden">
			<p>Serialize a message to the protobuf binary format.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$data</var></dt>
					<dd>The Protobuf message</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					string<br>The protobuf binary format
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="_deserializeResponse" id="__deserializeResponse">

		<td class="attributes"><code>
			 protected 

			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__deserializeResponse">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#140-164" title="Go to source code">_deserializeResponse</a>( <span>string <var>$value</var></span> )</code>

		<div class="description short">
			<p>Deserialize a response value to an object.</p>
		</div>

		<div class="description detailed hidden">
			<p>Deserialize a response value to an object.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$value</var></dt>
					<dd>The binary value to deserialize</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					mixed<br>The deserialized value
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="setCallCredentials" id="_setCallCredentials">

		<td class="attributes"><code>
			 public 

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setCallCredentials">#</a>
		<code><a href="source-class-Grpc.AbstractCall.html#166-174" title="Go to source code">setCallCredentials</a>( <span>CallCredentials <var>$call_credentials</var></span> )</code>

		<div class="description short">
			<p>Set the CallCredentials for the underlying Call.</p>
		</div>

		<div class="description detailed hidden">
			<p>Set the CallCredentials for the underlying Call.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$call_credentials</var></dt>
					<dd>The CallCredentials object</dd>
				</dl></div>


		</div>
		</div></td>
	</tr>
	</table>


	<table class="summary properties" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="call" id="$call">
		<td class="attributes"><code>
			protected  
			Call
		</code></td>

		<td class="name">
				<a href="source-class-Grpc.AbstractCall.html#43-46" title="Go to source code"><var>$call</var></a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</td>
		<td class="value">
			<div>
				<a href="#$call" class="anchor">#</a>
				<code></code>
			</div>
		</td>
	</tr>
	<tr data-order="deserialize" id="$deserialize">
		<td class="attributes"><code>
			protected  
			
		</code></td>

		<td class="name">
				<a href="source-class-Grpc.AbstractCall.html#47" title="Go to source code"><var>$deserialize</var></a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</td>
		<td class="value">
			<div>
				<a href="#$deserialize" class="anchor">#</a>
				<code></code>
			</div>
		</td>
	</tr>
	<tr data-order="metadata" id="$metadata">
		<td class="attributes"><code>
			protected  
			
		</code></td>

		<td class="name">
				<a href="source-class-Grpc.AbstractCall.html#48" title="Go to source code"><var>$metadata</var></a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</td>
		<td class="value">
			<div>
				<a href="#$metadata" class="anchor">#</a>
				<code></code>
			</div>
		</td>
	</tr>
	<tr data-order="trailing_metadata" id="$trailing_metadata">
		<td class="attributes"><code>
			protected  
			
		</code></td>

		<td class="name">
				<a href="source-class-Grpc.AbstractCall.html#49" title="Go to source code"><var>$trailing_metadata</var></a>

			<div class="description short">
				
			</div>

			<div class="description detailed hidden">
				

			</div>
		</td>
		<td class="value">
			<div>
				<a href="#$trailing_metadata" class="anchor">#</a>
				<code></code>
			</div>
		</td>
	</tr>
	</table>


</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>