carto
/
grpc


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

	<title>Class Grpc\BaseStub</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><a href="class-Grpc.AbstractCall.html">AbstractCall</a></li>
				<li class="active"><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 BaseStub</h1>


	<div class="description">
	<p>Base class for generated client stubs. Stub methods are expected to call
_simpleRequest or _streamRequest and return the result.</p>
	</div>


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

			<b>Located at</b> <a href="source-class-Grpc.BaseStub.html#37-363" title="Go to source code">BaseStub.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.BaseStub.html#50-98" title="Go to source code">__construct</a>( <span>string <var>$hostname</var></span>, <span>array <var>$opts</var></span>, <span>Grpc\Channel <var>$channel</var> = <span class="php-keyword1">null</span></span> )</code>

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

		<div class="description detailed hidden">
			

				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$hostname</var></dt>
					<dd></dd>
					<dt><var>$opts</var></dt>
					<dd><ul>
<li>'update_metadata': (optional) a callback function which takes in a
metadata array, and returns an updated metadata array

<ul>
<li>'grpc.primary_user_agent': (optional) a user-agent string</li>
</ul></li>
</ul></dd>
					<dt><var>$channel</var></dt>
					<dd>An already created Channel object (optional)</dd>
				</dl></div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getTarget" id="_getTarget">

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

			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getTarget">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#100-106" title="Go to source code">getTarget</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="getConnectivityState" id="_getConnectivityState">

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

			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getConnectivityState">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#108-116" title="Go to source code">getConnectivityState</a>( <span>boolean <var>$try_to_connect</var> = <span class="php-keyword1">false</span></span> )</code>

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

		<div class="description detailed hidden">
			

				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$try_to_connect</var></dt>
					<dd>(optional)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					integer<br>The grpc connectivity state
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="waitForReady" id="_waitForReady">

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

			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_waitForReady">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#118-146" title="Go to source code">waitForReady</a>( <span>integer <var>$timeout</var></span> )</code>

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

		<div class="description detailed hidden">
			

				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$timeout</var></dt>
					<dd>in microseconds</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					boolean<br>true if channel is ready
				</div>


				<h4>Throw</h4>
				<div class="list">
						Exception if channel is in FATAL_ERROR state<br>
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="close" id="_close">

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

			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_close">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#148-154" title="Go to source code">close</a>( )</code>

		<div class="description short">
			<p>Close the communication channel associated with this stub.</p>
		</div>

		<div class="description detailed hidden">
			<p>Close the communication channel associated with this stub.</p>


		</div>
		</div></td>
	</tr>
	<tr data-order="_simpleRequest" id="__simpleRequest">

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

			SimpleSurfaceActiveCall
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__simpleRequest">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#225-259" title="Go to source code">_simpleRequest</a>( <span>string <var>$method</var></span>, <span>mixed <var>$argument</var></span>, <span>callable <var>$deserialize</var></span>, <span>array <var>$metadata</var> = []</span>, <span>array <var>$options</var> = []</span> )</code>

		<div class="description short">
			<p>Call a remote method that takes a single argument and has a
single output.</p>
		</div>

		<div class="description detailed hidden">
			<p>Call a remote method that takes a single argument and has a
single output.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$method</var></dt>
					<dd>The name of the method to call</dd>
					<dt><var>$argument</var></dt>
					<dd>The argument to the method</dd>
					<dt><var>$deserialize</var></dt>
					<dd>A function that deserializes the response</dd>
					<dt><var>$metadata</var></dt>
					<dd><p>A metadata map to send to the server
                             (optional)</p></dd>
					<dt><var>$options</var></dt>
					<dd>An array of options (optional)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					SimpleSurfaceActiveCall<br>The active call object
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="_clientStreamRequest" id="__clientStreamRequest">

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

			ClientStreamingSurfaceActiveCall
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__clientStreamRequest">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#261-293" title="Go to source code">_clientStreamRequest</a>( <span>string <var>$method</var></span>, <span>callable <var>$deserialize</var></span>, <span>array <var>$metadata</var> = []</span>, <span>array <var>$options</var> = []</span> )</code>

		<div class="description short">
			<p>Call a remote method that takes a stream of arguments and has a single
output.</p>
		</div>

		<div class="description detailed hidden">
			<p>Call a remote method that takes a stream of arguments and has a single
output.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$method</var></dt>
					<dd>The name of the method to call</dd>
					<dt><var>$deserialize</var></dt>
					<dd>A function that deserializes the response</dd>
					<dt><var>$metadata</var></dt>
					<dd><p>A metadata map to send to the server
                             (optional)</p></dd>
					<dt><var>$options</var></dt>
					<dd>An array of options (optional)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					ClientStreamingSurfaceActiveCall<br>The active call object
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="_serverStreamRequest" id="__serverStreamRequest">

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

			ServerStreamingSurfaceActiveCall
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__serverStreamRequest">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#295-329" title="Go to source code">_serverStreamRequest</a>( <span>string <var>$method</var></span>, <span>mixed <var>$argument</var></span>, <span>callable <var>$deserialize</var></span>, <span>array <var>$metadata</var> = []</span>, <span>array <var>$options</var> = []</span> )</code>

		<div class="description short">
			<p>Call a remote method that takes a single argument and returns a stream
of responses.</p>
		</div>

		<div class="description detailed hidden">
			<p>Call a remote method that takes a single argument and returns a stream
of responses.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$method</var></dt>
					<dd>The name of the method to call</dd>
					<dt><var>$argument</var></dt>
					<dd>The argument to the method</dd>
					<dt><var>$deserialize</var></dt>
					<dd>A function that deserializes the responses</dd>
					<dt><var>$metadata</var></dt>
					<dd><p>A metadata map to send to the server
                             (optional)</p></dd>
					<dt><var>$options</var></dt>
					<dd>An array of options (optional)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					ServerStreamingSurfaceActiveCall<br>The active call object
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="_bidiRequest" id="__bidiRequest">

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

			BidiStreamingSurfaceActiveCall
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#__bidiRequest">#</a>
		<code><a href="source-class-Grpc.BaseStub.html#331-362" title="Go to source code">_bidiRequest</a>( <span>string <var>$method</var></span>, <span>callable <var>$deserialize</var></span>, <span>array <var>$metadata</var> = []</span>, <span>array <var>$options</var> = []</span> )</code>

		<div class="description short">
			<p>Call a remote method with messages streaming in both directions.</p>
		</div>

		<div class="description detailed hidden">
			<p>Call a remote method with messages streaming in both directions.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$method</var></dt>
					<dd>The name of the method to call</dd>
					<dt><var>$deserialize</var></dt>
					<dd>A function that deserializes the responses</dd>
					<dt><var>$metadata</var></dt>
					<dd><p>A metadata map to send to the server
                             (optional)</p></dd>
					<dt><var>$options</var></dt>
					<dd>An array of options (optional)</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					BidiStreamingSurfaceActiveCall<br>The active call object
				</div>


		</div>
		</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>