|
@@ -634,6 +634,185 @@ insecure credentials object</p>
|
|
|
|
|
|
|
|
|
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5>Returns:</h5>
|
|
|
+
|
|
|
+
|
|
|
+<div class="param-desc">
|
|
|
+ <p>The bound port number. Negative if binding the port failed.</p>
|
|
|
+</div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<dl>
|
|
|
+ <dt>
|
|
|
+ Type
|
|
|
+ </dt>
|
|
|
+ <dd>
|
|
|
+
|
|
|
+<span class="param-type">number</span>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </dd>
|
|
|
+</dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</dd>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<hr>
|
|
|
+<dt>
|
|
|
+ <h4 class="name" id="bindAsync"><span class="type-signature"></span>bindAsync(port, creds)</h4>
|
|
|
+
|
|
|
+
|
|
|
+</dt>
|
|
|
+<dd>
|
|
|
+
|
|
|
+
|
|
|
+ <div class="description">
|
|
|
+ <p>Binds the server to the given port, with SSL disabled if creds is an
|
|
|
+insecure credentials object. Provides the result asynchronously.</p>
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5>Parameters:</h5>
|
|
|
+
|
|
|
+
|
|
|
+<table class="params table table-striped">
|
|
|
+ <thead>
|
|
|
+ <tr>
|
|
|
+
|
|
|
+ <th>Name</th>
|
|
|
+
|
|
|
+
|
|
|
+ <th>Type</th>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <th class="last">Description</th>
|
|
|
+ </tr>
|
|
|
+ </thead>
|
|
|
+
|
|
|
+ <tbody>
|
|
|
+
|
|
|
+
|
|
|
+ <tr>
|
|
|
+
|
|
|
+ <td class="name"><code>port</code></td>
|
|
|
+
|
|
|
+
|
|
|
+ <td class="type">
|
|
|
+
|
|
|
+
|
|
|
+<span class="param-type">string</span>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </td>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <td class="description last"><p>The port that the server should bind on, in the format
|
|
|
+ "address:port"</p></td>
|
|
|
+ </tr>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <tr>
|
|
|
+
|
|
|
+ <td class="name"><code>creds</code></td>
|
|
|
+
|
|
|
+
|
|
|
+ <td class="type">
|
|
|
+
|
|
|
+
|
|
|
+<span class="param-type"><a href="grpc.ServerCredentials.html">grpc.ServerCredentials</a></span>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </td>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <td class="description last"><p>Server credential object to be used for
|
|
|
+ SSL. Pass an insecure credentials object for an insecure port.</p></td>
|
|
|
+ </tr>
|
|
|
+
|
|
|
+
|
|
|
+ </tbody>
|
|
|
+</table>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<dl class="details">
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
|
|
|
|
|
|
|
|
@@ -900,7 +1079,16 @@ a handler for the given method. Returns true on success</p>
|
|
|
<td class="type">
|
|
|
|
|
|
|
|
|
-<span class="param-type">string</span>
|
|
|
+<span class="param-type">'unary'</span>
|
|
|
+|
|
|
|
+
|
|
|
+<span class="param-type">'client_stream'</span>
|
|
|
+|
|
|
|
+
|
|
|
+<span class="param-type">'server_stream'</span>
|
|
|
+|
|
|
|
+
|
|
|
+<span class="param-type">'bidi'</span>
|
|
|
|
|
|
|
|
|
|
|
@@ -1217,6 +1405,179 @@ is idempotent with itself and forceShutdown.</p>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
+<hr>
|
|
|
+<dt>
|
|
|
+ <h4 class="name" id="~bindCallback"><span class="type-signature"></span>bindCallback( [error], port)</h4>
|
|
|
+
|
|
|
+
|
|
|
+</dt>
|
|
|
+<dd>
|
|
|
+
|
|
|
+
|
|
|
+ <div class="description">
|
|
|
+ <p>Called with the result of attempting to bind a port</p>
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <h5>Parameters:</h5>
|
|
|
+
|
|
|
+
|
|
|
+<table class="params table table-striped">
|
|
|
+ <thead>
|
|
|
+ <tr>
|
|
|
+
|
|
|
+ <th>Name</th>
|
|
|
+
|
|
|
+
|
|
|
+ <th>Type</th>
|
|
|
+
|
|
|
+
|
|
|
+ <th>Argument</th>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <th class="last">Description</th>
|
|
|
+ </tr>
|
|
|
+ </thead>
|
|
|
+
|
|
|
+ <tbody>
|
|
|
+
|
|
|
+
|
|
|
+ <tr>
|
|
|
+
|
|
|
+ <td class="name"><code>error</code></td>
|
|
|
+
|
|
|
+
|
|
|
+ <td class="type">
|
|
|
+
|
|
|
+
|
|
|
+<span class="param-type">Error</span>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </td>
|
|
|
+
|
|
|
+
|
|
|
+ <td class="attributes">
|
|
|
+
|
|
|
+ <optional><br>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </td>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <td class="description last"><p>If non-null, indicates that binding the port failed.</p></td>
|
|
|
+ </tr>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <tr>
|
|
|
+
|
|
|
+ <td class="name"><code>port</code></td>
|
|
|
+
|
|
|
+
|
|
|
+ <td class="type">
|
|
|
+
|
|
|
+
|
|
|
+<span class="param-type">number</span>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </td>
|
|
|
+
|
|
|
+
|
|
|
+ <td class="attributes">
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </td>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <td class="description last"><p>The bound port number. If binding the port fails, this
|
|
|
+ will be negative to match the output of bind.</p></td>
|
|
|
+ </tr>
|
|
|
+
|
|
|
+
|
|
|
+ </tbody>
|
|
|
+</table>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+<dl class="details">
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</dl>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+</dd>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
<hr>
|
|
|
<dt>
|
|
|
<h4 class="name" id="~handleBidiStreamingCall"><span class="type-signature"></span>handleBidiStreamingCall(call)</h4>
|
|
@@ -2145,7 +2506,7 @@ responses.</p>
|
|
|
<span class="jsdoc-message">
|
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
|
|
|
|
|
- on 2018-08-10T10:27:03-07:00
|
|
|
+ on 2018-11-29T11:16:28-08:00
|
|
|
|
|
|
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
|
|
</span>
|