module-src_client.html 31 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Module: src/client</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/client</h1>
  17. <section>
  18. <header>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <div class="description">Client module
  23. This module contains the factory method for creating Client classes, and the
  24. method calling code for all types of methods.
  25. For example, to create a client and call a method on it:
  26. var proto_obj = grpc.load(proto_file_path);
  27. var Client = proto_obj.package.subpackage.ServiceName;
  28. var client = new Client(server_address, client_credentials);
  29. var call = client.unaryMethod(arguments, callback);</div>
  30. <dl class="details">
  31. <dt class="tag-source">Source:</dt>
  32. <dd class="tag-source"><ul class="dummy"><li>
  33. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line34">line 34</a>
  34. </li></ul></dd>
  35. </dl>
  36. </div>
  37. <h3 class="subsection-title">Classes</h3>
  38. <dl>
  39. <dt><a href="module-src_client-ClientDuplexStream.html">ClientDuplexStream</a></dt>
  40. <dd></dd>
  41. <dt><a href="module-src_client-ClientReadableStream.html">ClientReadableStream</a></dt>
  42. <dd></dd>
  43. <dt><a href="module-src_client-ClientWritableStream.html">ClientWritableStream</a></dt>
  44. <dd></dd>
  45. </dl>
  46. <h3 class="subsection-title">Members</h3>
  47. <h4 class="name" id=".callError"><span class="type-signature">(static) </span>callError<span class="type-signature"></span></h4>
  48. <div class="description">
  49. See docs for client.callError
  50. </div>
  51. <dl class="details">
  52. <dt class="tag-source">Source:</dt>
  53. <dd class="tag-source"><ul class="dummy"><li>
  54. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line839">line 839</a>
  55. </li></ul></dd>
  56. </dl>
  57. <h4 class="name" id=".status"><span class="type-signature">(static) </span>status<span class="type-signature"></span></h4>
  58. <div class="description">
  59. Map of status code names to status codes
  60. </div>
  61. <dl class="details">
  62. <dt class="tag-source">Source:</dt>
  63. <dd class="tag-source"><ul class="dummy"><li>
  64. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line834">line 834</a>
  65. </li></ul></dd>
  66. </dl>
  67. <h4 class="name" id="~deprecated_request_wrap"><span class="type-signature">(inner) </span>deprecated_request_wrap<span class="type-signature"></span></h4>
  68. <div class="description">
  69. Map with wrappers for each type of requester function to make it use the old
  70. argument order with optional arguments after the callback.
  71. </div>
  72. <dl class="details">
  73. <dt class="tag-source">Source:</dt>
  74. <dd class="tag-source"><ul class="dummy"><li>
  75. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line664">line 664</a>
  76. </li></ul></dd>
  77. </dl>
  78. <h4 class="name" id="~requester_makers"><span class="type-signature">(inner) </span>requester_makers<span class="type-signature"></span></h4>
  79. <div class="description">
  80. Map with short names for each of the requester maker functions. Used in
  81. makeClientConstructor
  82. </div>
  83. <dl class="details">
  84. <dt class="tag-source">Source:</dt>
  85. <dd class="tag-source"><ul class="dummy"><li>
  86. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line646">line 646</a>
  87. </li></ul></dd>
  88. </dl>
  89. <h3 class="subsection-title">Methods</h3>
  90. <h4 class="name" id=".getClientChannel"><span class="type-signature">(static) </span>getClientChannel<span class="signature">(client)</span><span class="type-signature"> &rarr; {Channel}</span></h4>
  91. <div class="description">
  92. Return the underlying channel object for the specified client
  93. </div>
  94. <h5>Parameters:</h5>
  95. <table class="params">
  96. <thead>
  97. <tr>
  98. <th>Name</th>
  99. <th>Type</th>
  100. <th class="last">Description</th>
  101. </tr>
  102. </thead>
  103. <tbody>
  104. <tr>
  105. <td class="name"><code>client</code></td>
  106. <td class="type">
  107. <span class="param-type">Client</span>
  108. </td>
  109. <td class="description last"></td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. <dl class="details">
  114. <dt class="tag-source">Source:</dt>
  115. <dd class="tag-source"><ul class="dummy"><li>
  116. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line776">line 776</a>
  117. </li></ul></dd>
  118. </dl>
  119. <h5>Returns:</h5>
  120. <div class="param-desc">
  121. The channel
  122. </div>
  123. <dl>
  124. <dt>
  125. Type
  126. </dt>
  127. <dd>
  128. <span class="param-type">Channel</span>
  129. </dd>
  130. </dl>
  131. <h4 class="name" id=".makeClientConstructor"><span class="type-signature">(static) </span>makeClientConstructor<span class="signature">(methods, serviceName, class_options)</span><span class="type-signature"> &rarr; {function}</span></h4>
  132. <div class="description">
  133. Creates a constructor for a client with the given methods. The methods object
  134. maps method name to an object with the following keys:
  135. path: The path on the server for accessing the method. For example, for
  136. protocol buffers, we use "/service_name/method_name"
  137. requestStream: bool indicating whether the client sends a stream
  138. resonseStream: bool indicating whether the server sends a stream
  139. requestSerialize: function to serialize request objects
  140. responseDeserialize: function to deserialize response objects
  141. </div>
  142. <h5>Parameters:</h5>
  143. <table class="params">
  144. <thead>
  145. <tr>
  146. <th>Name</th>
  147. <th>Type</th>
  148. <th class="last">Description</th>
  149. </tr>
  150. </thead>
  151. <tbody>
  152. <tr>
  153. <td class="name"><code>methods</code></td>
  154. <td class="type">
  155. <span class="param-type">Object</span>
  156. </td>
  157. <td class="description last">An object mapping method names to method attributes</td>
  158. </tr>
  159. <tr>
  160. <td class="name"><code>serviceName</code></td>
  161. <td class="type">
  162. <span class="param-type">string</span>
  163. </td>
  164. <td class="description last">The fully qualified name of the service</td>
  165. </tr>
  166. <tr>
  167. <td class="name"><code>class_options</code></td>
  168. <td class="type">
  169. <span class="param-type">Object</span>
  170. </td>
  171. <td class="description last">An options object. Currently only uses the key
  172. deprecatedArgumentOrder, a boolean that Indicates that the old argument
  173. order should be used for methods, with optional arguments at the end
  174. instead of the callback at the end. Defaults to false. This option is
  175. only a temporary stopgap measure to smooth an API breakage.
  176. It is deprecated, and new code should not use it.</td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <dl class="details">
  181. <dt class="tag-source">Source:</dt>
  182. <dd class="tag-source"><ul class="dummy"><li>
  183. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line706">line 706</a>
  184. </li></ul></dd>
  185. </dl>
  186. <h5>Returns:</h5>
  187. <div class="param-desc">
  188. New client constructor
  189. </div>
  190. <dl>
  191. <dt>
  192. Type
  193. </dt>
  194. <dd>
  195. <span class="param-type">function</span>
  196. </dd>
  197. </dl>
  198. <h4 class="name" id=".makeProtobufClientConstructor"><span class="type-signature">(static) </span>makeProtobufClientConstructor<span class="signature">(service, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {function}</span></h4>
  199. <div class="description">
  200. Creates a constructor for clients for the given service
  201. </div>
  202. <h5>Parameters:</h5>
  203. <table class="params">
  204. <thead>
  205. <tr>
  206. <th>Name</th>
  207. <th>Type</th>
  208. <th>Attributes</th>
  209. <th class="last">Description</th>
  210. </tr>
  211. </thead>
  212. <tbody>
  213. <tr>
  214. <td class="name"><code>service</code></td>
  215. <td class="type">
  216. <span class="param-type">ProtoBuf.Reflect.Service</span>
  217. </td>
  218. <td class="attributes">
  219. </td>
  220. <td class="description last">The service to generate a client
  221. for</td>
  222. </tr>
  223. <tr>
  224. <td class="name"><code>options</code></td>
  225. <td class="type">
  226. <span class="param-type">Object</span>
  227. </td>
  228. <td class="attributes">
  229. &lt;optional><br>
  230. </td>
  231. <td class="description last">Options to apply to the client</td>
  232. </tr>
  233. </tbody>
  234. </table>
  235. <dl class="details">
  236. <dt class="tag-source">Source:</dt>
  237. <dd class="tag-source"><ul class="dummy"><li>
  238. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line817">line 817</a>
  239. </li></ul></dd>
  240. </dl>
  241. <h5>Returns:</h5>
  242. <div class="param-desc">
  243. New client constructor
  244. </div>
  245. <dl>
  246. <dt>
  247. Type
  248. </dt>
  249. <dd>
  250. <span class="param-type">function</span>
  251. </dd>
  252. </dl>
  253. <h4 class="name" id=".waitForClientReady"><span class="type-signature">(static) </span>waitForClientReady<span class="signature">(client, deadline, callback)</span><span class="type-signature"></span></h4>
  254. <div class="description">
  255. Wait for the client to be ready. The callback will be called when the
  256. client has successfully connected to the server, and it will be called
  257. with an error if the attempt to connect to the server has unrecoverablly
  258. failed or if the deadline expires. This function will make the channel
  259. start connecting if it has not already done so.
  260. </div>
  261. <h5>Parameters:</h5>
  262. <table class="params">
  263. <thead>
  264. <tr>
  265. <th>Name</th>
  266. <th>Type</th>
  267. <th class="last">Description</th>
  268. </tr>
  269. </thead>
  270. <tbody>
  271. <tr>
  272. <td class="name"><code>client</code></td>
  273. <td class="type">
  274. <span class="param-type">Client</span>
  275. </td>
  276. <td class="description last">The client to wait on</td>
  277. </tr>
  278. <tr>
  279. <td class="name"><code>deadline</code></td>
  280. <td class="type">
  281. <span class="param-type">Date</span>
  282. |
  283. <span class="param-type">Number</span>
  284. </td>
  285. <td class="description last">When to stop waiting for a connection. Pass
  286. Infinity to wait forever.</td>
  287. </tr>
  288. <tr>
  289. <td class="name"><code>callback</code></td>
  290. <td class="type">
  291. <span class="param-type">function</span>
  292. </td>
  293. <td class="description last">The callback to call when done attempting
  294. to connect.</td>
  295. </tr>
  296. </tbody>
  297. </table>
  298. <dl class="details">
  299. <dt class="tag-source">Source:</dt>
  300. <dd class="tag-source"><ul class="dummy"><li>
  301. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line792">line 792</a>
  302. </li></ul></dd>
  303. </dl>
  304. <h4 class="name" id="~_emitStatusIfDone"><span class="type-signature">(inner) </span>_emitStatusIfDone<span class="signature">()</span><span class="type-signature"></span></h4>
  305. <div class="description">
  306. If we have both processed all incoming messages and received the status from
  307. the server, emit the status. Otherwise, do nothing.
  308. </div>
  309. <dl class="details">
  310. <dt class="tag-source">Source:</dt>
  311. <dd class="tag-source"><ul class="dummy"><li>
  312. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line178">line 178</a>
  313. </li></ul></dd>
  314. </dl>
  315. <h4 class="name" id="~_readsDone"><span class="type-signature">(inner) </span>_readsDone<span class="signature">(status<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4>
  316. <div class="description">
  317. Called when all messages from the server have been processed. The status
  318. parameter indicates that the call should end with that status. status
  319. defaults to OK if not provided.
  320. </div>
  321. <h5>Parameters:</h5>
  322. <table class="params">
  323. <thead>
  324. <tr>
  325. <th>Name</th>
  326. <th>Type</th>
  327. <th class="last">Description</th>
  328. </tr>
  329. </thead>
  330. <tbody>
  331. <tr>
  332. <td class="name"><code>status</code></td>
  333. <td class="type">
  334. <span class="param-type">Object</span>
  335. </td>
  336. <td class="description last">The status that the call should end with</td>
  337. </tr>
  338. </tbody>
  339. </table>
  340. <dl class="details">
  341. <dt class="tag-source">Source:</dt>
  342. <dd class="tag-source"><ul class="dummy"><li>
  343. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line148">line 148</a>
  344. </li></ul></dd>
  345. </dl>
  346. <h4 class="name" id="~_receiveStatus"><span class="type-signature">(inner) </span>_receiveStatus<span class="signature">()</span><span class="type-signature"></span></h4>
  347. <div class="description">
  348. Called to indicate that we have received a status from the server.
  349. </div>
  350. <dl class="details">
  351. <dt class="tag-source">Source:</dt>
  352. <dd class="tag-source"><ul class="dummy"><li>
  353. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line166">line 166</a>
  354. </li></ul></dd>
  355. </dl>
  356. <h4 class="name" id="~cancel"><span class="type-signature">(inner) </span>cancel<span class="signature">()</span><span class="type-signature"></span></h4>
  357. <div class="description">
  358. Cancel the ongoing call
  359. </div>
  360. <dl class="details">
  361. <dt class="tag-source">Source:</dt>
  362. <dd class="tag-source"><ul class="dummy"><li>
  363. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line290">line 290</a>
  364. </li></ul></dd>
  365. </dl>
  366. <h4 class="name" id="~getCall"><span class="type-signature">(inner) </span>getCall<span class="signature">(options)</span><span class="type-signature"></span></h4>
  367. <div class="description">
  368. Get a call object built with the provided options. Keys for options are
  369. 'deadline', which takes a date or number, and 'host', which takes a string
  370. and overrides the hostname to connect to.
  371. </div>
  372. <h5>Parameters:</h5>
  373. <table class="params">
  374. <thead>
  375. <tr>
  376. <th>Name</th>
  377. <th>Type</th>
  378. <th class="last">Description</th>
  379. </tr>
  380. </thead>
  381. <tbody>
  382. <tr>
  383. <td class="name"><code>options</code></td>
  384. <td class="type">
  385. <span class="param-type">Object</span>
  386. </td>
  387. <td class="description last">Options map.</td>
  388. </tr>
  389. </tbody>
  390. </table>
  391. <dl class="details">
  392. <dt class="tag-source">Source:</dt>
  393. <dd class="tag-source"><ul class="dummy"><li>
  394. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line318">line 318</a>
  395. </li></ul></dd>
  396. </dl>
  397. <h4 class="name" id="~getPeer"><span class="type-signature">(inner) </span>getPeer<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  398. <div class="description">
  399. Get the endpoint this call/stream is connected to.
  400. </div>
  401. <dl class="details">
  402. <dt class="tag-source">Source:</dt>
  403. <dd class="tag-source"><ul class="dummy"><li>
  404. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line303">line 303</a>
  405. </li></ul></dd>
  406. </dl>
  407. <h5>Returns:</h5>
  408. <div class="param-desc">
  409. The URI of the endpoint
  410. </div>
  411. <dl>
  412. <dt>
  413. Type
  414. </dt>
  415. <dd>
  416. <span class="param-type">string</span>
  417. </dd>
  418. </dl>
  419. <h4 class="name" id="~makeBidiStreamRequestFunction"><span class="type-signature">(inner) </span>makeBidiStreamRequestFunction<span class="signature">(method, serialize, deserialize)</span><span class="type-signature"> &rarr; {function}</span></h4>
  420. <div class="description">
  421. Get a function that can make bidirectional stream requests to the specified
  422. method.
  423. </div>
  424. <h5>Parameters:</h5>
  425. <table class="params">
  426. <thead>
  427. <tr>
  428. <th>Name</th>
  429. <th>Type</th>
  430. <th class="last">Description</th>
  431. </tr>
  432. </thead>
  433. <tbody>
  434. <tr>
  435. <td class="name"><code>method</code></td>
  436. <td class="type">
  437. <span class="param-type">string</span>
  438. </td>
  439. <td class="description last">The name of the method to request</td>
  440. </tr>
  441. <tr>
  442. <td class="name"><code>serialize</code></td>
  443. <td class="type">
  444. <span class="param-type">function</span>
  445. </td>
  446. <td class="description last">The serialization function for inputs</td>
  447. </tr>
  448. <tr>
  449. <td class="name"><code>deserialize</code></td>
  450. <td class="type">
  451. <span class="param-type">function</span>
  452. </td>
  453. <td class="description last">The deserialization function for
  454. outputs</td>
  455. </tr>
  456. </tbody>
  457. </table>
  458. <dl class="details">
  459. <dt class="tag-source">Source:</dt>
  460. <dd class="tag-source"><ul class="dummy"><li>
  461. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line593">line 593</a>
  462. </li></ul></dd>
  463. </dl>
  464. <h5>Returns:</h5>
  465. <div class="param-desc">
  466. makeBidiStreamRequest
  467. </div>
  468. <dl>
  469. <dt>
  470. Type
  471. </dt>
  472. <dd>
  473. <span class="param-type">function</span>
  474. </dd>
  475. </dl>
  476. <h4 class="name" id="~makeClientStreamRequestFunction"><span class="type-signature">(inner) </span>makeClientStreamRequestFunction<span class="signature">(method, serialize, deserialize)</span><span class="type-signature"> &rarr; {function}</span></h4>
  477. <div class="description">
  478. Get a function that can make client stream requests to the specified method.
  479. </div>
  480. <h5>Parameters:</h5>
  481. <table class="params">
  482. <thead>
  483. <tr>
  484. <th>Name</th>
  485. <th>Type</th>
  486. <th class="last">Description</th>
  487. </tr>
  488. </thead>
  489. <tbody>
  490. <tr>
  491. <td class="name"><code>method</code></td>
  492. <td class="type">
  493. <span class="param-type">string</span>
  494. </td>
  495. <td class="description last">The name of the method to request</td>
  496. </tr>
  497. <tr>
  498. <td class="name"><code>serialize</code></td>
  499. <td class="type">
  500. <span class="param-type">function</span>
  501. </td>
  502. <td class="description last">The serialization function for inputs</td>
  503. </tr>
  504. <tr>
  505. <td class="name"><code>deserialize</code></td>
  506. <td class="type">
  507. <span class="param-type">function</span>
  508. </td>
  509. <td class="description last">The deserialization function for
  510. outputs</td>
  511. </tr>
  512. </tbody>
  513. </table>
  514. <dl class="details">
  515. <dt class="tag-source">Source:</dt>
  516. <dd class="tag-source"><ul class="dummy"><li>
  517. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line441">line 441</a>
  518. </li></ul></dd>
  519. </dl>
  520. <h5>Returns:</h5>
  521. <div class="param-desc">
  522. makeClientStreamRequest
  523. </div>
  524. <dl>
  525. <dt>
  526. Type
  527. </dt>
  528. <dd>
  529. <span class="param-type">function</span>
  530. </dd>
  531. </dl>
  532. <h4 class="name" id="~makeServerStreamRequestFunction"><span class="type-signature">(inner) </span>makeServerStreamRequestFunction<span class="signature">(method, serialize, deserialize)</span><span class="type-signature"> &rarr; {function}</span></h4>
  533. <div class="description">
  534. Get a function that can make server stream requests to the specified method.
  535. </div>
  536. <h5>Parameters:</h5>
  537. <table class="params">
  538. <thead>
  539. <tr>
  540. <th>Name</th>
  541. <th>Type</th>
  542. <th class="last">Description</th>
  543. </tr>
  544. </thead>
  545. <tbody>
  546. <tr>
  547. <td class="name"><code>method</code></td>
  548. <td class="type">
  549. <span class="param-type">string</span>
  550. </td>
  551. <td class="description last">The name of the method to request</td>
  552. </tr>
  553. <tr>
  554. <td class="name"><code>serialize</code></td>
  555. <td class="type">
  556. <span class="param-type">function</span>
  557. </td>
  558. <td class="description last">The serialization function for inputs</td>
  559. </tr>
  560. <tr>
  561. <td class="name"><code>deserialize</code></td>
  562. <td class="type">
  563. <span class="param-type">function</span>
  564. </td>
  565. <td class="description last">The deserialization function for
  566. outputs</td>
  567. </tr>
  568. </tbody>
  569. </table>
  570. <dl class="details">
  571. <dt class="tag-source">Source:</dt>
  572. <dd class="tag-source"><ul class="dummy"><li>
  573. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line527">line 527</a>
  574. </li></ul></dd>
  575. </dl>
  576. <h5>Returns:</h5>
  577. <div class="param-desc">
  578. makeServerStreamRequest
  579. </div>
  580. <dl>
  581. <dt>
  582. Type
  583. </dt>
  584. <dd>
  585. <span class="param-type">function</span>
  586. </dd>
  587. </dl>
  588. <h4 class="name" id="~makeUnaryRequestFunction"><span class="type-signature">(inner) </span>makeUnaryRequestFunction<span class="signature">(method, serialize, deserialize)</span><span class="type-signature"> &rarr; {function}</span></h4>
  589. <div class="description">
  590. Get a function that can make unary requests to the specified method.
  591. </div>
  592. <h5>Parameters:</h5>
  593. <table class="params">
  594. <thead>
  595. <tr>
  596. <th>Name</th>
  597. <th>Type</th>
  598. <th class="last">Description</th>
  599. </tr>
  600. </thead>
  601. <tbody>
  602. <tr>
  603. <td class="name"><code>method</code></td>
  604. <td class="type">
  605. <span class="param-type">string</span>
  606. </td>
  607. <td class="description last">The name of the method to request</td>
  608. </tr>
  609. <tr>
  610. <td class="name"><code>serialize</code></td>
  611. <td class="type">
  612. <span class="param-type">function</span>
  613. </td>
  614. <td class="description last">The serialization function for inputs</td>
  615. </tr>
  616. <tr>
  617. <td class="name"><code>deserialize</code></td>
  618. <td class="type">
  619. <span class="param-type">function</span>
  620. </td>
  621. <td class="description last">The deserialization function for
  622. outputs</td>
  623. </tr>
  624. </tbody>
  625. </table>
  626. <dl class="details">
  627. <dt class="tag-source">Source:</dt>
  628. <dd class="tag-source"><ul class="dummy"><li>
  629. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line350">line 350</a>
  630. </li></ul></dd>
  631. </dl>
  632. <h5>Returns:</h5>
  633. <div class="param-desc">
  634. makeUnaryRequest
  635. </div>
  636. <dl>
  637. <dt>
  638. Type
  639. </dt>
  640. <dd>
  641. <span class="param-type">function</span>
  642. </dd>
  643. </dl>
  644. </article>
  645. </section>
  646. </div>
  647. <nav>
  648. <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>
  649. </nav>
  650. <br class="clear">
  651. <footer>
  652. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed May 11 2016 18:17:25 GMT-0700 (PDT)
  653. </footer>
  654. <script> prettyPrint(); </script>
  655. <script src="scripts/linenumber.js"> </script>
  656. </body>
  657. </html>