index.js.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: index.js</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Source: index.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>/*
  20. *
  21. * Copyright 2015, Google Inc.
  22. * All rights reserved.
  23. *
  24. * Redistribution and use in source and binary forms, with or without
  25. * modification, are permitted provided that the following conditions are
  26. * met:
  27. *
  28. * * Redistributions of source code must retain the above copyright
  29. * notice, this list of conditions and the following disclaimer.
  30. * * Redistributions in binary form must reproduce the above
  31. * copyright notice, this list of conditions and the following disclaimer
  32. * in the documentation and/or other materials provided with the
  33. * distribution.
  34. * * Neither the name of Google Inc. nor the names of its
  35. * contributors may be used to endorse or promote products derived from
  36. * this software without specific prior written permission.
  37. *
  38. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  39. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  40. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  41. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  42. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  44. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  45. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  46. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  47. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  48. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  49. *
  50. */
  51. 'use strict';
  52. var path = require('path');
  53. var SSL_ROOTS_PATH = path.resolve(__dirname, '..', '..', 'etc', 'roots.pem');
  54. if (!process.env.GRPC_DEFAULT_SSL_ROOTS_FILE_PATH) {
  55. process.env.GRPC_DEFAULT_SSL_ROOTS_FILE_PATH = SSL_ROOTS_PATH;
  56. }
  57. var _ = require('lodash');
  58. var ProtoBuf = require('protobufjs');
  59. var client = require('./src/client.js');
  60. var server = require('./src/server.js');
  61. var Metadata = require('./src/metadata.js');
  62. var grpc = require('bindings')('grpc_node');
  63. /**
  64. * Load a gRPC object from an existing ProtoBuf.Reflect object.
  65. * @param {ProtoBuf.Reflect.Namespace} value The ProtoBuf object to load.
  66. * @return {Object&lt;string, *>} The resulting gRPC object
  67. */
  68. exports.loadObject = function loadObject(value) {
  69. var result = {};
  70. if (value.className === 'Namespace') {
  71. _.each(value.children, function(child) {
  72. result[child.name] = loadObject(child);
  73. });
  74. return result;
  75. } else if (value.className === 'Service') {
  76. return client.makeProtobufClientConstructor(value);
  77. } else if (value.className === 'Message' || value.className === 'Enum') {
  78. return value.build();
  79. } else {
  80. return value;
  81. }
  82. };
  83. var loadObject = exports.loadObject;
  84. /**
  85. * Load a gRPC object from a .proto file.
  86. * @param {string} filename The file to load
  87. * @param {string=} format The file format to expect. Must be either 'proto' or
  88. * 'json'. Defaults to 'proto'
  89. * @return {Object&lt;string, *>} The resulting gRPC object
  90. */
  91. exports.load = function load(filename, format) {
  92. if (!format) {
  93. format = 'proto';
  94. }
  95. var builder;
  96. switch(format) {
  97. case 'proto':
  98. builder = ProtoBuf.loadProtoFile(filename);
  99. break;
  100. case 'json':
  101. builder = ProtoBuf.loadJsonFile(filename);
  102. break;
  103. default:
  104. throw new Error('Unrecognized format "' + format + '"');
  105. }
  106. return loadObject(builder.ns);
  107. };
  108. /**
  109. * @see module:src/server.Server
  110. */
  111. exports.Server = server.Server;
  112. /**
  113. * @see module:src/metadata
  114. */
  115. exports.Metadata = Metadata;
  116. /**
  117. * Status name to code number mapping
  118. */
  119. exports.status = grpc.status;
  120. /**
  121. * Propagate flag name to number mapping
  122. */
  123. exports.propagate = grpc.propagate;
  124. /**
  125. * Call error name to code number mapping
  126. */
  127. exports.callError = grpc.callError;
  128. /**
  129. * Write flag name to code number mapping
  130. */
  131. exports.writeFlags = grpc.writeFlags;
  132. /**
  133. * Credentials factories
  134. */
  135. exports.credentials = require('./src/credentials.js');
  136. /**
  137. * ServerCredentials factories
  138. */
  139. exports.ServerCredentials = grpc.ServerCredentials;
  140. /**
  141. * @see module:src/client.makeClientConstructor
  142. */
  143. exports.makeGenericClientConstructor = client.makeClientConstructor;
  144. /**
  145. * @see module:src/client.getClientChannel
  146. */
  147. exports.getClientChannel = client.getClientChannel;
  148. /**
  149. * @see module:src/client.waitForClientReady
  150. */
  151. exports.waitForClientReady = client.waitForClientReady;
  152. </code></pre>
  153. </article>
  154. </section>
  155. </div>
  156. <nav>
  157. <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-src_client.html">src/client</a></li><li><a href="module-src_common.html">src/common</a></li><li><a href="module-src_credentials.html">src/credentials</a></li><li><a href="module-src_metadata.html">src/metadata</a></li><li><a href="module-src_server.html">src/server</a></li></ul><h3>Classes</h3><ul><li><a href="module-src_client.makeClientConstructor-Client.html">Client</a></li><li><a href="module-src_client-ClientDuplexStream.html">ClientDuplexStream</a></li><li><a href="module-src_client-ClientReadableStream.html">ClientReadableStream</a></li><li><a href="module-src_client-ClientWritableStream.html">ClientWritableStream</a></li><li><a href="module-src_metadata-Metadata.html">Metadata</a></li><li><a href="module-src_server-Server.html">Server</a></li><li><a href="module-src_server-ServerDuplexStream.html">ServerDuplexStream</a></li><li><a href="module-src_server-ServerReadableStream.html">ServerReadableStream</a></li><li><a href="module-src_server-ServerWritableStream.html">ServerWritableStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#callError">callError</a></li><li><a href="global.html#credentials">credentials</a></li><li><a href="global.html#getClientChannel">getClientChannel</a></li><li><a href="global.html#load">load</a></li><li><a href="global.html#loadObject">loadObject</a></li><li><a href="global.html#makeGenericClientConstructor">makeGenericClientConstructor</a></li><li><a href="global.html#Metadata">Metadata</a></li><li><a href="global.html#propagate">propagate</a></li><li><a href="global.html#Server">Server</a></li><li><a href="global.html#ServerCredentials">ServerCredentials</a></li><li><a href="global.html#status">status</a></li><li><a href="global.html#waitForClientReady">waitForClientReady</a></li><li><a href="global.html#writeFlags">writeFlags</a></li></ul>
  158. </nav>
  159. <br class="clear">
  160. <footer>
  161. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jan 14 2016 16:17:15 GMT-0800 (PST)
  162. </footer>
  163. <script> prettyPrint(); </script>
  164. <script src="scripts/linenumber.js"> </script>
  165. </body>
  166. </html>