module-src_client.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163
  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</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_client.js.html">src/client.js</a>, <a href="src_client.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_client-ClientDuplexStream.html">ClientDuplexStream</a></dt>
  33. <dd></dd>
  34. <dt><a href="module-src_client-ClientReadableStream.html">ClientReadableStream</a></dt>
  35. <dd></dd>
  36. <dt><a href="module-src_client-ClientWritableStream.html">ClientWritableStream</a></dt>
  37. <dd></dd>
  38. </dl>
  39. <h3 class="subsection-title">Members</h3>
  40. <h4 class="name" id=".callError"><span class="type-signature">(static) </span>callError<span class="type-signature"></span></h4>
  41. <div class="description">
  42. See docs for client.callError
  43. </div>
  44. <dl class="details">
  45. <dt class="tag-source">Source:</dt>
  46. <dd class="tag-source"><ul class="dummy"><li>
  47. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line733">line 733</a>
  48. </li></ul></dd>
  49. </dl>
  50. <h4 class="name" id=".status"><span class="type-signature">(static) </span>status<span class="type-signature"></span></h4>
  51. <div class="description">
  52. Map of status code names to status codes
  53. </div>
  54. <dl class="details">
  55. <dt class="tag-source">Source:</dt>
  56. <dd class="tag-source"><ul class="dummy"><li>
  57. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line728">line 728</a>
  58. </li></ul></dd>
  59. </dl>
  60. <h4 class="name" id="~requester_makers"><span class="type-signature">(inner) </span>requester_makers<span class="type-signature"></span></h4>
  61. <div class="description">
  62. Map with short names for each of the requester maker functions. Used in
  63. makeClientConstructor
  64. </div>
  65. <dl class="details">
  66. <dt class="tag-source">Source:</dt>
  67. <dd class="tag-source"><ul class="dummy"><li>
  68. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line593">line 593</a>
  69. </li></ul></dd>
  70. </dl>
  71. <h3 class="subsection-title">Methods</h3>
  72. <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>
  73. <div class="description">
  74. Return the underlying channel object for the specified client
  75. </div>
  76. <h5>Parameters:</h5>
  77. <table class="params">
  78. <thead>
  79. <tr>
  80. <th>Name</th>
  81. <th>Type</th>
  82. <th class="last">Description</th>
  83. </tr>
  84. </thead>
  85. <tbody>
  86. <tr>
  87. <td class="name"><code>client</code></td>
  88. <td class="type">
  89. <span class="param-type">Client</span>
  90. </td>
  91. <td class="description last"></td>
  92. </tr>
  93. </tbody>
  94. </table>
  95. <dl class="details">
  96. <dt class="tag-source">Source:</dt>
  97. <dd class="tag-source"><ul class="dummy"><li>
  98. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line678">line 678</a>
  99. </li></ul></dd>
  100. </dl>
  101. <h5>Returns:</h5>
  102. <div class="param-desc">
  103. The channel
  104. </div>
  105. <dl>
  106. <dt>
  107. Type
  108. </dt>
  109. <dd>
  110. <span class="param-type">Channel</span>
  111. </dd>
  112. </dl>
  113. <h4 class="name" id=".makeClientConstructor"><span class="type-signature">(static) </span>makeClientConstructor<span class="signature">(methods, serviceName)</span><span class="type-signature"> &rarr; {function}</span></h4>
  114. <div class="description">
  115. Creates a constructor for a client with the given methods. The methods object
  116. maps method name to an object with the following keys:
  117. path: The path on the server for accessing the method. For example, for
  118. protocol buffers, we use "/service_name/method_name"
  119. requestStream: bool indicating whether the client sends a stream
  120. resonseStream: bool indicating whether the server sends a stream
  121. requestSerialize: function to serialize request objects
  122. responseDeserialize: function to deserialize response objects
  123. </div>
  124. <h5>Parameters:</h5>
  125. <table class="params">
  126. <thead>
  127. <tr>
  128. <th>Name</th>
  129. <th>Type</th>
  130. <th class="last">Description</th>
  131. </tr>
  132. </thead>
  133. <tbody>
  134. <tr>
  135. <td class="name"><code>methods</code></td>
  136. <td class="type">
  137. <span class="param-type">Object</span>
  138. </td>
  139. <td class="description last">An object mapping method names to method attributes</td>
  140. </tr>
  141. <tr>
  142. <td class="name"><code>serviceName</code></td>
  143. <td class="type">
  144. <span class="param-type">string</span>
  145. </td>
  146. <td class="description last">The fully qualified name of the service</td>
  147. </tr>
  148. </tbody>
  149. </table>
  150. <dl class="details">
  151. <dt class="tag-source">Source:</dt>
  152. <dd class="tag-source"><ul class="dummy"><li>
  153. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line613">line 613</a>
  154. </li></ul></dd>
  155. </dl>
  156. <h5>Returns:</h5>
  157. <div class="param-desc">
  158. New client constructor
  159. </div>
  160. <dl>
  161. <dt>
  162. Type
  163. </dt>
  164. <dd>
  165. <span class="param-type">function</span>
  166. </dd>
  167. </dl>
  168. <h4 class="name" id=".makeProtobufClientConstructor"><span class="type-signature">(static) </span>makeProtobufClientConstructor<span class="signature">(service)</span><span class="type-signature"> &rarr; {function}</span></h4>
  169. <div class="description">
  170. Creates a constructor for clients for the given service
  171. </div>
  172. <h5>Parameters:</h5>
  173. <table class="params">
  174. <thead>
  175. <tr>
  176. <th>Name</th>
  177. <th>Type</th>
  178. <th class="last">Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td class="name"><code>service</code></td>
  184. <td class="type">
  185. <span class="param-type">ProtoBuf.Reflect.Service</span>
  186. </td>
  187. <td class="description last">The service to generate a client
  188. for</td>
  189. </tr>
  190. </tbody>
  191. </table>
  192. <dl class="details">
  193. <dt class="tag-source">Source:</dt>
  194. <dd class="tag-source"><ul class="dummy"><li>
  195. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line717">line 717</a>
  196. </li></ul></dd>
  197. </dl>
  198. <h5>Returns:</h5>
  199. <div class="param-desc">
  200. New client constructor
  201. </div>
  202. <dl>
  203. <dt>
  204. Type
  205. </dt>
  206. <dd>
  207. <span class="param-type">function</span>
  208. </dd>
  209. </dl>
  210. <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>
  211. <div class="description">
  212. Wait for the client to be ready. The callback will be called when the
  213. client has successfully connected to the server, and it will be called
  214. with an error if the attempt to connect to the server has unrecoverablly
  215. failed or if the deadline expires. This function will make the channel
  216. start connecting if it has not already done so.
  217. </div>
  218. <h5>Parameters:</h5>
  219. <table class="params">
  220. <thead>
  221. <tr>
  222. <th>Name</th>
  223. <th>Type</th>
  224. <th class="last">Description</th>
  225. </tr>
  226. </thead>
  227. <tbody>
  228. <tr>
  229. <td class="name"><code>client</code></td>
  230. <td class="type">
  231. <span class="param-type">Client</span>
  232. </td>
  233. <td class="description last">The client to wait on</td>
  234. </tr>
  235. <tr>
  236. <td class="name"><code>deadline</code></td>
  237. <td class="type">
  238. <span class="param-type">Date</span>
  239. |
  240. <span class="param-type">Number</span>
  241. </td>
  242. <td class="description last">When to stop waiting for a connection. Pass
  243. Infinity to wait forever.</td>
  244. </tr>
  245. <tr>
  246. <td class="name"><code>callback</code></td>
  247. <td class="type">
  248. <span class="param-type">function</span>
  249. </td>
  250. <td class="description last">The callback to call when done attempting
  251. to connect.</td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <dl class="details">
  256. <dt class="tag-source">Source:</dt>
  257. <dd class="tag-source"><ul class="dummy"><li>
  258. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line694">line 694</a>
  259. </li></ul></dd>
  260. </dl>
  261. <h4 class="name" id="~cancel"><span class="type-signature">(inner) </span>cancel<span class="signature">()</span><span class="type-signature"></span></h4>
  262. <div class="description">
  263. Cancel the ongoing call
  264. </div>
  265. <dl class="details">
  266. <dt class="tag-source">Source:</dt>
  267. <dd class="tag-source"><ul class="dummy"><li>
  268. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line203">line 203</a>
  269. </li></ul></dd>
  270. </dl>
  271. <h4 class="name" id="~getCall"><span class="type-signature">(inner) </span>getCall<span class="signature">(options)</span><span class="type-signature"></span></h4>
  272. <div class="description">
  273. Get a call object built with the provided options. Keys for options are
  274. 'deadline', which takes a date or number, and 'host', which takes a string
  275. and overrides the hostname to connect to.
  276. </div>
  277. <h5>Parameters:</h5>
  278. <table class="params">
  279. <thead>
  280. <tr>
  281. <th>Name</th>
  282. <th>Type</th>
  283. <th class="last">Description</th>
  284. </tr>
  285. </thead>
  286. <tbody>
  287. <tr>
  288. <td class="name"><code>options</code></td>
  289. <td class="type">
  290. <span class="param-type">Object</span>
  291. </td>
  292. <td class="description last">Options map.</td>
  293. </tr>
  294. </tbody>
  295. </table>
  296. <dl class="details">
  297. <dt class="tag-source">Source:</dt>
  298. <dd class="tag-source"><ul class="dummy"><li>
  299. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line231">line 231</a>
  300. </li></ul></dd>
  301. </dl>
  302. <h4 class="name" id="~getPeer"><span class="type-signature">(inner) </span>getPeer<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  303. <div class="description">
  304. Get the endpoint this call/stream is connected to.
  305. </div>
  306. <dl class="details">
  307. <dt class="tag-source">Source:</dt>
  308. <dd class="tag-source"><ul class="dummy"><li>
  309. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line216">line 216</a>
  310. </li></ul></dd>
  311. </dl>
  312. <h5>Returns:</h5>
  313. <div class="param-desc">
  314. The URI of the endpoint
  315. </div>
  316. <dl>
  317. <dt>
  318. Type
  319. </dt>
  320. <dd>
  321. <span class="param-type">string</span>
  322. </dd>
  323. </dl>
  324. <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>
  325. <div class="description">
  326. Get a function that can make bidirectional stream requests to the specified
  327. method.
  328. </div>
  329. <h5>Parameters:</h5>
  330. <table class="params">
  331. <thead>
  332. <tr>
  333. <th>Name</th>
  334. <th>Type</th>
  335. <th class="last">Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td class="name"><code>method</code></td>
  341. <td class="type">
  342. <span class="param-type">string</span>
  343. </td>
  344. <td class="description last">The name of the method to request</td>
  345. </tr>
  346. <tr>
  347. <td class="name"><code>serialize</code></td>
  348. <td class="type">
  349. <span class="param-type">function</span>
  350. </td>
  351. <td class="description last">The serialization function for inputs</td>
  352. </tr>
  353. <tr>
  354. <td class="name"><code>deserialize</code></td>
  355. <td class="type">
  356. <span class="param-type">function</span>
  357. </td>
  358. <td class="description last">The deserialization function for
  359. outputs</td>
  360. </tr>
  361. </tbody>
  362. </table>
  363. <dl class="details">
  364. <dt class="tag-source">Source:</dt>
  365. <dd class="tag-source"><ul class="dummy"><li>
  366. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line525">line 525</a>
  367. </li></ul></dd>
  368. </dl>
  369. <h5>Returns:</h5>
  370. <div class="param-desc">
  371. makeBidiStreamRequest
  372. </div>
  373. <dl>
  374. <dt>
  375. Type
  376. </dt>
  377. <dd>
  378. <span class="param-type">function</span>
  379. </dd>
  380. </dl>
  381. <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>
  382. <div class="description">
  383. Get a function that can make client stream requests to the specified method.
  384. </div>
  385. <h5>Parameters:</h5>
  386. <table class="params">
  387. <thead>
  388. <tr>
  389. <th>Name</th>
  390. <th>Type</th>
  391. <th class="last">Description</th>
  392. </tr>
  393. </thead>
  394. <tbody>
  395. <tr>
  396. <td class="name"><code>method</code></td>
  397. <td class="type">
  398. <span class="param-type">string</span>
  399. </td>
  400. <td class="description last">The name of the method to request</td>
  401. </tr>
  402. <tr>
  403. <td class="name"><code>serialize</code></td>
  404. <td class="type">
  405. <span class="param-type">function</span>
  406. </td>
  407. <td class="description last">The serialization function for inputs</td>
  408. </tr>
  409. <tr>
  410. <td class="name"><code>deserialize</code></td>
  411. <td class="type">
  412. <span class="param-type">function</span>
  413. </td>
  414. <td class="description last">The deserialization function for
  415. outputs</td>
  416. </tr>
  417. </tbody>
  418. </table>
  419. <dl class="details">
  420. <dt class="tag-source">Source:</dt>
  421. <dd class="tag-source"><ul class="dummy"><li>
  422. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line353">line 353</a>
  423. </li></ul></dd>
  424. </dl>
  425. <h5>Returns:</h5>
  426. <div class="param-desc">
  427. makeClientStreamRequest
  428. </div>
  429. <dl>
  430. <dt>
  431. Type
  432. </dt>
  433. <dd>
  434. <span class="param-type">function</span>
  435. </dd>
  436. </dl>
  437. <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>
  438. <div class="description">
  439. Get a function that can make server stream requests to the specified method.
  440. </div>
  441. <h5>Parameters:</h5>
  442. <table class="params">
  443. <thead>
  444. <tr>
  445. <th>Name</th>
  446. <th>Type</th>
  447. <th class="last">Description</th>
  448. </tr>
  449. </thead>
  450. <tbody>
  451. <tr>
  452. <td class="name"><code>method</code></td>
  453. <td class="type">
  454. <span class="param-type">string</span>
  455. </td>
  456. <td class="description last">The name of the method to request</td>
  457. </tr>
  458. <tr>
  459. <td class="name"><code>serialize</code></td>
  460. <td class="type">
  461. <span class="param-type">function</span>
  462. </td>
  463. <td class="description last">The serialization function for inputs</td>
  464. </tr>
  465. <tr>
  466. <td class="name"><code>deserialize</code></td>
  467. <td class="type">
  468. <span class="param-type">function</span>
  469. </td>
  470. <td class="description last">The deserialization function for
  471. outputs</td>
  472. </tr>
  473. </tbody>
  474. </table>
  475. <dl class="details">
  476. <dt class="tag-source">Source:</dt>
  477. <dd class="tag-source"><ul class="dummy"><li>
  478. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line444">line 444</a>
  479. </li></ul></dd>
  480. </dl>
  481. <h5>Returns:</h5>
  482. <div class="param-desc">
  483. makeServerStreamRequest
  484. </div>
  485. <dl>
  486. <dt>
  487. Type
  488. </dt>
  489. <dd>
  490. <span class="param-type">function</span>
  491. </dd>
  492. </dl>
  493. <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>
  494. <div class="description">
  495. Get a function that can make unary requests to the specified method.
  496. </div>
  497. <h5>Parameters:</h5>
  498. <table class="params">
  499. <thead>
  500. <tr>
  501. <th>Name</th>
  502. <th>Type</th>
  503. <th class="last">Description</th>
  504. </tr>
  505. </thead>
  506. <tbody>
  507. <tr>
  508. <td class="name"><code>method</code></td>
  509. <td class="type">
  510. <span class="param-type">string</span>
  511. </td>
  512. <td class="description last">The name of the method to request</td>
  513. </tr>
  514. <tr>
  515. <td class="name"><code>serialize</code></td>
  516. <td class="type">
  517. <span class="param-type">function</span>
  518. </td>
  519. <td class="description last">The serialization function for inputs</td>
  520. </tr>
  521. <tr>
  522. <td class="name"><code>deserialize</code></td>
  523. <td class="type">
  524. <span class="param-type">function</span>
  525. </td>
  526. <td class="description last">The deserialization function for
  527. outputs</td>
  528. </tr>
  529. </tbody>
  530. </table>
  531. <dl class="details">
  532. <dt class="tag-source">Source:</dt>
  533. <dd class="tag-source"><ul class="dummy"><li>
  534. <a href="src_client.js.html">src/client.js</a>, <a href="src_client.js.html#line257">line 257</a>
  535. </li></ul></dd>
  536. </dl>
  537. <h5>Returns:</h5>
  538. <div class="param-desc">
  539. makeUnaryRequest
  540. </div>
  541. <dl>
  542. <dt>
  543. Type
  544. </dt>
  545. <dd>
  546. <span class="param-type">function</span>
  547. </dd>
  548. </dl>
  549. </article>
  550. </section>
  551. </div>
  552. <nav>
  553. <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>
  554. </nav>
  555. <br class="clear">
  556. <footer>
  557. 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)
  558. </footer>
  559. <script> prettyPrint(); </script>
  560. <script src="scripts/linenumber.js"> </script>
  561. </body>
  562. </html>