5 <title>JSDoc: Class: RPCMethod</title>
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
20 <h1 class="page-title">Class: RPCMethod</h1>
32 <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a><a href="ProtoBuf.Reflect.Service.html">.Service</a>.</span>
41 <div class="container-overview">
47 <h4 class="name" id="RPCMethod"><span class="type-signature"></span>new RPCMethod<span class="signature">(builder<span class="signature-attributes">non-null</span>, svc<span class="signature-attributes">non-null</span>, name, request, response, request_stream, response_stream, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
53 <div class="description">
54 <p>RPC service method.</p>
68 <table class="params">
83 <th class="last">Description</th>
92 <td class="name"><code>builder</code></td>
98 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
105 <td class="attributes">
116 <td class="description last"><p>Builder reference</p></td>
123 <td class="name"><code>svc</code></td>
129 <span class="param-type"><a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span>
136 <td class="attributes">
147 <td class="description last"><p>Service</p></td>
154 <td class="name"><code>name</code></td>
160 <span class="param-type">string</span>
167 <td class="attributes">
178 <td class="description last"><p>Method name</p></td>
185 <td class="name"><code>request</code></td>
191 <span class="param-type">string</span>
198 <td class="attributes">
209 <td class="description last"><p>Request message name</p></td>
216 <td class="name"><code>response</code></td>
222 <span class="param-type">string</span>
229 <td class="attributes">
240 <td class="description last"><p>Response message name</p></td>
247 <td class="name"><code>request_stream</code></td>
253 <span class="param-type">boolean</span>
260 <td class="attributes">
271 <td class="description last"><p>Whether requests are streamed</p></td>
278 <td class="name"><code>response_stream</code></td>
284 <span class="param-type">boolean</span>
291 <td class="attributes">
302 <td class="description last"><p>Whether responses are streamed</p></td>
309 <td class="name"><code>options</code></td>
315 <span class="param-type">Object.<string, *></span>
322 <td class="attributes">
335 <td class="description last"><p>Options</p></td>
374 <dt class="tag-source">Source:</dt>
375 <dd class="tag-source"><ul class="dummy"><li>
376 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4217">line 4217</a>
406 <h3 class="subsection-title">Extends</h3>
412 <li><a href="ProtoBuf.Reflect.Service.Method.html">ProtoBuf.Reflect.Service.Method</a></li>
427 <h3 class="subsection-title">Members</h3>
431 <h4 class="name" id="builder"><span class="type-signature">(non-null) </span>builder<span class="type-signature"> :<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span></h4>
436 <div class="description">
437 <p>Builder reference.</p>
446 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
463 <dt class="inherited-from">Inherited From:</dt>
464 <dd class="inherited-from"><ul class="dummy"><li>
465 <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
488 <dt class="tag-source">Source:</dt>
489 <dd class="tag-source"><ul class="dummy"><li>
490 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
508 <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
513 <div class="description">
514 <p>Fully qualified class name</p>
523 <span class="param-type">string</span>
542 <dt class="tag-overrides">Overrides:</dt>
543 <dd class="tag-overrides"><ul class="dummy"><li>
544 <a href="ProtoBuf.Reflect.Service.Method.html#className">ProtoBuf.Reflect.Service.Method#className</a>
565 <dt class="tag-source">Source:</dt>
566 <dd class="tag-source"><ul class="dummy"><li>
567 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
585 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
590 <div class="description">
591 <p>Object name in namespace.</p>
600 <span class="param-type">string</span>
617 <dt class="inherited-from">Inherited From:</dt>
618 <dd class="inherited-from"><ul class="dummy"><li>
619 <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
642 <dt class="tag-source">Source:</dt>
643 <dd class="tag-source"><ul class="dummy"><li>
644 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
662 <h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object.<string, *></span></h4>
667 <div class="description">
677 <span class="param-type">Object.<string, *></span>
694 <dt class="inherited-from">Inherited From:</dt>
695 <dd class="inherited-from"><ul class="dummy"><li>
696 <a href="ProtoBuf.Reflect.Service.Method.html#options">ProtoBuf.Reflect.Service.Method#options</a>
719 <dt class="tag-source">Source:</dt>
720 <dd class="tag-source"><ul class="dummy"><li>
721 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4180">line 4180</a>
739 <h4 class="name" id="parent"><span class="type-signature">(nullable) </span>parent<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span></h4>
744 <div class="description">
745 <p>Parent object.</p>
754 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
771 <dt class="inherited-from">Inherited From:</dt>
772 <dd class="inherited-from"><ul class="dummy"><li>
773 <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
796 <dt class="tag-source">Source:</dt>
797 <dd class="tag-source"><ul class="dummy"><li>
798 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
816 <h4 class="name" id="requestName"><span class="type-signature"></span>requestName<span class="type-signature"> :string</span></h4>
821 <div class="description">
822 <p>Request message name.</p>
831 <span class="param-type">string</span>
868 <dt class="tag-source">Source:</dt>
869 <dd class="tag-source"><ul class="dummy"><li>
870 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4230">line 4230</a>
888 <h4 class="name" id="requestStream"><span class="type-signature"></span>requestStream<span class="type-signature"> :bool</span></h4>
893 <div class="description">
894 <p>Whether requests are streamed</p>
903 <span class="param-type">bool</span>
940 <dt class="tag-source">Source:</dt>
941 <dd class="tag-source"><ul class="dummy"><li>
942 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4244">line 4244</a>
960 <h4 class="name" id="resolvedRequestType"><span class="type-signature"></span>resolvedRequestType<span class="type-signature"> :<a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span></h4>
965 <div class="description">
966 <p>Resolved request message type.</p>
975 <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
1012 <dt class="tag-source">Source:</dt>
1013 <dd class="tag-source"><ul class="dummy"><li>
1014 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4258">line 4258</a>
1032 <h4 class="name" id="resolvedResponseType"><span class="type-signature"></span>resolvedResponseType<span class="type-signature"> :<a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span></h4>
1037 <div class="description">
1038 <p>Resolved response message type.</p>
1047 <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
1057 <dl class="details">
1084 <dt class="tag-source">Source:</dt>
1085 <dd class="tag-source"><ul class="dummy"><li>
1086 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4265">line 4265</a>
1104 <h4 class="name" id="responseName"><span class="type-signature"></span>responseName<span class="type-signature"> :string</span></h4>
1109 <div class="description">
1110 <p>Response message name.</p>
1119 <span class="param-type">string</span>
1129 <dl class="details">
1156 <dt class="tag-source">Source:</dt>
1157 <dd class="tag-source"><ul class="dummy"><li>
1158 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4237">line 4237</a>
1176 <h4 class="name" id="responseStream"><span class="type-signature"></span>responseStream<span class="type-signature"> :bool</span></h4>
1181 <div class="description">
1182 <p>Whether responses are streamed</p>
1191 <span class="param-type">bool</span>
1201 <dl class="details">
1228 <dt class="tag-source">Source:</dt>
1229 <dd class="tag-source"><ul class="dummy"><li>
1230 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4251">line 4251</a>
1250 <h3 class="subsection-title">Methods</h3>
1257 <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
1263 <div class="description">
1264 <p>Builds this type.</p>
1279 <dl class="details">
1286 <dt class="inherited-from">Inherited From:</dt>
1287 <dd class="inherited-from"><ul class="dummy"><li>
1288 <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
1311 <dt class="tag-source">Source:</dt>
1312 <dd class="tag-source"><ul class="dummy"><li>
1313 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
1340 <div class="param-desc">
1341 <p>If this type cannot be built directly</p>
1352 <span class="param-type">Error</span>
1373 <h4 class="name" id="buildOpt"><span class="type-signature"></span>buildOpt<span class="signature">()</span><span class="type-signature"> → {Object.<string, *>}</span></h4>
1379 <div class="description">
1380 <p>Builds the method's '$options' property.</p>
1395 <dl class="details">
1402 <dt class="inherited-from">Inherited From:</dt>
1403 <dd class="inherited-from"><ul class="dummy"><li>
1404 <a href="ProtoBuf.Reflect.Service.Method.html#buildOpt">ProtoBuf.Reflect.Service.Method#buildOpt</a>
1427 <dt class="tag-source">Source:</dt>
1428 <dd class="tag-source"><ul class="dummy"><li>
1429 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4189">line 4189</a>
1463 <span class="param-type">Object.<string, *></span>
1478 <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
1484 <div class="description">
1485 <p>Returns the fully qualified name of this object.</p>
1500 <dl class="details">
1507 <dt class="inherited-from">Inherited From:</dt>
1508 <dd class="inherited-from"><ul class="dummy"><li>
1509 <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
1532 <dt class="tag-source">Source:</dt>
1533 <dd class="tag-source"><ul class="dummy"><li>
1534 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
1560 <div class="param-desc">
1561 <p>Fully qualified name as of ".PATH.TO.THIS"</p>
1572 <span class="param-type">string</span>
1587 <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">(includeClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
1593 <div class="description">
1594 <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
1605 <h5>Parameters:</h5>
1608 <table class="params">
1623 <th class="last">Description</th>
1632 <td class="name"><code>includeClass</code></td>
1638 <span class="param-type">boolean</span>
1645 <td class="attributes">
1658 <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
1670 <dl class="details">
1677 <dt class="inherited-from">Inherited From:</dt>
1678 <dd class="inherited-from"><ul class="dummy"><li>
1679 <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
1702 <dt class="tag-source">Source:</dt>
1703 <dd class="tag-source"><ul class="dummy"><li>
1704 <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
1730 <div class="param-desc">
1731 <p>String representation</p>
1756 <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ProtoBuf.Builder.html">Builder</a></li><li><a href="ProtoBuf.Builder.Message.html">Message</a></li><li><a href="ProtoBuf.Builder.Service.html">Service</a></li><li><a href="ProtoBuf.DotProto.Parser.html">Parser</a></li><li><a href="ProtoBuf.DotProto.Tokenizer.html">Tokenizer</a></li><li><a href="ProtoBuf.Map.html">Map</a></li><li><a href="ProtoBuf.Reflect.Element.html">Element</a></li><li><a href="ProtoBuf.Reflect.Enum.html">Enum</a></li><li><a href="ProtoBuf.Reflect.Enum.Value.html">Value</a></li><li><a href="ProtoBuf.Reflect.Extension.html">Extension</a></li><li><a href="ProtoBuf.Reflect.Message.html">Message</a></li><li><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></li><li><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></li><li><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></li><li><a href="ProtoBuf.Reflect.Namespace.html">Namespace</a></li><li><a href="ProtoBuf.Reflect.Service.html">Service</a></li><li><a href="ProtoBuf.Reflect.Service.Method.html">Method</a></li><li><a href="ProtoBuf.Reflect.Service.RPCMethod.html">RPCMethod</a></li><li><a href="ProtoBuf.Reflect.T.html">T</a></li></ul><h3>Namespaces</h3><ul><li><a href="ProtoBuf.html">ProtoBuf</a></li><li><a href="ProtoBuf.DotProto.html">DotProto</a></li><li><a href="ProtoBuf.Reflect.html">Reflect</a></li><li><a href="ProtoBuf.Util.html">Util</a></li></ul>
1762 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Jan 27 2017 17:03:55 GMT+0100 (Mitteleuropäische Zeit)
1765 <script> prettyPrint(); </script>
1766 <script src="scripts/linenumber.js"> </script>