Grpc.AbstractCall.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596
  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-2105524614"></a>
  131. <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
  132. </div>
  133. <div id="namespace-2105524614" 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-1200721949"></a>
  139. <a href="../namespaces/Grpc.html" style="margin-left: 30px; padding-left: 0">Grpc</a>
  140. </div>
  141. <div id="namespace-1200721949" 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>AbstractCall</h1>
  172. <p><em></em></p>
  173. <section id="summary">
  174. <h2>Summary</h2>
  175. <section class="row-fluid heading">
  176. <section class="span4">
  177. <a href="#methods">Methods</a>
  178. </section>
  179. <section class="span4">
  180. <a href="#properties">Properties</a>
  181. </section>
  182. <section class="span4">
  183. <a href="#constants">Constants</a>
  184. </section>
  185. </section>
  186. <section class="row-fluid public">
  187. <section class="span4">
  188. <a href="../classes/Grpc.AbstractCall.html#method___construct" class="">__construct()</a><br />
  189. <a href="../classes/Grpc.AbstractCall.html#method_getMetadata" class="">getMetadata()</a><br />
  190. <a href="../classes/Grpc.AbstractCall.html#method_getPeer" class="">getPeer()</a><br />
  191. <a href="../classes/Grpc.AbstractCall.html#method_cancel" class="">cancel()</a><br />
  192. </section>
  193. <section class="span4">
  194. <em>No public properties found</em>
  195. </section>
  196. <section class="span4">
  197. <em>No constants found</em>
  198. </section>
  199. </section>
  200. <section class="row-fluid protected">
  201. <section class="span4">
  202. <a href="../classes/Grpc.AbstractCall.html#method_deserializeResponse" class="">deserializeResponse()</a><br />
  203. </section>
  204. <section class="span4">
  205. <a href="../classes/Grpc.AbstractCall.html#property_call" class="">$call</a><br />
  206. <a href="../classes/Grpc.AbstractCall.html#property_deserialize" class="">$deserialize</a><br />
  207. <a href="../classes/Grpc.AbstractCall.html#property_metadata" class="">$metadata</a><br />
  208. </section>
  209. <section class="span4">
  210. <em>N/A</em>
  211. </section>
  212. </section>
  213. <section class="row-fluid private">
  214. <section class="span4">
  215. <em>No private methods found</em>
  216. </section>
  217. <section class="span4">
  218. <em>No private properties found</em>
  219. </section>
  220. <section class="span4">
  221. <em>N/A</em>
  222. </section>
  223. </section>
  224. </section>
  225. </div>
  226. <aside class="span4 detailsbar">
  227. <span class="label label-info">abstract</span>
  228. <dl>
  229. <dt>File</dt>
  230. <dd><a href="../files/AbstractCall.html"><div class="path-wrapper">AbstractCall.php</div></a></dd>
  231. <dt>Package</dt>
  232. <dd><div class="namespace-wrapper">Default</div></dd>
  233. <dt>Class hierarchy</dt>
  234. <dd class="hierarchy">
  235. <div class="namespace-wrapper">\Grpc\AbstractCall</div>
  236. </dd>
  237. </dl>
  238. <h2>Tags</h2>
  239. <table class="table table-condensed">
  240. <tr><td colspan="2"><em>None found</em></td></tr>
  241. </table>
  242. </aside>
  243. </div>
  244. <a id="properties" name="properties"></a>
  245. <div class="row-fluid">
  246. <div class="span8 content class">
  247. <h2>Properties</h2>
  248. </div>
  249. <aside class="span4 detailsbar"></aside>
  250. </div>
  251. <div class="row-fluid">
  252. <div class="span8 content class">
  253. <a id="property_call" name="property_call" class="anchor"></a>
  254. <article class="property">
  255. <h3 class="protected ">$call</h3>
  256. <pre class="signature">$call : </pre>
  257. <p><em></em></p>
  258. <h4>Type</h4>
  259. </article>
  260. </div>
  261. <aside class="span4 detailsbar">
  262. <h1><i class="icon-arrow-down"></i></h1>
  263. <dl>
  264. </dl>
  265. <h2>Tags</h2>
  266. <table class="table table-condensed">
  267. <tr><td colspan="2"><em>None found</em></td></tr>
  268. </table>
  269. </aside>
  270. </div>
  271. <div class="row-fluid">
  272. <div class="span8 content class">
  273. <a id="property_deserialize" name="property_deserialize" class="anchor"></a>
  274. <article class="property">
  275. <h3 class="protected ">$deserialize</h3>
  276. <pre class="signature">$deserialize : </pre>
  277. <p><em></em></p>
  278. <h4>Type</h4>
  279. </article>
  280. </div>
  281. <aside class="span4 detailsbar">
  282. <h1><i class="icon-arrow-down"></i></h1>
  283. <dl>
  284. </dl>
  285. <h2>Tags</h2>
  286. <table class="table table-condensed">
  287. <tr><td colspan="2"><em>None found</em></td></tr>
  288. </table>
  289. </aside>
  290. </div>
  291. <div class="row-fluid">
  292. <div class="span8 content class">
  293. <a id="property_metadata" name="property_metadata" class="anchor"></a>
  294. <article class="property">
  295. <h3 class="protected ">$metadata</h3>
  296. <pre class="signature">$metadata : </pre>
  297. <p><em></em></p>
  298. <h4>Type</h4>
  299. </article>
  300. </div>
  301. <aside class="span4 detailsbar">
  302. <h1><i class="icon-arrow-down"></i></h1>
  303. <dl>
  304. </dl>
  305. <h2>Tags</h2>
  306. <table class="table table-condensed">
  307. <tr><td colspan="2"><em>None found</em></td></tr>
  308. </table>
  309. </aside>
  310. </div>
  311. <a id="methods" name="methods"></a>
  312. <div class="row-fluid">
  313. <div class="span8 content class"><h2>Methods</h2></div>
  314. <aside class="span4 detailsbar"></aside>
  315. </div>
  316. <div class="row-fluid">
  317. <div class="span8 content class">
  318. <a id="method___construct" name="method___construct" class="anchor"></a>
  319. <article class="method">
  320. <h3 class="public ">__construct()</h3>
  321. <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>
  322. <pre class="signature" style="margin-right: 54px;">__construct(\Grpc\Channel <span class="argument">$channel</span>, string <span class="argument">$method</span>, callback <span class="argument">$deserialize</span>, <span class="argument">$timeout = false</span>) </pre>
  323. <p><em>Create a new Call wrapper object.</em></p>
  324. <h4>Parameters</h4>
  325. <table class="table table-condensed table-hover">
  326. <tr>
  327. <td>\Grpc\Channel</td>
  328. <td>$channel </td>
  329. <td><p>The channel to communicate on</p></td>
  330. </tr>
  331. <tr>
  332. <td>string</td>
  333. <td>$method </td>
  334. <td><p>The method to call on the remote server</p></td>
  335. </tr>
  336. <tr>
  337. <td>callback</td>
  338. <td>$deserialize </td>
  339. <td><p>A callback function to deserialize
  340. the response</p></td>
  341. </tr>
  342. <tr>
  343. <td></td>
  344. <td>$timeout </td>
  345. <td></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_getMetadata" name="method_getMetadata" class="anchor"></a>
  363. <article class="method">
  364. <h3 class="public ">getMetadata()</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;">getMetadata() : \Grpc\The</pre>
  367. <p><em></em></p>
  368. <h4>Returns</h4>
  369. \Grpc\The
  370. &mdash; <p>metadata sent by the server.</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_getPeer" name="method_getPeer" class="anchor"></a>
  386. <article class="method">
  387. <h3 class="public ">getPeer()</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;">getPeer() : string</pre>
  390. <p><em></em></p>
  391. <h4>Returns</h4>
  392. string
  393. &mdash; <p>The URI of the endpoint.</p>
  394. </article>
  395. </div>
  396. <aside class="span4 detailsbar">
  397. <h1><i class="icon-arrow-down"></i></h1>
  398. <dl>
  399. </dl>
  400. <h2>Tags</h2>
  401. <table class="table table-condensed">
  402. <tr><td colspan="2"><em>None found</em></td></tr>
  403. </table>
  404. </aside>
  405. </div>
  406. <div class="row-fluid">
  407. <div class="span8 content class">
  408. <a id="method_cancel" name="method_cancel" class="anchor"></a>
  409. <article class="method">
  410. <h3 class="public ">cancel()</h3>
  411. <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>
  412. <pre class="signature" style="margin-right: 54px;">cancel() </pre>
  413. <p><em>Cancels the call</em></p>
  414. </article>
  415. </div>
  416. <aside class="span4 detailsbar">
  417. <h1><i class="icon-arrow-down"></i></h1>
  418. <dl>
  419. </dl>
  420. <h2>Tags</h2>
  421. <table class="table table-condensed">
  422. <tr><td colspan="2"><em>None found</em></td></tr>
  423. </table>
  424. </aside>
  425. </div>
  426. <div class="row-fluid">
  427. <div class="span8 content class">
  428. <a id="method_deserializeResponse" name="method_deserializeResponse" class="anchor"></a>
  429. <article class="method">
  430. <h3 class="protected ">deserializeResponse()</h3>
  431. <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>
  432. <pre class="signature" style="margin-right: 54px;">deserializeResponse(string <span class="argument">$value</span>) : \Grpc\The</pre>
  433. <p><em>Deserialize a response value to an object.</em></p>
  434. <h4>Parameters</h4>
  435. <table class="table table-condensed table-hover">
  436. <tr>
  437. <td>string</td>
  438. <td>$value </td>
  439. <td><p>The binary value to deserialize</p></td>
  440. </tr>
  441. </table>
  442. <h4>Returns</h4>
  443. \Grpc\The
  444. &mdash; <p>deserialized value</p>
  445. </article>
  446. </div>
  447. <aside class="span4 detailsbar">
  448. <h1><i class="icon-arrow-down"></i></h1>
  449. <dl>
  450. </dl>
  451. <h2>Tags</h2>
  452. <table class="table table-condensed">
  453. <tr><td colspan="2"><em>None found</em></td></tr>
  454. </table>
  455. </aside>
  456. </div>
  457. </div>
  458. </section>
  459. <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
  460. <div class="modal-header">
  461. <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
  462. <h3 id="source-view-label">AbstractCall.php</h3>
  463. </div>
  464. <div class="modal-body">
  465. <pre data-src="../files/AbstractCall.php.txt" class="language-php line-numbers"></pre>
  466. </div>
  467. </div>
  468. <footer class="row-fluid">
  469. <section class="span10 offset2">
  470. <section class="row-fluid">
  471. <section class="span10 offset1">
  472. <section class="row-fluid footer-sections">
  473. <section class="span4">
  474. <h1><i class="icon-code"></i></h1>
  475. <div>
  476. <ul>
  477. <li><a href="../namespaces/Grpc.html">\Grpc</a></li>
  478. </ul>
  479. </div>
  480. </section>
  481. <section class="span4">
  482. <h1><i class="icon-bar-chart"></i></h1>
  483. <div>
  484. <ul>
  485. <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
  486. </ul>
  487. </div>
  488. </section>
  489. <section class="span4">
  490. <h1><i class="icon-pushpin"></i></h1>
  491. <div>
  492. <ul>
  493. <li><a href="../reports/errors.html">Errors</a></li>
  494. <li><a href="../reports/markers.html">Markers</a></li>
  495. </ul>
  496. </div>
  497. </section>
  498. </section>
  499. </section>
  500. </section>
  501. <section class="row-fluid">
  502. <section class="span10 offset1">
  503. <hr />
  504. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
  505. on August 27th, 2015 at 19:22.
  506. </section>
  507. </section>
  508. </section>
  509. </footer>
  510. </div>
  511. </body>
  512. </html>