123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
- <meta charset="utf-8"/>
- <title>API Documentation</title>
- <meta name="author" content=""/>
- <meta name="description" content=""/>
- <link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
- <link href="../css/font-awesome.min.css" rel="stylesheet">
- <link href="../css/prism.css" rel="stylesheet" media="all"/>
- <link href="../css/template.css" rel="stylesheet" media="all"/>
-
- <!--[if lt IE 9]>
- <script src="../js/html5.js"></script>
- <![endif]-->
- <script src="../js/jquery-1.11.0.min.js"></script>
- <script src="../js/ui/1.10.4/jquery-ui.min.js"></script>
- <script src="../js/bootstrap.min.js"></script>
- <script src="../js/jquery.smooth-scroll.js"></script>
- <script src="../js/prism.min.js"></script>
- <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
- <script type="text/javascript">
- function loadExternalCodeSnippets() {
- Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
- var src = pre.getAttribute('data-src');
- var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
- var language = 'php';
- var code = document.createElement('code');
- code.className = 'language-' + language;
- pre.textContent = '';
- code.textContent = 'Loading…';
- pre.appendChild(code);
- var xhr = new XMLHttpRequest();
- xhr.open('GET', src, true);
- xhr.onreadystatechange = function () {
- if (xhr.readyState == 4) {
- if (xhr.status < 400 && xhr.responseText) {
- code.textContent = xhr.responseText;
- Prism.highlightElement(code);
- }
- else if (xhr.status >= 400) {
- code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
- }
- else {
- code.textContent = '✖ Error: File does not exist or is empty';
- }
- }
- };
- xhr.send(null);
- });
- }
- $(document).ready(function(){
- loadExternalCodeSnippets();
- });
- $('#source-view').on('shown', function () {
- loadExternalCodeSnippets();
- })
- </script>
- <link rel="shortcut icon" href="../images/favicon.ico"/>
- <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
- <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
- <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
- </head>
- <body>
- <div class="navbar navbar-fixed-top">
- <div class="navbar-inner">
- <div class="container">
- <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
- <i class="icon-ellipsis-vertical"></i>
- </a>
- <a class="brand" href="../index.html">API Documentation</a>
- <div class="nav-collapse">
- <ul class="nav pull-right">
- <li class="dropdown">
- <a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
- API Documentation <b class="caret"></b>
- </a>
- <ul class="dropdown-menu">
- <li><a href="../namespaces/Grpc.html">\Grpc</a></li>
- </ul>
- </li>
- <li class="dropdown" id="charts-menu">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">
- Charts <b class="caret"></b>
- </a>
- <ul class="dropdown-menu">
- <li>
- <a href="../graphs/class.html">
- <i class="icon-list-alt"></i> Class hierarchy diagram
- </a>
- </li>
- </ul>
- </li>
- <li class="dropdown" id="reports-menu">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">
- Reports <b class="caret"></b>
- </a>
- <ul class="dropdown-menu">
- <li>
- <a href="../reports/errors.html">
- <i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">23</span>
- </a>
- </li>
- <li>
- <a href="../reports/markers.html">
- <i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">0</span>
- </a>
- </li>
- <li>
- <a href="../reports/deprecated.html">
- <i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span>
- </a>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- </div>
- <!--<div class="go_to_top">-->
- <!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>-->
- <!--</div>-->
- </div>
- <div id="___" class="container-fluid">
- <section class="row-fluid">
- <div class="span2 sidebar">
- <div class="accordion" style="margin-bottom: 0">
- <div class="accordion-group">
- <div class="accordion-heading">
- <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-830634965"></a>
- <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
- </div>
- <div id="namespace-830634965" class="accordion-body collapse in">
- <div class="accordion-inner">
- <div class="accordion" style="margin-bottom: 0">
- <div class="accordion-group">
- <div class="accordion-heading">
- <a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1553239548"></a>
- <a href="../namespaces/Grpc.html" style="margin-left: 30px; padding-left: 0">Grpc</a>
- </div>
- <div id="namespace-1553239548" class="accordion-body collapse ">
- <div class="accordion-inner">
-
- <ul>
- <li class="class"><a href="../classes/Grpc.AbstractCall.html">AbstractCall</a></li>
- <li class="class"><a href="../classes/Grpc.BaseStub.html">BaseStub</a></li>
- <li class="class"><a href="../classes/Grpc.BidiStreamingCall.html">BidiStreamingCall</a></li>
- <li class="class"><a href="../classes/Grpc.ClientStreamingCall.html">ClientStreamingCall</a></li>
- <li class="class"><a href="../classes/Grpc.ServerStreamingCall.html">ServerStreamingCall</a></li>
- <li class="class"><a href="../classes/Grpc.UnaryCall.html">UnaryCall</a></li>
- </ul>
- </div>
- </div>
- </div>
- </div>
-
- <ul>
- </ul>
- </div>
- </div>
- </div>
- </div>
- </div>
- </section>
- <section class="row-fluid">
- <div class="span10 offset2">
- <div class="row-fluid">
- <div class="span8 content class">
- <nav>
- <a href="../namespaces/Grpc.html">\Grpc</a> <i class="icon-level-up"></i>
- </nav>
- <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
- <h1><small>\Grpc</small>ClientStreamingCall</h1>
- <p><em>Represents an active call that sends a stream of messages and then gets a
- single response.</em></p>
-
-
-
- <section id="summary">
- <h2>Summary</h2>
- <section class="row-fluid heading">
- <section class="span4">
- <a href="#methods">Methods</a>
- </section>
- <section class="span4">
- <a href="#properties">Properties</a>
- </section>
- <section class="span4">
- <a href="#constants">Constants</a>
- </section>
- </section>
- <section class="row-fluid public">
- <section class="span4">
- <a href="../classes/Grpc.AbstractCall.html#method___construct" class="">__construct()</a><br />
- <a href="../classes/Grpc.AbstractCall.html#method_getMetadata" class="">getMetadata()</a><br />
- <a href="../classes/Grpc.AbstractCall.html#method_getPeer" class="">getPeer()</a><br />
- <a href="../classes/Grpc.AbstractCall.html#method_cancel" class="">cancel()</a><br />
- <a href="../classes/Grpc.ClientStreamingCall.html#method_start" class="">start()</a><br />
- <a href="../classes/Grpc.ClientStreamingCall.html#method_wait" class="">wait()</a><br />
- </section>
- <section class="span4">
- <em>No public properties found</em>
- </section>
- <section class="span4">
- <em>No constants found</em>
- </section>
- </section>
- <section class="row-fluid protected">
- <section class="span4">
- <a href="../classes/Grpc.AbstractCall.html#method_deserializeResponse" class="">deserializeResponse()</a><br />
- </section>
- <section class="span4">
- <a href="../classes/Grpc.AbstractCall.html#property_call" class="">$call</a><br />
- <a href="../classes/Grpc.AbstractCall.html#property_deserialize" class="">$deserialize</a><br />
- <a href="../classes/Grpc.AbstractCall.html#property_metadata" class="">$metadata</a><br />
- </section>
- <section class="span4">
- <em>N/A</em>
- </section>
- </section>
- <section class="row-fluid private">
- <section class="span4">
- <em>No private methods found</em>
- </section>
- <section class="span4">
- <em>No private properties found</em>
- </section>
- <section class="span4">
- <em>N/A</em>
- </section>
- </section>
- </section>
- </div>
- <aside class="span4 detailsbar">
-
-
- <dl>
- <dt>File</dt>
- <dd><a href="../files/ClientStreamingCall.html"><div class="path-wrapper">ClientStreamingCall.php</div></a></dd>
- <dt>Package</dt>
- <dd><div class="namespace-wrapper">Default</div></dd>
- <dt>Class hierarchy</dt>
- <dd class="hierarchy">
-
- <div class="namespace-wrapper"><a href="../classes/Grpc.AbstractCall.html">\Grpc\AbstractCall</a></div>
- <div class="namespace-wrapper">\Grpc\ClientStreamingCall</div>
- </dd>
-
-
-
-
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
-
- <a id="properties" name="properties"></a>
- <div class="row-fluid">
- <div class="span8 content class">
- <h2>Properties</h2>
- </div>
- <aside class="span4 detailsbar"></aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="property_call" name="property_call" class="anchor"></a>
- <article class="property">
- <h3 class="protected ">$call</h3>
- <pre class="signature">$call : </pre>
- <p><em></em></p>
-
- <h4>Type</h4>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="property_deserialize" name="property_deserialize" class="anchor"></a>
- <article class="property">
- <h3 class="protected ">$deserialize</h3>
- <pre class="signature">$deserialize : </pre>
- <p><em></em></p>
-
- <h4>Type</h4>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="property_metadata" name="property_metadata" class="anchor"></a>
- <article class="property">
- <h3 class="protected ">$metadata</h3>
- <pre class="signature">$metadata : </pre>
- <p><em></em></p>
-
- <h4>Type</h4>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
-
- <a id="methods" name="methods"></a>
- <div class="row-fluid">
- <div class="span8 content class"><h2>Methods</h2></div>
- <aside class="span4 detailsbar"></aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method___construct" name="method___construct" class="anchor"></a>
- <article class="method">
- <h3 class="public ">__construct()</h3>
- <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>
- <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>
- <p><em>Create a new Call wrapper object.</em></p>
-
- <h4>Parameters</h4>
- <table class="table table-condensed table-hover">
- <tr>
- <td>\Grpc\Channel</td>
- <td>$channel </td>
- <td><p>The channel to communicate on</p></td>
- </tr>
- <tr>
- <td>string</td>
- <td>$method </td>
- <td><p>The method to call on the remote server</p></td>
- </tr>
- <tr>
- <td>callback</td>
- <td>$deserialize </td>
- <td><p>A callback function to deserialize
- the response</p></td>
- </tr>
- <tr>
- <td></td>
- <td>$timeout </td>
- <td></td>
- </tr>
- </table>
-
-
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method_getMetadata" name="method_getMetadata" class="anchor"></a>
- <article class="method">
- <h3 class="public ">getMetadata()</h3>
- <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>
- <pre class="signature" style="margin-right: 54px;">getMetadata() : \Grpc\The</pre>
- <p><em></em></p>
-
-
-
- <h4>Returns</h4>
- \Grpc\The
- — <p>metadata sent by the server.</p>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method_getPeer" name="method_getPeer" class="anchor"></a>
- <article class="method">
- <h3 class="public ">getPeer()</h3>
- <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>
- <pre class="signature" style="margin-right: 54px;">getPeer() : string</pre>
- <p><em></em></p>
-
-
-
- <h4>Returns</h4>
- string
- — <p>The URI of the endpoint.</p>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method_cancel" name="method_cancel" class="anchor"></a>
- <article class="method">
- <h3 class="public ">cancel()</h3>
- <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>
- <pre class="signature" style="margin-right: 54px;">cancel() </pre>
- <p><em>Cancels the call</em></p>
-
-
-
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method_start" name="method_start" class="anchor"></a>
- <article class="method">
- <h3 class="public ">start()</h3>
- <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>
- <pre class="signature" style="margin-right: 54px;">start(\Grpc\Traversable <span class="argument">$arg_iter</span>, array <span class="argument">$metadata = array()</span>) </pre>
- <p><em>Start the call.</em></p>
-
- <h4>Parameters</h4>
- <table class="table table-condensed table-hover">
- <tr>
- <td>\Grpc\Traversable</td>
- <td>$arg_iter </td>
- <td><p>The iterator of arguments to send</p></td>
- </tr>
- <tr>
- <td>array</td>
- <td>$metadata </td>
- <td><p>Metadata to send with the call, if applicable</p></td>
- </tr>
- </table>
-
-
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method_wait" name="method_wait" class="anchor"></a>
- <article class="method">
- <h3 class="public ">wait()</h3>
- <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>
- <pre class="signature" style="margin-right: 54px;">wait() : \Grpc\[response</pre>
- <p><em>Wait for the server to respond with data and a status</em></p>
-
-
-
- <h4>Returns</h4>
- \Grpc\[response
- — <p>data, status]</p>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- <div class="row-fluid">
- <div class="span8 content class">
- <a id="method_deserializeResponse" name="method_deserializeResponse" class="anchor"></a>
- <article class="method">
- <h3 class="protected ">deserializeResponse()</h3>
- <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>
- <pre class="signature" style="margin-right: 54px;">deserializeResponse(string <span class="argument">$value</span>) : \Grpc\The</pre>
- <p><em>Deserialize a response value to an object.</em></p>
-
- <h4>Parameters</h4>
- <table class="table table-condensed table-hover">
- <tr>
- <td>string</td>
- <td>$value </td>
- <td><p>The binary value to deserialize</p></td>
- </tr>
- </table>
-
-
- <h4>Returns</h4>
- \Grpc\The
- — <p>deserialized value</p>
-
- </article>
- </div>
- <aside class="span4 detailsbar">
- <h1><i class="icon-arrow-down"></i></h1>
- <dl>
- <dt>Inherited from</dt>
- <dd><a href="../classes/Grpc.AbstractCall.html"><div class="path-wrapper">\Grpc\AbstractCall</div></a></dd>
- </dl>
- <h2>Tags</h2>
- <table class="table table-condensed">
- <tr><td colspan="2"><em>None found</em></td></tr>
- </table>
- </aside>
- </div>
- </div>
- </section>
- <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
- <h3 id="source-view-label">ClientStreamingCall.php</h3>
- </div>
- <div class="modal-body">
- <pre data-src="../files/ClientStreamingCall.php.txt" class="language-php line-numbers"></pre>
- </div>
- </div>
- <footer class="row-fluid">
- <section class="span10 offset2">
- <section class="row-fluid">
- <section class="span10 offset1">
- <section class="row-fluid footer-sections">
- <section class="span4">
- <h1><i class="icon-code"></i></h1>
- <div>
- <ul>
- <li><a href="../namespaces/Grpc.html">\Grpc</a></li>
- </ul>
- </div>
- </section>
- <section class="span4">
- <h1><i class="icon-bar-chart"></i></h1>
- <div>
- <ul>
- <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
- </ul>
- </div>
- </section>
- <section class="span4">
- <h1><i class="icon-pushpin"></i></h1>
- <div>
- <ul>
- <li><a href="../reports/errors.html">Errors</a></li>
- <li><a href="../reports/markers.html">Markers</a></li>
- </ul>
- </div>
- </section>
- </section>
- </section>
- </section>
- <section class="row-fluid">
- <section class="span10 offset1">
- <hr />
- Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
- on August 27th, 2015 at 19:22.
- </section>
- </section>
- </section>
- </footer>
- </div>
- </body>
- </html>
|