Grpc.BaseStub.html 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
  5. <meta charset="utf-8"/>
  6. <title>API Documentation</title>
  7. <meta name="author" content=""/>
  8. <meta name="description" content=""/>
  9. <link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
  10. <link href="../css/font-awesome.min.css" rel="stylesheet">
  11. <link href="../css/prism.css" rel="stylesheet" media="all"/>
  12. <link href="../css/template.css" rel="stylesheet" media="all"/>
  13. <!--[if lt IE 9]>
  14. <script src="../js/html5.js"></script>
  15. <![endif]-->
  16. <script src="../js/jquery-1.11.0.min.js"></script>
  17. <script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
  18. <script src="../js/bootstrap.min.js"></script>
  19. <script src="../js/jquery.smooth-scroll.js"></script>
  20. <script src="../js/prism.min.js"></script>
  21. <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
  22. <script type="text/javascript">
  23. function loadExternalCodeSnippets() {
  24. Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
  25. var src = pre.getAttribute('data-src');
  26. var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
  27. var language = 'php';
  28. var code = document.createElement('code');
  29. code.className = 'language-' + language;
  30. pre.textContent = '';
  31. code.textContent = 'Loading…';
  32. pre.appendChild(code);
  33. var xhr = new XMLHttpRequest();
  34. xhr.open('GET', src, true);
  35. xhr.onreadystatechange = function () {
  36. if (xhr.readyState == 4) {
  37. if (xhr.status < 400 && xhr.responseText) {
  38. code.textContent = xhr.responseText;
  39. Prism.highlightElement(code);
  40. }
  41. else if (xhr.status >= 400) {
  42. code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
  43. }
  44. else {
  45. code.textContent = '✖ Error: File does not exist or is empty';
  46. }
  47. }
  48. };
  49. xhr.send(null);
  50. });
  51. }
  52. $(document).ready(function(){
  53. loadExternalCodeSnippets();
  54. });
  55. $('#source-view').on('shown', function () {
  56. loadExternalCodeSnippets();
  57. })
  58. </script>
  59. <link rel="shortcut icon" href="../images/favicon.ico"/>
  60. <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
  61. <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
  62. <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
  63. </head>
  64. <body>
  65. <div class="navbar navbar-fixed-top">
  66. <div class="navbar-inner">
  67. <div class="container">
  68. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
  69. <i class="icon-ellipsis-vertical"></i>
  70. </a>
  71. <a class="brand" href="../index.html">API Documentation</a>
  72. <div class="nav-collapse">
  73. <ul class="nav pull-right">
  74. <li class="dropdown">
  75. <a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
  76. API Documentation <b class="caret"></b>
  77. </a>
  78. <ul class="dropdown-menu">
  79. <li><a href="../namespaces/Grpc.html">\Grpc</a></li>
  80. </ul>
  81. </li>
  82. <li class="dropdown" id="charts-menu">
  83. <a href="#" class="dropdown-toggle" data-toggle="dropdown">
  84. Charts <b class="caret"></b>
  85. </a>
  86. <ul class="dropdown-menu">
  87. <li>
  88. <a href="../graphs/class.html">
  89. <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
  90. </a>
  91. </li>
  92. </ul>
  93. </li>
  94. <li class="dropdown" id="reports-menu">
  95. <a href="#" class="dropdown-toggle" data-toggle="dropdown">
  96. Reports <b class="caret"></b>
  97. </a>
  98. <ul class="dropdown-menu">
  99. <li>
  100. <a href="../reports/errors.html">
  101. <i class="icon-list-alt"></i>&#160;Errors <span class="label label-info pull-right">23</span>
  102. </a>
  103. </li>
  104. <li>
  105. <a href="../reports/markers.html">
  106. <i class="icon-list-alt"></i>&#160;Markers <span class="label label-info pull-right">0</span>
  107. </a>
  108. </li>
  109. <li>
  110. <a href="../reports/deprecated.html">
  111. <i class="icon-list-alt"></i>&#160;Deprecated <span class="label label-info pull-right">0</span>
  112. </a>
  113. </li>
  114. </ul>
  115. </li>
  116. </ul>
  117. </div>
  118. </div>
  119. </div>
  120. <!--<div class="go_to_top">-->
  121. <!--<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>-->
  122. <!--</div>-->
  123. </div>
  124. <div id="___" class="container-fluid">
  125. <section class="row-fluid">
  126. <div class="span2 sidebar">
  127. <div class="accordion" style="margin-bottom: 0">
  128. <div class="accordion-group">
  129. <div class="accordion-heading">
  130. <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1525295724"></a>
  131. <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
  132. </div>
  133. <div id="namespace-1525295724" class="accordion-body collapse in">
  134. <div class="accordion-inner">
  135. <div class="accordion" style="margin-bottom: 0">
  136. <div class="accordion-group">
  137. <div class="accordion-heading">
  138. <a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1484954936"></a>
  139. <a href="../namespaces/Grpc.html" style="margin-left: 30px; padding-left: 0">Grpc</a>
  140. </div>
  141. <div id="namespace-1484954936" class="accordion-body collapse ">
  142. <div class="accordion-inner">
  143. <ul>
  144. <li class="class"><a href="../classes/Grpc.AbstractCall.html">AbstractCall</a></li>
  145. <li class="class"><a href="../classes/Grpc.BaseStub.html">BaseStub</a></li>
  146. <li class="class"><a href="../classes/Grpc.BidiStreamingCall.html">BidiStreamingCall</a></li>
  147. <li class="class"><a href="../classes/Grpc.ClientStreamingCall.html">ClientStreamingCall</a></li>
  148. <li class="class"><a href="../classes/Grpc.ServerStreamingCall.html">ServerStreamingCall</a></li>
  149. <li class="class"><a href="../classes/Grpc.UnaryCall.html">UnaryCall</a></li>
  150. </ul>
  151. </div>
  152. </div>
  153. </div>
  154. </div>
  155. <ul>
  156. </ul>
  157. </div>
  158. </div>
  159. </div>
  160. </div>
  161. </div>
  162. </section>
  163. <section class="row-fluid">
  164. <div class="span10 offset2">
  165. <div class="row-fluid">
  166. <div class="span8 content class">
  167. <nav>
  168. <a href="../namespaces/Grpc.html">\Grpc</a> <i class="icon-level-up"></i>
  169. </nav>
  170. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
  171. <h1><small>\Grpc</small>BaseStub</h1>
  172. <p><em>Base class for generated client stubs. Stub methods are expected to call
  173. _simpleRequest or _streamRequest and return the result.</em></p>
  174. <section id="summary">
  175. <h2>Summary</h2>
  176. <section class="row-fluid heading">
  177. <section class="span4">
  178. <a href="#methods">Methods</a>
  179. </section>
  180. <section class="span4">
  181. <a href="#properties">Properties</a>
  182. </section>
  183. <section class="span4">
  184. <a href="#constants">Constants</a>
  185. </section>
  186. </section>
  187. <section class="row-fluid public">
  188. <section class="span4">
  189. <a href="../classes/Grpc.BaseStub.html#method___construct" class="">__construct()</a><br />
  190. <a href="../classes/Grpc.BaseStub.html#method_getTarget" class="">getTarget()</a><br />
  191. <a href="../classes/Grpc.BaseStub.html#method_getConnectivityState" class="">getConnectivityState()</a><br />
  192. <a href="../classes/Grpc.BaseStub.html#method_waitForReady" class="">waitForReady()</a><br />
  193. <a href="../classes/Grpc.BaseStub.html#method_close" class="">close()</a><br />
  194. <a href="../classes/Grpc.BaseStub.html#method__simpleRequest" class="">_simpleRequest()</a><br />
  195. <a href="../classes/Grpc.BaseStub.html#method__clientStreamRequest" class="">_clientStreamRequest()</a><br />
  196. <a href="../classes/Grpc.BaseStub.html#method__serverStreamRequest" class="">_serverStreamRequest()</a><br />
  197. <a href="../classes/Grpc.BaseStub.html#method__bidiRequest" class="">_bidiRequest()</a><br />
  198. </section>
  199. <section class="span4">
  200. <em>No public properties found</em>
  201. </section>
  202. <section class="span4">
  203. <em>No constants found</em>
  204. </section>
  205. </section>
  206. <section class="row-fluid protected">
  207. <section class="span4">
  208. <em>No protected methods found</em>
  209. </section>
  210. <section class="span4">
  211. <em>No protected properties found</em>
  212. </section>
  213. <section class="span4">
  214. <em>N/A</em>
  215. </section>
  216. </section>
  217. <section class="row-fluid private">
  218. <section class="span4">
  219. <a href="../classes/Grpc.BaseStub.html#method__checkConnectivityState" class="">_checkConnectivityState()</a><br />
  220. <a href="../classes/Grpc.BaseStub.html#method__get_jwt_aud_uri" class="">_get_jwt_aud_uri()</a><br />
  221. <a href="../classes/Grpc.BaseStub.html#method__extract_timeout_from_metadata" class="">_extract_timeout_from_metadata()</a><br />
  222. </section>
  223. <section class="span4">
  224. <a href="../classes/Grpc.BaseStub.html#property_hostname" class="">$hostname</a><br />
  225. <a href="../classes/Grpc.BaseStub.html#property_channel" class="">$channel</a><br />
  226. <a href="../classes/Grpc.BaseStub.html#property_update_metadata" class="">$update_metadata</a><br />
  227. </section>
  228. <section class="span4">
  229. <em>N/A</em>
  230. </section>
  231. </section>
  232. </section>
  233. </div>
  234. <aside class="span4 detailsbar">
  235. <dl>
  236. <dt>File</dt>
  237. <dd><a href="../files/BaseStub.html"><div class="path-wrapper">BaseStub.php</div></a></dd>
  238. <dt>Package</dt>
  239. <dd><div class="namespace-wrapper">Default</div></dd>
  240. <dt>Class hierarchy</dt>
  241. <dd class="hierarchy">
  242. <div class="namespace-wrapper">\Grpc\BaseStub</div>
  243. </dd>
  244. </dl>
  245. <h2>Tags</h2>
  246. <table class="table table-condensed">
  247. <tr><td colspan="2"><em>None found</em></td></tr>
  248. </table>
  249. </aside>
  250. </div>
  251. <a id="properties" name="properties"></a>
  252. <div class="row-fluid">
  253. <div class="span8 content class">
  254. <h2>Properties</h2>
  255. </div>
  256. <aside class="span4 detailsbar"></aside>
  257. </div>
  258. <div class="row-fluid">
  259. <div class="span8 content class">
  260. <a id="property_hostname" name="property_hostname" class="anchor"></a>
  261. <article class="property">
  262. <h3 class="private ">$hostname</h3>
  263. <pre class="signature">$hostname : </pre>
  264. <p><em></em></p>
  265. <h4>Type</h4>
  266. </article>
  267. </div>
  268. <aside class="span4 detailsbar">
  269. <h1><i class="icon-arrow-down"></i></h1>
  270. <dl>
  271. </dl>
  272. <h2>Tags</h2>
  273. <table class="table table-condensed">
  274. <tr><td colspan="2"><em>None found</em></td></tr>
  275. </table>
  276. </aside>
  277. </div>
  278. <div class="row-fluid">
  279. <div class="span8 content class">
  280. <a id="property_channel" name="property_channel" class="anchor"></a>
  281. <article class="property">
  282. <h3 class="private ">$channel</h3>
  283. <pre class="signature">$channel : </pre>
  284. <p><em></em></p>
  285. <h4>Type</h4>
  286. </article>
  287. </div>
  288. <aside class="span4 detailsbar">
  289. <h1><i class="icon-arrow-down"></i></h1>
  290. <dl>
  291. </dl>
  292. <h2>Tags</h2>
  293. <table class="table table-condensed">
  294. <tr><td colspan="2"><em>None found</em></td></tr>
  295. </table>
  296. </aside>
  297. </div>
  298. <div class="row-fluid">
  299. <div class="span8 content class">
  300. <a id="property_update_metadata" name="property_update_metadata" class="anchor"></a>
  301. <article class="property">
  302. <h3 class="private ">$update_metadata</h3>
  303. <pre class="signature">$update_metadata : </pre>
  304. <p><em></em></p>
  305. <h4>Type</h4>
  306. </article>
  307. </div>
  308. <aside class="span4 detailsbar">
  309. <h1><i class="icon-arrow-down"></i></h1>
  310. <dl>
  311. </dl>
  312. <h2>Tags</h2>
  313. <table class="table table-condensed">
  314. <tr><td colspan="2"><em>None found</em></td></tr>
  315. </table>
  316. </aside>
  317. </div>
  318. <a id="methods" name="methods"></a>
  319. <div class="row-fluid">
  320. <div class="span8 content class"><h2>Methods</h2></div>
  321. <aside class="span4 detailsbar"></aside>
  322. </div>
  323. <div class="row-fluid">
  324. <div class="span8 content class">
  325. <a id="method___construct" name="method___construct" class="anchor"></a>
  326. <article class="method">
  327. <h3 class="public ">__construct()</h3>
  328. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  329. <pre class="signature" style="margin-right: 54px;">__construct( <span class="argument">$hostname</span>, <span class="argument">$opts</span>) </pre>
  330. <p><em></em></p>
  331. <h4>Parameters</h4>
  332. <table class="table table-condensed table-hover">
  333. <tr>
  334. <td></td>
  335. <td>$hostname </td>
  336. <td><p>string</p></td>
  337. </tr>
  338. <tr>
  339. <td></td>
  340. <td>$opts </td>
  341. <td><p>array</p>
  342. <ul>
  343. <li>'update_metadata': (optional) a callback function which takes in a
  344. metadata array, and returns an updated metadata array</li>
  345. </ul></td>
  346. </tr>
  347. </table>
  348. </article>
  349. </div>
  350. <aside class="span4 detailsbar">
  351. <h1><i class="icon-arrow-down"></i></h1>
  352. <dl>
  353. </dl>
  354. <h2>Tags</h2>
  355. <table class="table table-condensed">
  356. <tr><td colspan="2"><em>None found</em></td></tr>
  357. </table>
  358. </aside>
  359. </div>
  360. <div class="row-fluid">
  361. <div class="span8 content class">
  362. <a id="method_getTarget" name="method_getTarget" class="anchor"></a>
  363. <article class="method">
  364. <h3 class="public ">getTarget()</h3>
  365. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  366. <pre class="signature" style="margin-right: 54px;">getTarget() : string</pre>
  367. <p><em></em></p>
  368. <h4>Returns</h4>
  369. string
  370. &mdash; <p>The URI of the endpoint.</p>
  371. </article>
  372. </div>
  373. <aside class="span4 detailsbar">
  374. <h1><i class="icon-arrow-down"></i></h1>
  375. <dl>
  376. </dl>
  377. <h2>Tags</h2>
  378. <table class="table table-condensed">
  379. <tr><td colspan="2"><em>None found</em></td></tr>
  380. </table>
  381. </aside>
  382. </div>
  383. <div class="row-fluid">
  384. <div class="span8 content class">
  385. <a id="method_getConnectivityState" name="method_getConnectivityState" class="anchor"></a>
  386. <article class="method">
  387. <h3 class="public ">getConnectivityState()</h3>
  388. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  389. <pre class="signature" style="margin-right: 54px;">getConnectivityState( <span class="argument">$try_to_connect = false</span>) : integer</pre>
  390. <p><em></em></p>
  391. <h4>Parameters</h4>
  392. <table class="table table-condensed table-hover">
  393. <tr>
  394. <td></td>
  395. <td>$try_to_connect </td>
  396. <td><p>bool</p></td>
  397. </tr>
  398. </table>
  399. <h4>Returns</h4>
  400. integer
  401. &mdash; <p>The grpc connectivity state</p>
  402. </article>
  403. </div>
  404. <aside class="span4 detailsbar">
  405. <h1><i class="icon-arrow-down"></i></h1>
  406. <dl>
  407. </dl>
  408. <h2>Tags</h2>
  409. <table class="table table-condensed">
  410. <tr><td colspan="2"><em>None found</em></td></tr>
  411. </table>
  412. </aside>
  413. </div>
  414. <div class="row-fluid">
  415. <div class="span8 content class">
  416. <a id="method_waitForReady" name="method_waitForReady" class="anchor"></a>
  417. <article class="method">
  418. <h3 class="public ">waitForReady()</h3>
  419. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  420. <pre class="signature" style="margin-right: 54px;">waitForReady( <span class="argument">$timeout</span>) : boolean</pre>
  421. <p><em></em></p>
  422. <h4>Parameters</h4>
  423. <table class="table table-condensed table-hover">
  424. <tr>
  425. <td></td>
  426. <td>$timeout </td>
  427. <td><p>in microseconds</p></td>
  428. </tr>
  429. </table>
  430. <h4>Throws</h4>
  431. <dl>
  432. <dt>\Grpc\Exception</dt>
  433. <dd><p>if channel is in FATAL_ERROR state</p></dd>
  434. </dl>
  435. <h4>Returns</h4>
  436. boolean
  437. &mdash; <p>true if channel is ready</p>
  438. </article>
  439. </div>
  440. <aside class="span4 detailsbar">
  441. <h1><i class="icon-arrow-down"></i></h1>
  442. <dl>
  443. </dl>
  444. <h2>Tags</h2>
  445. <table class="table table-condensed">
  446. <tr><td colspan="2"><em>None found</em></td></tr>
  447. </table>
  448. </aside>
  449. </div>
  450. <div class="row-fluid">
  451. <div class="span8 content class">
  452. <a id="method_close" name="method_close" class="anchor"></a>
  453. <article class="method">
  454. <h3 class="public ">close()</h3>
  455. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  456. <pre class="signature" style="margin-right: 54px;">close() </pre>
  457. <p><em>Close the communication channel associated with this stub</em></p>
  458. </article>
  459. </div>
  460. <aside class="span4 detailsbar">
  461. <h1><i class="icon-arrow-down"></i></h1>
  462. <dl>
  463. </dl>
  464. <h2>Tags</h2>
  465. <table class="table table-condensed">
  466. <tr><td colspan="2"><em>None found</em></td></tr>
  467. </table>
  468. </aside>
  469. </div>
  470. <div class="row-fluid">
  471. <div class="span8 content class">
  472. <a id="method__simpleRequest" name="method__simpleRequest" class="anchor"></a>
  473. <article class="method">
  474. <h3 class="public ">_simpleRequest()</h3>
  475. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  476. <pre class="signature" style="margin-right: 54px;">_simpleRequest(string <span class="argument">$method</span>, <span class="argument">$argument</span>, callable <span class="argument">$deserialize</span>, array <span class="argument">$metadata = array()</span>) : \Grpc\SimpleSurfaceActiveCall</pre>
  477. <p><em>Call a remote method that takes a single argument and has a single output</em></p>
  478. <h4>Parameters</h4>
  479. <table class="table table-condensed table-hover">
  480. <tr>
  481. <td>string</td>
  482. <td>$method </td>
  483. <td><p>The name of the method to call</p></td>
  484. </tr>
  485. <tr>
  486. <td></td>
  487. <td>$argument </td>
  488. <td><p>The argument to the method</p></td>
  489. </tr>
  490. <tr>
  491. <td>callable</td>
  492. <td>$deserialize </td>
  493. <td><p>A function that deserializes the response</p></td>
  494. </tr>
  495. <tr>
  496. <td>array</td>
  497. <td>$metadata </td>
  498. <td><p>A metadata map to send to the server</p></td>
  499. </tr>
  500. </table>
  501. <h4>Returns</h4>
  502. \Grpc\SimpleSurfaceActiveCall
  503. &mdash; <p>The active call object</p>
  504. </article>
  505. </div>
  506. <aside class="span4 detailsbar">
  507. <h1><i class="icon-arrow-down"></i></h1>
  508. <dl>
  509. </dl>
  510. <h2>Tags</h2>
  511. <table class="table table-condensed">
  512. <tr><td colspan="2"><em>None found</em></td></tr>
  513. </table>
  514. </aside>
  515. </div>
  516. <div class="row-fluid">
  517. <div class="span8 content class">
  518. <a id="method__clientStreamRequest" name="method__clientStreamRequest" class="anchor"></a>
  519. <article class="method">
  520. <h3 class="public ">_clientStreamRequest()</h3>
  521. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  522. <pre class="signature" style="margin-right: 54px;">_clientStreamRequest(string <span class="argument">$method</span>, <span class="argument">$arguments</span>, callable <span class="argument">$deserialize</span>, array <span class="argument">$metadata = array()</span>) : \Grpc\ClientStreamingSurfaceActiveCall</pre>
  523. <p><em>Call a remote method that takes a stream of arguments and has a single
  524. output</em></p>
  525. <h4>Parameters</h4>
  526. <table class="table table-condensed table-hover">
  527. <tr>
  528. <td>string</td>
  529. <td>$method </td>
  530. <td><p>The name of the method to call</p></td>
  531. </tr>
  532. <tr>
  533. <td></td>
  534. <td>$arguments </td>
  535. <td><p>An array or Traversable of arguments to stream to the
  536. server</p></td>
  537. </tr>
  538. <tr>
  539. <td>callable</td>
  540. <td>$deserialize </td>
  541. <td><p>A function that deserializes the response</p></td>
  542. </tr>
  543. <tr>
  544. <td>array</td>
  545. <td>$metadata </td>
  546. <td><p>A metadata map to send to the server</p></td>
  547. </tr>
  548. </table>
  549. <h4>Returns</h4>
  550. \Grpc\ClientStreamingSurfaceActiveCall
  551. &mdash; <p>The active call object</p>
  552. </article>
  553. </div>
  554. <aside class="span4 detailsbar">
  555. <h1><i class="icon-arrow-down"></i></h1>
  556. <dl>
  557. </dl>
  558. <h2>Tags</h2>
  559. <table class="table table-condensed">
  560. <tr><td colspan="2"><em>None found</em></td></tr>
  561. </table>
  562. </aside>
  563. </div>
  564. <div class="row-fluid">
  565. <div class="span8 content class">
  566. <a id="method__serverStreamRequest" name="method__serverStreamRequest" class="anchor"></a>
  567. <article class="method">
  568. <h3 class="public ">_serverStreamRequest()</h3>
  569. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  570. <pre class="signature" style="margin-right: 54px;">_serverStreamRequest(string <span class="argument">$method</span>, <span class="argument">$argument</span>, callable <span class="argument">$deserialize</span>, array <span class="argument">$metadata = array()</span>) : \Grpc\ServerStreamingSurfaceActiveCall</pre>
  571. <p><em>Call a remote method that takes a single argument and returns a stream of
  572. responses</em></p>
  573. <h4>Parameters</h4>
  574. <table class="table table-condensed table-hover">
  575. <tr>
  576. <td>string</td>
  577. <td>$method </td>
  578. <td><p>The name of the method to call</p></td>
  579. </tr>
  580. <tr>
  581. <td></td>
  582. <td>$argument </td>
  583. <td><p>The argument to the method</p></td>
  584. </tr>
  585. <tr>
  586. <td>callable</td>
  587. <td>$deserialize </td>
  588. <td><p>A function that deserializes the responses</p></td>
  589. </tr>
  590. <tr>
  591. <td>array</td>
  592. <td>$metadata </td>
  593. <td><p>A metadata map to send to the server</p></td>
  594. </tr>
  595. </table>
  596. <h4>Returns</h4>
  597. \Grpc\ServerStreamingSurfaceActiveCall
  598. &mdash; <p>The active call object</p>
  599. </article>
  600. </div>
  601. <aside class="span4 detailsbar">
  602. <h1><i class="icon-arrow-down"></i></h1>
  603. <dl>
  604. </dl>
  605. <h2>Tags</h2>
  606. <table class="table table-condensed">
  607. <tr><td colspan="2"><em>None found</em></td></tr>
  608. </table>
  609. </aside>
  610. </div>
  611. <div class="row-fluid">
  612. <div class="span8 content class">
  613. <a id="method__bidiRequest" name="method__bidiRequest" class="anchor"></a>
  614. <article class="method">
  615. <h3 class="public ">_bidiRequest()</h3>
  616. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  617. <pre class="signature" style="margin-right: 54px;">_bidiRequest(string <span class="argument">$method</span>, callable <span class="argument">$deserialize</span>, array <span class="argument">$metadata = array()</span>) : \Grpc\BidiStreamingSurfaceActiveCall</pre>
  618. <p><em>Call a remote method with messages streaming in both directions</em></p>
  619. <h4>Parameters</h4>
  620. <table class="table table-condensed table-hover">
  621. <tr>
  622. <td>string</td>
  623. <td>$method </td>
  624. <td><p>The name of the method to call</p></td>
  625. </tr>
  626. <tr>
  627. <td>callable</td>
  628. <td>$deserialize </td>
  629. <td><p>A function that deserializes the responses</p></td>
  630. </tr>
  631. <tr>
  632. <td>array</td>
  633. <td>$metadata </td>
  634. <td><p>A metadata map to send to the server</p></td>
  635. </tr>
  636. </table>
  637. <h4>Returns</h4>
  638. \Grpc\BidiStreamingSurfaceActiveCall
  639. &mdash; <p>The active call object</p>
  640. </article>
  641. </div>
  642. <aside class="span4 detailsbar">
  643. <h1><i class="icon-arrow-down"></i></h1>
  644. <dl>
  645. </dl>
  646. <h2>Tags</h2>
  647. <table class="table table-condensed">
  648. <tr><td colspan="2"><em>None found</em></td></tr>
  649. </table>
  650. </aside>
  651. </div>
  652. <div class="row-fluid">
  653. <div class="span8 content class">
  654. <a id="method__checkConnectivityState" name="method__checkConnectivityState" class="anchor"></a>
  655. <article class="method">
  656. <h3 class="private ">_checkConnectivityState()</h3>
  657. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  658. <pre class="signature" style="margin-right: 54px;">_checkConnectivityState( <span class="argument">$new_state</span>) </pre>
  659. <p><em></em></p>
  660. <h4>Parameters</h4>
  661. <table class="table table-condensed table-hover">
  662. <tr>
  663. <td></td>
  664. <td>$new_state </td>
  665. <td></td>
  666. </tr>
  667. </table>
  668. </article>
  669. </div>
  670. <aside class="span4 detailsbar">
  671. <h1><i class="icon-arrow-down"></i></h1>
  672. <dl>
  673. </dl>
  674. <h2>Tags</h2>
  675. <table class="table table-condensed">
  676. <tr><td colspan="2"><em>None found</em></td></tr>
  677. </table>
  678. </aside>
  679. </div>
  680. <div class="row-fluid">
  681. <div class="span8 content class">
  682. <a id="method__get_jwt_aud_uri" name="method__get_jwt_aud_uri" class="anchor"></a>
  683. <article class="method">
  684. <h3 class="private ">_get_jwt_aud_uri()</h3>
  685. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  686. <pre class="signature" style="margin-right: 54px;">_get_jwt_aud_uri( <span class="argument">$method</span>) </pre>
  687. <p><em>constructs the auth uri for the jwt</em></p>
  688. <h4>Parameters</h4>
  689. <table class="table table-condensed table-hover">
  690. <tr>
  691. <td></td>
  692. <td>$method </td>
  693. <td></td>
  694. </tr>
  695. </table>
  696. </article>
  697. </div>
  698. <aside class="span4 detailsbar">
  699. <h1><i class="icon-arrow-down"></i></h1>
  700. <dl>
  701. </dl>
  702. <h2>Tags</h2>
  703. <table class="table table-condensed">
  704. <tr><td colspan="2"><em>None found</em></td></tr>
  705. </table>
  706. </aside>
  707. </div>
  708. <div class="row-fluid">
  709. <div class="span8 content class">
  710. <a id="method__extract_timeout_from_metadata" name="method__extract_timeout_from_metadata" class="anchor"></a>
  711. <article class="method">
  712. <h3 class="private ">_extract_timeout_from_metadata()</h3>
  713. <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
  714. <pre class="signature" style="margin-right: 54px;">_extract_timeout_from_metadata( <span class="argument">$metadata</span>) : \Grpc\list($metadata_copy,</pre>
  715. <p><em>extract $timeout from $metadata</em></p>
  716. <h4>Parameters</h4>
  717. <table class="table table-condensed table-hover">
  718. <tr>
  719. <td></td>
  720. <td>$metadata </td>
  721. <td><p>The metadata map</p></td>
  722. </tr>
  723. </table>
  724. <h4>Returns</h4>
  725. \Grpc\list($metadata_copy,
  726. &mdash; <p>$timeout)</p>
  727. </article>
  728. </div>
  729. <aside class="span4 detailsbar">
  730. <h1><i class="icon-arrow-down"></i></h1>
  731. <dl>
  732. </dl>
  733. <h2>Tags</h2>
  734. <table class="table table-condensed">
  735. <tr><td colspan="2"><em>None found</em></td></tr>
  736. </table>
  737. </aside>
  738. </div>
  739. </div>
  740. </section>
  741. <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
  742. <div class="modal-header">
  743. <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
  744. <h3 id="source-view-label">BaseStub.php</h3>
  745. </div>
  746. <div class="modal-body">
  747. <pre data-src="../files/BaseStub.php.txt" class="language-php line-numbers"></pre>
  748. </div>
  749. </div>
  750. <footer class="row-fluid">
  751. <section class="span10 offset2">
  752. <section class="row-fluid">
  753. <section class="span10 offset1">
  754. <section class="row-fluid footer-sections">
  755. <section class="span4">
  756. <h1><i class="icon-code"></i></h1>
  757. <div>
  758. <ul>
  759. <li><a href="../namespaces/Grpc.html">\Grpc</a></li>
  760. </ul>
  761. </div>
  762. </section>
  763. <section class="span4">
  764. <h1><i class="icon-bar-chart"></i></h1>
  765. <div>
  766. <ul>
  767. <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
  768. </ul>
  769. </div>
  770. </section>
  771. <section class="span4">
  772. <h1><i class="icon-pushpin"></i></h1>
  773. <div>
  774. <ul>
  775. <li><a href="../reports/errors.html">Errors</a></li>
  776. <li><a href="../reports/markers.html">Markers</a></li>
  777. </ul>
  778. </div>
  779. </section>
  780. </section>
  781. </section>
  782. </section>
  783. <section class="row-fluid">
  784. <section class="span10 offset1">
  785. <hr />
  786. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
  787. on August 27th, 2015 at 19:22.
  788. </section>
  789. </section>
  790. </section>
  791. </footer>
  792. </div>
  793. </body>
  794. </html>