classes.list.html 20 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width">
  6. <title>Documentation Classes</title>
  7. <!--[if lt IE 9]>
  8. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  9. <![endif]-->
  10. <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  11. <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
  12. </head>
  13. <body>
  14. <div class="navbar navbar-default navbar-fixed-top ">
  15. <div class="container">
  16. <div class="navbar-header">
  17. <a class="navbar-brand" href="index.html">Documentation</a>
  18. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  19. <span class="icon-bar"></span>
  20. <span class="icon-bar"></span>
  21. <span class="icon-bar"></span>
  22. </button>
  23. </div>
  24. <div class="navbar-collapse collapse" id="topNavigation">
  25. <ul class="nav navbar-nav">
  26. <li class="dropdown">
  27. <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  28. <ul class="dropdown-menu ">
  29. <li><a href="grpc.html">grpc</a></li><li><a href="grpc.credentials.html">grpc.credentials</a></li>
  30. </ul>
  31. </li>
  32. <li class="dropdown">
  33. <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
  34. <ul class="dropdown-menu ">
  35. <li><a href="module-src_client_interceptors.html">src/client_interceptors</a></li>
  36. </ul>
  37. </li>
  38. <li class="dropdown">
  39. <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  40. <ul class="dropdown-menu ">
  41. <li><a href="grpc.Channel.html">grpc.Channel</a></li><li><a href="grpc.Client.html">grpc.Client</a></li><li><a href="grpc.credentials-CallCredentials.html">grpc.credentials~CallCredentials</a></li><li><a href="grpc.credentials-ChannelCredentials.html">grpc.credentials~ChannelCredentials</a></li><li><a href="grpc.Metadata.html">grpc.Metadata</a></li><li><a href="grpc.Server.html">grpc.Server</a></li><li><a href="grpc.ServerCredentials.html">grpc.ServerCredentials</a></li><li><a href="grpc-Call.html">grpc~Call</a></li><li><a href="grpc-ClientDuplexStream.html">grpc~ClientDuplexStream</a></li><li><a href="grpc-ClientReadableStream.html">grpc~ClientReadableStream</a></li><li><a href="grpc-ClientUnaryCall.html">grpc~ClientUnaryCall</a></li><li><a href="grpc-ClientWritableStream.html">grpc~ClientWritableStream</a></li><li><a href="grpc-ServerDuplexStream.html">grpc~ServerDuplexStream</a></li><li><a href="grpc-ServerReadableStream.html">grpc~ServerReadableStream</a></li><li><a href="grpc-ServerUnaryCall.html">grpc~ServerUnaryCall</a></li><li><a href="grpc-ServerWritableStream.html">grpc~ServerWritableStream</a></li><li><a href="module-src_client_interceptors-EndListener.html">src/client_interceptors~EndListener</a></li><li><a href="module-src_client_interceptors-InterceptingCall.html">src/client_interceptors~InterceptingCall</a></li><li><a href="module-src_client_interceptors-InterceptingListener.html">src/client_interceptors~InterceptingListener</a></li><li><a href="module-src_client_interceptors-InterceptorConfigurationError.html">src/client_interceptors~InterceptorConfigurationError</a></li><li><a href="module-src_client_interceptors-ListenerBuilder.html">src/client_interceptors~ListenerBuilder</a></li><li><a href="module-src_client_interceptors-RequesterBuilder.html">src/client_interceptors~RequesterBuilder</a></li><li><a href="module-src_client_interceptors-StatusBuilder.html">src/client_interceptors~StatusBuilder</a></li>
  42. </ul>
  43. </li>
  44. <li class="dropdown">
  45. <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
  46. <ul class="dropdown-menu ">
  47. <li><a href="grpc-ClientDuplexStream.html#event:metadata">grpc~ClientDuplexStream#metadata</a></li><li><a href="grpc-ClientDuplexStream.html#event:status">grpc~ClientDuplexStream#status</a></li><li><a href="grpc-ClientReadableStream.html#event:metadata">grpc~ClientReadableStream#metadata</a></li><li><a href="grpc-ClientReadableStream.html#event:status">grpc~ClientReadableStream#status</a></li><li><a href="grpc-ClientUnaryCall.html#event:metadata">grpc~ClientUnaryCall#event:metadata</a></li><li><a href="grpc-ClientUnaryCall.html#event:status">grpc~ClientUnaryCall#event:status</a></li><li><a href="grpc-ClientWritableStream.html#event:metadata">grpc~ClientWritableStream#metadata</a></li><li><a href="grpc-ClientWritableStream.html#event:status">grpc~ClientWritableStream#status</a></li><li><a href="grpc-ServerDuplexStream.html#~event:cancelled">grpc~ServerDuplexStream~event:cancelled</a></li><li><a href="grpc-ServerReadableStream.html#~event:cancelled">grpc~ServerReadableStream~event:cancelled</a></li><li><a href="grpc-ServerUnaryCall.html#~event:cancelled">grpc~ServerUnaryCall~event:cancelled</a></li><li><a href="grpc-ServerWritableStream.html#~event:cancelled">grpc~ServerWritableStream~event:cancelled</a></li>
  48. </ul>
  49. </li>
  50. <li class="dropdown">
  51. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  52. <ul class="dropdown-menu ">
  53. <li><a href="global.html#CancelRequester">CancelRequester</a></li><li><a href="global.html#CloseRequester">CloseRequester</a></li><li><a href="global.html#createStatusError">createStatusError</a></li><li><a href="global.html#getClientInterceptors">getClientInterceptors</a></li><li><a href="global.html#getMethodType">getMethodType</a></li><li><a href="global.html#GetPeerRequester">GetPeerRequester</a></li><li><a href="global.html#Interceptor">Interceptor</a></li><li><a href="global.html#InterceptorProvider">InterceptorProvider</a></li><li><a href="global.html#loadPackageDefinition">loadPackageDefinition</a></li><li><a href="global.html#MessageListener">MessageListener</a></li><li><a href="global.html#MessageRequester">MessageRequester</a></li><li><a href="global.html#MetadataListener">MetadataListener</a></li><li><a href="global.html#MetadataRequester">MetadataRequester</a></li><li><a href="global.html#NextCall">NextCall</a></li><li><a href="global.html#StatusListener">StatusListener</a></li>
  54. </ul>
  55. </li>
  56. <li class="dropdown">
  57. <a href="externals.list.html" class="dropdown-toggle" data-toggle="dropdown">Externals<b class="caret"></b></a>
  58. <ul class="dropdown-menu ">
  59. <li><a href="external-Duplex.html">Duplex</a></li><li><a href="external-EventEmitter.html">EventEmitter</a></li><li><a href="external-GoogleCredential.html">GoogleCredential</a></li><li><a href="external-Readable.html">Readable</a></li><li><a href="external-Writable.html">Writable</a></li>
  60. </ul>
  61. </li>
  62. </ul>
  63. <div class="col-sm-3 col-md-3">
  64. <form class="navbar-form" role="search">
  65. <div class="input-group">
  66. <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
  67. <div class="input-group-btn">
  68. <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
  69. </div>
  70. </div>
  71. </form>
  72. </div>
  73. </div>
  74. </div>
  75. </div>
  76. <div class="container" id="toc-content">
  77. <div class="row">
  78. <div class="col-md-8">
  79. <div id="main">
  80. <h1 class="page-title">Classes</h1>
  81. <section>
  82. <header>
  83. <h2>
  84. </h2>
  85. </header>
  86. <article>
  87. <div class="container-overview">
  88. <dl class="details">
  89. </dl>
  90. </div>
  91. <h3 class="subsection-title">Classes</h3>
  92. <dl>
  93. <dt><a href="grpc.Channel.html">Channel</a></dt>
  94. <dd></dd>
  95. <dt><a href="grpc.Client.html">Client</a></dt>
  96. <dd></dd>
  97. <dt><a href="grpc.credentials-CallCredentials.html">CallCredentials</a></dt>
  98. <dd></dd>
  99. <dt><a href="grpc.credentials-ChannelCredentials.html">ChannelCredentials</a></dt>
  100. <dd></dd>
  101. <dt><a href="grpc.Metadata.html">Metadata</a></dt>
  102. <dd></dd>
  103. <dt><a href="grpc.Server.html">Server</a></dt>
  104. <dd></dd>
  105. <dt><a href="grpc.ServerCredentials.html">ServerCredentials</a></dt>
  106. <dd></dd>
  107. <dt><a href="grpc-Call.html">Call</a></dt>
  108. <dd></dd>
  109. <dt><a href="grpc-ClientDuplexStream.html">ClientDuplexStream</a></dt>
  110. <dd></dd>
  111. <dt><a href="grpc-ClientReadableStream.html">ClientReadableStream</a></dt>
  112. <dd></dd>
  113. <dt><a href="grpc-ClientUnaryCall.html">ClientUnaryCall</a></dt>
  114. <dd></dd>
  115. <dt><a href="grpc-ClientWritableStream.html">ClientWritableStream</a></dt>
  116. <dd></dd>
  117. <dt><a href="grpc-ServerDuplexStream.html">ServerDuplexStream</a></dt>
  118. <dd></dd>
  119. <dt><a href="grpc-ServerReadableStream.html">ServerReadableStream</a></dt>
  120. <dd></dd>
  121. <dt><a href="grpc-ServerUnaryCall.html">ServerUnaryCall</a></dt>
  122. <dd></dd>
  123. <dt><a href="grpc-ServerWritableStream.html">ServerWritableStream</a></dt>
  124. <dd></dd>
  125. <dt><a href="module-src_client_interceptors-EndListener.html">EndListener</a></dt>
  126. <dd></dd>
  127. <dt><a href="module-src_client_interceptors-InterceptingCall.html">InterceptingCall</a></dt>
  128. <dd></dd>
  129. <dt><a href="module-src_client_interceptors-InterceptingListener.html">InterceptingListener</a></dt>
  130. <dd></dd>
  131. <dt><a href="module-src_client_interceptors-InterceptorConfigurationError.html">InterceptorConfigurationError</a></dt>
  132. <dd></dd>
  133. <dt><a href="module-src_client_interceptors-ListenerBuilder.html">ListenerBuilder</a></dt>
  134. <dd></dd>
  135. <dt><a href="module-src_client_interceptors-RequesterBuilder.html">RequesterBuilder</a></dt>
  136. <dd></dd>
  137. <dt><a href="module-src_client_interceptors-StatusBuilder.html">StatusBuilder</a></dt>
  138. <dd></dd>
  139. </dl>
  140. <h3 class="subsection-title">Namespaces</h3>
  141. <dl>
  142. <dt><a href="namespaces.html#grpc"><a href="grpc.html">grpc</a></a></dt>
  143. <dd></dd>
  144. <dt><a href="namespaces.html#grpc.credentials"><a href="grpc.credentials.html">credentials</a></a></dt>
  145. <dd></dd>
  146. </dl>
  147. <h3 class="subsection-title">Events</h3>
  148. <dl>
  149. <hr>
  150. <dt>
  151. <h4 class="name" id="event:metadata">metadata</h4>
  152. </dt>
  153. <dd>
  154. <div class="description">
  155. <p>Initial response metadata sent by the server when it starts processing the
  156. call</p>
  157. </div>
  158. <h5>Type:
  159. <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
  160. </h5>
  161. <dl class="details">
  162. </dl>
  163. </dd>
  164. <hr>
  165. <dt>
  166. <h4 class="name" id="event:status">status</h4>
  167. </dt>
  168. <dd>
  169. <div class="description">
  170. <p>Status of the call when it has completed.</p>
  171. </div>
  172. <h5>Type:
  173. <span class="param-type"><a href="grpc.html#~StatusObject">grpc~StatusObject</a></span>
  174. </h5>
  175. <dl class="details">
  176. </dl>
  177. </dd>
  178. <hr>
  179. <dt>
  180. <h4 class="name" id="event:metadata">metadata</h4>
  181. </dt>
  182. <dd>
  183. <div class="description">
  184. <p>Initial response metadata sent by the server when it starts processing the
  185. call</p>
  186. </div>
  187. <h5>Type:
  188. <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
  189. </h5>
  190. <dl class="details">
  191. </dl>
  192. </dd>
  193. <hr>
  194. <dt>
  195. <h4 class="name" id="event:status">status</h4>
  196. </dt>
  197. <dd>
  198. <div class="description">
  199. <p>Status of the call when it has completed.</p>
  200. </div>
  201. <h5>Type:
  202. <span class="param-type"><a href="grpc.html#~StatusObject">grpc~StatusObject</a></span>
  203. </h5>
  204. <dl class="details">
  205. </dl>
  206. </dd>
  207. <hr>
  208. <dt>
  209. <h4 class="name" id="event:metadata">metadata</h4>
  210. </dt>
  211. <dd>
  212. <div class="description">
  213. <p>Initial response metadata sent by the server when it starts processing the
  214. call</p>
  215. </div>
  216. <h5>Type:
  217. <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
  218. </h5>
  219. <dl class="details">
  220. </dl>
  221. </dd>
  222. <hr>
  223. <dt>
  224. <h4 class="name" id="event:status">status</h4>
  225. </dt>
  226. <dd>
  227. <div class="description">
  228. <p>Status of the call when it has completed.</p>
  229. </div>
  230. <h5>Type:
  231. <span class="param-type"><a href="grpc.html#~StatusObject">grpc~StatusObject</a></span>
  232. </h5>
  233. <dl class="details">
  234. </dl>
  235. </dd>
  236. <hr>
  237. <dt>
  238. <h4 class="name" id="event:metadata">metadata</h4>
  239. </dt>
  240. <dd>
  241. <div class="description">
  242. <p>Initial response metadata sent by the server when it starts processing the
  243. call</p>
  244. </div>
  245. <h5>Type:
  246. <span class="param-type"><a href="grpc.Metadata.html">grpc.Metadata</a></span>
  247. </h5>
  248. <dl class="details">
  249. </dl>
  250. </dd>
  251. <hr>
  252. <dt>
  253. <h4 class="name" id="event:status">status</h4>
  254. </dt>
  255. <dd>
  256. <div class="description">
  257. <p>Status of the call when it has completed.</p>
  258. </div>
  259. <h5>Type:
  260. <span class="param-type"><a href="grpc.html#~StatusObject">grpc~StatusObject</a></span>
  261. </h5>
  262. <dl class="details">
  263. </dl>
  264. </dd>
  265. <hr>
  266. <dt>
  267. <h4 class="name" id="~event:cancelled">cancelled</h4>
  268. </dt>
  269. <dd>
  270. <div class="description">
  271. <p>Emitted when the call has been cancelled. After this has been emitted, the
  272. call's <code>cancelled</code> property will be set to <code>true</code>.</p>
  273. </div>
  274. <dl class="details">
  275. </dl>
  276. </dd>
  277. <hr>
  278. <dt>
  279. <h4 class="name" id="~event:cancelled">cancelled</h4>
  280. </dt>
  281. <dd>
  282. <div class="description">
  283. <p>Emitted when the call has been cancelled. After this has been emitted, the
  284. call's <code>cancelled</code> property will be set to <code>true</code>.</p>
  285. </div>
  286. <dl class="details">
  287. </dl>
  288. </dd>
  289. <hr>
  290. <dt>
  291. <h4 class="name" id="~event:cancelled">cancelled</h4>
  292. </dt>
  293. <dd>
  294. <div class="description">
  295. <p>Emitted when the call has been cancelled. After this has been emitted, the
  296. call's <code>cancelled</code> property will be set to <code>true</code>.</p>
  297. </div>
  298. <dl class="details">
  299. </dl>
  300. </dd>
  301. <hr>
  302. <dt>
  303. <h4 class="name" id="~event:cancelled">cancelled</h4>
  304. </dt>
  305. <dd>
  306. <div class="description">
  307. <p>Emitted when the call has been cancelled. After this has been emitted, the
  308. call's <code>cancelled</code> property will be set to <code>true</code>.</p>
  309. </div>
  310. <dl class="details">
  311. </dl>
  312. </dd>
  313. </dl>
  314. </article>
  315. </section>
  316. </div>
  317. </div>
  318. <div class="clearfix"></div>
  319. <div class="col-md-3">
  320. <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
  321. </div>
  322. </div>
  323. </div>
  324. <div class="modal fade" id="searchResults">
  325. <div class="modal-dialog">
  326. <div class="modal-content">
  327. <div class="modal-header">
  328. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  329. <h4 class="modal-title">Search results</h4>
  330. </div>
  331. <div class="modal-body"></div>
  332. <div class="modal-footer">
  333. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  334. </div>
  335. </div><!-- /.modal-content -->
  336. </div><!-- /.modal-dialog -->
  337. </div>
  338. <footer>
  339. <span class="jsdoc-message">
  340. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
  341. on 2019-07-15T16:38:16-07:00
  342. using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
  343. </span>
  344. </footer>
  345. <script src="scripts/docstrap.lib.js"></script>
  346. <script src="scripts/toc.js"></script>
  347. <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
  348. <script>
  349. $( function () {
  350. $( "[id*='$']" ).each( function () {
  351. var $this = $( this );
  352. $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
  353. } );
  354. $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
  355. var $this = $( this );
  356. var example = $this.find( "code" );
  357. exampleText = example.html();
  358. var lang = /{@lang (.*?)}/.exec( exampleText );
  359. if ( lang && lang[1] ) {
  360. exampleText = exampleText.replace( lang[0], "" );
  361. example.html( exampleText );
  362. lang = lang[1];
  363. } else {
  364. var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
  365. lang = langClassMatch ? langClassMatch[1] : "javascript";
  366. }
  367. if ( lang ) {
  368. $this
  369. .addClass( "sunlight-highlight-" + lang )
  370. .addClass( "linenums" )
  371. .html( example.html() );
  372. }
  373. } );
  374. Sunlight.highlightAll( {
  375. lineNumbers : false,
  376. showMenu : true,
  377. enableDoclinks : true
  378. } );
  379. $.catchAnchorLinks( {
  380. navbarOffset: 10
  381. } );
  382. $( "#toc" ).toc( {
  383. anchorName : function ( i, heading, prefix ) {
  384. return $( heading ).attr( "id" ) || ( prefix + i );
  385. },
  386. selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
  387. showAndHide : false,
  388. smoothScrolling: true
  389. } );
  390. $( "#main span[id^='toc']" ).addClass( "toc-shim" );
  391. $( '.dropdown-toggle' ).dropdown();
  392. $( "table" ).each( function () {
  393. var $this = $( this );
  394. $this.addClass('table');
  395. } );
  396. } );
  397. </script>
  398. <!--Navigation and Symbol Display-->
  399. <!--Google Analytics-->
  400. <script type="text/javascript">
  401. $(document).ready(function() {
  402. SearcherDisplay.init();
  403. });
  404. </script>
  405. </body>
  406. </html>