Merge pull request #4000 from murgatroid99/node_0.11_docs_update

Minor updates to Node API documentation

node/global.html

@@ -1326,7 +1326,7 @@ google-auth-library.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/index.html

@@ -26,7 +26,7 @@
     
 
 
-    <h3>grpc 0.10.0</h3>
+    <h3>grpc 0.11.1</h3>
 
 
 
@@ -43,14 +43,14 @@
 
 
     <section>
-        <article><h1>Node.js gRPC Library</h1><h2>Status</h2><p>Alpha : Ready for early adopters</p>
+        <article><h1>Node.js gRPC Library</h1><h2>Status</h2><p>Beta</p>
 <h2>PREREQUISITES</h2><ul>
 <li><code>node</code>: This requires <code>node</code> to be installed. If you instead have the <code>nodejs</code> executable on Debian, you should install the <a href="https://packages.debian.org/sid/nodejs-legacy"><code>nodejs-legacy</code></a> package.</li>
 <li><a href="http://brew.sh">homebrew</a> on Mac OS X.  These simplify the installation of the gRPC C core.</li>
 </ul>
 <h2>INSTALLATION</h2><p><strong>Linux (Debian):</strong></p>
-<p>Add <a href="https://www.debian.org/releases/stretch/">Debian testing</a> to your <code>sources.list</code> file. Example:</p>
-<pre class="prettyprint source lang-sh"><code>echo &quot;deb http://ftp.us.debian.org/debian testing main contrib non-free&quot; | \
+<p>Add <a href="http://backports.debian.org/Instructions/">Debian jessie-backports</a> to your <code>sources.list</code> file. Example:</p>
+<pre class="prettyprint source lang-sh"><code>echo &quot;deb http://http.debian.net/debian jessie-backports main&quot; | \
 sudo tee -a /etc/apt/sources.list</code></pre><p>Install the gRPC Debian package</p>
 <pre class="prettyprint source lang-sh"><code>sudo apt-get update
 sudo apt-get install libgrpc-dev</code></pre><p>Install the gRPC NPM package</p>
@@ -96,7 +96,7 @@ sudo apt-get install libgrpc-dev</code></pre><p>Install the gRPC NPM package</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/index.js.html

@@ -218,7 +218,7 @@ exports.waitForClientReady = client.waitForClientReady;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_client-ClientDuplexStream.html

@@ -254,7 +254,7 @@ duplex streaming.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_client-ClientReadableStream.html

@@ -230,7 +230,7 @@ from the server side.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_client-ClientWritableStream.html

@@ -230,7 +230,7 @@ the client side.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_client.html

@@ -2154,7 +2154,7 @@ method.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_client.makeClientConstructor-Client.html

@@ -313,7 +313,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_common.html

@@ -856,7 +856,7 @@ function is given, just uses the identity;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_metadata-Metadata.html

@@ -971,7 +971,7 @@ with that key. Normalizes the key.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_metadata.html

@@ -157,7 +157,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_server-Server.html

@@ -158,7 +158,7 @@ incoming requests to those handlers
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line583">line 583</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line585">line 585</a>
     </li></ul></dd>
     
 
@@ -331,7 +331,7 @@ incoming requests to those handlers
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line743">line 743</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line745">line 745</a>
     </li></ul></dd>
     
 
@@ -489,7 +489,7 @@ addProtoService.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line700">line 700</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line702">line 702</a>
     </li></ul></dd>
     
 
@@ -665,7 +665,7 @@ addProtoService.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line754">line 754</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line756">line 756</a>
     </li></ul></dd>
     
 
@@ -750,7 +750,7 @@ any outstanding tryShutdown callbacks.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line659">line 659</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line661">line 661</a>
     </li></ul></dd>
     
 
@@ -976,7 +976,7 @@ a handler for the given method. Returns true on success
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line677">line 677</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line679">line 679</a>
     </li></ul></dd>
     
 
@@ -1084,7 +1084,7 @@ a handler for the given method. Returns true on success
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line593">line 593</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line595">line 595</a>
     </li></ul></dd>
     
 
@@ -1218,7 +1218,7 @@ is idempotent with itself and forceShutdown.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line649">line 649</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line651">line 651</a>
     </li></ul></dd>
     
 
@@ -1266,7 +1266,7 @@ is idempotent with itself and forceShutdown.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_server-ServerDuplexStream.html

@@ -192,7 +192,7 @@ duplex streaming.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line408">line 408</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line410">line 410</a>
     </li></ul></dd>
     
 
@@ -254,7 +254,7 @@ duplex streaming.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_server-ServerReadableStream.html

@@ -168,7 +168,7 @@ from the client side.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line337">line 337</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line339">line 339</a>
     </li></ul></dd>
     
 
@@ -230,7 +230,7 @@ from the client side.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_server-ServerWritableStream.html

@@ -252,7 +252,7 @@ the server side.
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line326">line 326</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line328">line 328</a>
     </li></ul></dd>
     
 
@@ -292,7 +292,7 @@ the server side.
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/module-src_server.html

@@ -188,7 +188,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line764">line 764</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line766">line 766</a>
     </li></ul></dd>
     
 
@@ -273,7 +273,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line423">line 423</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line425">line 425</a>
     </li></ul></dd>
     
 
@@ -426,7 +426,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line306">line 306</a>
+        <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line307">line 307</a>
     </li></ul></dd>
     
 
@@ -474,7 +474,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/src_client.js.html

@@ -665,7 +665,7 @@ exports.makeClientConstructor = function(methods, serviceName) {
     // Remove the optional DNS scheme, trailing port, and trailing backslash
     address = address.replace(/^(dns:\/{3})?([^:\/]+)(:\d+)?\/?$/, '$2');
     this.$server_address = address;
-    this.$auth_uri = 'https://' + this.server_address + '/' + serviceName;
+    this.$auth_uri = 'https://' + this.$server_address + '/' + serviceName;
     this.$updateMetadata = updateMetadata;
   }
 
@@ -775,7 +775,7 @@ exports.callError = grpc.callError;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/src_common.js.html

@@ -182,7 +182,7 @@ exports.getProtobufServiceAttrs = function getProtobufServiceAttrs(service) {
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/src_metadata.js.html

@@ -223,7 +223,7 @@ module.exports = Metadata;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>

node/src_server.js.html

@@ -304,6 +304,7 @@ function ServerWritableStream(call, serialize) {
 function _write(chunk, encoding, callback) {
   /* jshint validthis: true */
   var batch = {};
+  var self = this;
   if (!this.call.metadataSent) {
     batch[grpc.opType.SEND_INITIAL_METADATA] =
         (new Metadata())._getCoreRepresentation();
@@ -318,7 +319,7 @@ function _write(chunk, encoding, callback) {
   batch[grpc.opType.SEND_MESSAGE] = message;
   this.call.startBatch(batch, function(err, value) {
     if (err) {
-      this.emit('error', err);
+      self.emit('error', err);
       return;
     }
     callback();
@@ -333,6 +334,7 @@ ServerWritableStream.prototype._write = _write;
  */
 function sendMetadata(responseMetadata) {
   /* jshint validthis: true */
+  var self = this;
   if (!this.call.metadataSent) {
     this.call.metadataSent = true;
     var batch = [];
@@ -340,7 +342,7 @@ function sendMetadata(responseMetadata) {
         responseMetadata._getCoreRepresentation();
     this.call.startBatch(batch, function(err) {
       if (err) {
-        this.emit('error', err);
+        self.emit('error', err);
         return;
       }
     });
@@ -806,7 +808,7 @@ exports.Server = Server;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Mon Aug 31 2015 11:35:11 GMT-0700 (PDT)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Thu Oct 29 2015 13:07:25 GMT-0700 (PDT)
 </footer>
 
 <script> prettyPrint(); </script>