module-src_server.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: src/server</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">Module: src/server</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description">Server module</div>
  23. <dl class="details">
  24. <dt class="tag-source">Source:</dt>
  25. <dd class="tag-source"><ul class="dummy"><li>
  26. <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line34">line 34</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Classes</h3>
  31. <dl>
  32. <dt><a href="module-src_server-Server.html">Server</a></dt>
  33. <dd></dd>
  34. <dt><a href="module-src_server-ServerDuplexStream.html">ServerDuplexStream</a></dt>
  35. <dd></dd>
  36. <dt><a href="module-src_server-ServerReadableStream.html">ServerReadableStream</a></dt>
  37. <dd></dd>
  38. <dt><a href="module-src_server-ServerWritableStream.html">ServerWritableStream</a></dt>
  39. <dd></dd>
  40. </dl>
  41. <h3 class="subsection-title">Members</h3>
  42. <h4 class="name" id=".Server"><span class="type-signature">(static) </span>Server<span class="type-signature"></span></h4>
  43. <dl class="details">
  44. <dt class="tag-source">Source:</dt>
  45. <dd class="tag-source"><ul class="dummy"><li>
  46. <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line766">line 766</a>
  47. </li></ul></dd>
  48. <dt class="tag-see">See:</dt>
  49. <dd class="tag-see">
  50. <ul>
  51. <li><a href="module-src_server-Server.html">module:src/server~Server</a></li>
  52. </ul>
  53. </dd>
  54. </dl>
  55. <h3 class="subsection-title">Methods</h3>
  56. <h4 class="name" id="~getPeer"><span class="type-signature">(inner) </span>getPeer<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  57. <div class="description">
  58. Get the endpoint this call/stream is connected to.
  59. </div>
  60. <dl class="details">
  61. <dt class="tag-source">Source:</dt>
  62. <dd class="tag-source"><ul class="dummy"><li>
  63. <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line425">line 425</a>
  64. </li></ul></dd>
  65. </dl>
  66. <h5>Returns:</h5>
  67. <div class="param-desc">
  68. The URI of the endpoint
  69. </div>
  70. <dl>
  71. <dt>
  72. Type
  73. </dt>
  74. <dd>
  75. <span class="param-type">string</span>
  76. </dd>
  77. </dl>
  78. <h4 class="name" id="~sendMetadata"><span class="type-signature">(inner) </span>sendMetadata<span class="signature">(responseMetadata)</span><span class="type-signature"></span></h4>
  79. <div class="description">
  80. Send the initial metadata for a writable stream.
  81. </div>
  82. <h5>Parameters:</h5>
  83. <table class="params">
  84. <thead>
  85. <tr>
  86. <th>Name</th>
  87. <th>Type</th>
  88. <th class="last">Description</th>
  89. </tr>
  90. </thead>
  91. <tbody>
  92. <tr>
  93. <td class="name"><code>responseMetadata</code></td>
  94. <td class="type">
  95. <span class="param-type"><a href="global.html#Metadata">Metadata</a></span>
  96. </td>
  97. <td class="description last">Metadata to send</td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. <dl class="details">
  102. <dt class="tag-source">Source:</dt>
  103. <dd class="tag-source"><ul class="dummy"><li>
  104. <a href="src_server.js.html">src/server.js</a>, <a href="src_server.js.html#line307">line 307</a>
  105. </li></ul></dd>
  106. </dl>
  107. </article>
  108. </section>
  109. </div>
  110. <nav>
  111. <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_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#getGoogleAuthDelegate">getGoogleAuthDelegate</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>
  112. </nav>
  113. <br class="clear">
  114. <footer>
  115. 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)
  116. </footer>
  117. <script> prettyPrint(); </script>
  118. <script src="scripts/linenumber.js"> </script>
  119. </body>
  120. </html>