interface_g_r_p_c_call.html 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Objective-C: GRPCCall Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Objective-C
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-methods">Instance Methods</a> &#124;
  65. <a href="#pub-static-methods">Class Methods</a> &#124;
  66. <a href="#properties">Properties</a> </div>
  67. <div class="headertitle">
  68. <div class="title">GRPCCall Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>This is the legacy interface of this gRPC library.
  72. <a href="interface_g_r_p_c_call.html#details">More...</a></p>
  73. <p><code>#import &lt;<a class="el" href="_g_r_p_c_call_legacy_8h_source.html">GRPCCallLegacy.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Instance Methods</h2></td></tr>
  77. <tr class="memitem:a4a103787d117d9a2c96ac6bd19427ea9"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call.html#a4a103787d117d9a2c96ac6bd19427ea9">NS_UNAVAILABLE</a></td></tr>
  78. <tr class="separator:a4a103787d117d9a2c96ac6bd19427ea9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="inherit_header pub_methods_interface_g_r_x_writer"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interface_g_r_x_writer')"><img src="closed.png" alt="-"/>&#160;Instance Methods inherited from <a class="el" href="interface_g_r_x_writer.html">GRXWriter</a></td></tr>
  80. <tr class="memitem:aa76ca568d962fa003c1c0946d39a7a73 inherit pub_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_x_writer.html#aa76ca568d962fa003c1c0946d39a7a73">startWithWriteable:</a></td></tr>
  81. <tr class="memdesc:aa76ca568d962fa003c1c0946d39a7a73 inherit pub_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transition to the Started state, and start sending messages to the writeable (a reference to it is retained). <a href="interface_g_r_x_writer.html#aa76ca568d962fa003c1c0946d39a7a73">More...</a><br /></td></tr>
  82. <tr class="separator:aa76ca568d962fa003c1c0946d39a7a73 inherit pub_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ae65b0e62d3341a6871c0d93fbe2e8e35 inherit pub_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_x_writer.html#ae65b0e62d3341a6871c0d93fbe2e8e35">finishWithError:</a></td></tr>
  84. <tr class="memdesc:ae65b0e62d3341a6871c0d93fbe2e8e35 inherit pub_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send writesFinishedWithError:errorOrNil to the writeable. <a href="interface_g_r_x_writer.html#ae65b0e62d3341a6871c0d93fbe2e8e35">More...</a><br /></td></tr>
  85. <tr class="separator:ae65b0e62d3341a6871c0d93fbe2e8e35 inherit pub_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a8974f26da2c68512d6b0000f591f9630 inherit pub_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_x_writer.html#a8974f26da2c68512d6b0000f591f9630">map:</a></td></tr>
  87. <tr class="memdesc:a8974f26da2c68512d6b0000f591f9630 inherit pub_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that wraps the receiver, and has all the values the receiver would write transformed by the provided mapping function. <a href="interface_g_r_x_writer.html#a8974f26da2c68512d6b0000f591f9630">More...</a><br /></td></tr>
  88. <tr class="separator:a8974f26da2c68512d6b0000f591f9630 inherit pub_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  91. Class Methods</h2></td></tr>
  92. <tr class="memitem:a37dcd500194ef6a88bdfef0e7300a0a3"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a37dcd500194ef6a88bdfef0e7300a0a3">setUserAgentPrefix:forHost:</a></td></tr>
  93. <tr class="separator:a37dcd500194ef6a88bdfef0e7300a0a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a3ef8153d1ea2a2bb8bcfc7e037451b06"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a3ef8153d1ea2a2bb8bcfc7e037451b06">setResponseSizeLimit:forHost:</a></td></tr>
  95. <tr class="separator:a3ef8153d1ea2a2bb8bcfc7e037451b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a8d045ade7403654462b6318e9df482e1"><td class="memItemLeft" align="right" valign="top">(&quot;The API for this feature is experimental, &quot; &quot;and might be removed or modified at any &quot; &quot;time.&quot;)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a8d045ade7403654462b6318e9df482e1">DEPRECATED_MSG_ATTRIBUTE</a></td></tr>
  97. <tr class="separator:a8d045ade7403654462b6318e9df482e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ad00bae93f995c25a1991e81435ac155c"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#ad00bae93f995c25a1991e81435ac155c">setDefaultCompressMethod:forhost:</a></td></tr>
  99. <tr class="separator:ad00bae93f995c25a1991e81435ac155c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a7c74e844be31d7fd0c4aa8c6db44716c"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a7c74e844be31d7fd0c4aa8c6db44716c">setKeepaliveWithInterval:timeout:forHost:</a></td></tr>
  101. <tr class="separator:a7c74e844be31d7fd0c4aa8c6db44716c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ab2f3162babe3c83da8897dd4c127b994"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#ab2f3162babe3c83da8897dd4c127b994">enableRetry:forHost:</a></td></tr>
  103. <tr class="separator:ab2f3162babe3c83da8897dd4c127b994"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:acdfbd6ff0658ee731b8c0c7242f44580"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#acdfbd6ff0658ee731b8c0c7242f44580">setMinConnectTimeout:initialBackoff:maxBackoff:forHost:</a></td></tr>
  105. <tr class="separator:acdfbd6ff0658ee731b8c0c7242f44580"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a7106a28e27c41795fb4b4a08d597ccf1"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a7106a28e27c41795fb4b4a08d597ccf1">setTLSPEMRootCerts:forHost:error:</a></td></tr>
  107. <tr class="separator:a7106a28e27c41795fb4b4a08d597ccf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a42a163489b038817adef235be8776825"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a42a163489b038817adef235be8776825">setTLSPEMRootCerts:withPrivateKey:withCertChain:forHost:error:</a></td></tr>
  109. <tr class="separator:a42a163489b038817adef235be8776825"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ad1b2c6c52d457ef3430cd4231cadff35"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#ad1b2c6c52d457ef3430cd4231cadff35">useCronetWithEngine:</a></td></tr>
  111. <tr class="separator:ad1b2c6c52d457ef3430cd4231cadff35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a8d36aa504711973fc1cd14772d9fed7d"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="_g_r_p_c_call_09_cronet_8h.html#a7af5da50e43e0e2787473025918ed4ca">stream_engine</a> *)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#a8d36aa504711973fc1cd14772d9fed7d">cronetEngine</a></td></tr>
  113. <tr class="separator:a8d36aa504711973fc1cd14772d9fed7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:abacdea4968b72c4a30c1bc35b51d4b2a"><td class="memItemLeft" align="right" valign="top">(BOOL)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#abacdea4968b72c4a30c1bc35b51d4b2a">isUsingCronet</a></td></tr>
  115. <tr class="separator:abacdea4968b72c4a30c1bc35b51d4b2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:afd48790f9bed75d15a23312fa2bed1d1"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#afd48790f9bed75d15a23312fa2bed1d1">useTestCertsPath:testName:forHost:</a></td></tr>
  117. <tr class="separator:afd48790f9bed75d15a23312fa2bed1d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ab691fa92ba6452827759ef75b11045b8"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#ab691fa92ba6452827759ef75b11045b8">useInsecureConnectionsForHost:</a></td></tr>
  119. <tr class="separator:ab691fa92ba6452827759ef75b11045b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:aeceaad197ffe1e67e147c9537149dd60"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#aeceaad197ffe1e67e147c9537149dd60">resetHostSettings</a></td></tr>
  121. <tr class="separator:aeceaad197ffe1e67e147c9537149dd60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="inherit_header pub_static_methods_interface_g_r_x_writer"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_interface_g_r_x_writer')"><img src="closed.png" alt="-"/>&#160;Class Methods inherited from <a class="el" href="interface_g_r_x_writer.html">GRXWriter</a></td></tr>
  123. <tr class="memitem:a085c38cbcf5e24fab202b10e7d688231 inherit pub_static_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_writer.html#a085c38cbcf5e24fab202b10e7d688231">writerWithEnumerator:</a></td></tr>
  124. <tr class="memdesc:a085c38cbcf5e24fab202b10e7d688231 inherit pub_static_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that pulls values from the passed NSEnumerator instance and pushes them to its writeable. <a href="interface_g_r_x_writer.html#a085c38cbcf5e24fab202b10e7d688231">More...</a><br /></td></tr>
  125. <tr class="separator:a085c38cbcf5e24fab202b10e7d688231 inherit pub_static_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:ac51760afcaefbc72a0de9c3c4e7f06fa inherit pub_static_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_writer.html#ac51760afcaefbc72a0de9c3c4e7f06fa">writerWithValueSupplier:</a></td></tr>
  127. <tr class="memdesc:ac51760afcaefbc72a0de9c3c4e7f06fa inherit pub_static_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that pushes to its writeable the successive values returned by the passed block. <a href="interface_g_r_x_writer.html#ac51760afcaefbc72a0de9c3c4e7f06fa">More...</a><br /></td></tr>
  128. <tr class="separator:ac51760afcaefbc72a0de9c3c4e7f06fa inherit pub_static_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a2280d44f0ebd30ee4b5d53b4709ed828 inherit pub_static_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_writer.html#a2280d44f0ebd30ee4b5d53b4709ed828">writerWithContainer:</a></td></tr>
  130. <tr class="memdesc:a2280d44f0ebd30ee4b5d53b4709ed828 inherit pub_static_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that iterates over the values of the passed container and pushes them to its writeable. <a href="interface_g_r_x_writer.html#a2280d44f0ebd30ee4b5d53b4709ed828">More...</a><br /></td></tr>
  131. <tr class="separator:a2280d44f0ebd30ee4b5d53b4709ed828 inherit pub_static_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a20c40669544f1987dc524397b94dc99d inherit pub_static_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_writer.html#a20c40669544f1987dc524397b94dc99d">writerWithValue:</a></td></tr>
  133. <tr class="memdesc:a20c40669544f1987dc524397b94dc99d inherit pub_static_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that sends the passed value to its writeable and then finishes (releasing the value). <a href="interface_g_r_x_writer.html#a20c40669544f1987dc524397b94dc99d">More...</a><br /></td></tr>
  134. <tr class="separator:a20c40669544f1987dc524397b94dc99d inherit pub_static_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a147e6a76005690ff89a710162c072630 inherit pub_static_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_writer.html#a147e6a76005690ff89a710162c072630">writerWithError:</a></td></tr>
  136. <tr class="memdesc:a147e6a76005690ff89a710162c072630 inherit pub_static_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that, as part of its start method, sends the passed error to the writeable (then releasing the error). <a href="interface_g_r_x_writer.html#a147e6a76005690ff89a710162c072630">More...</a><br /></td></tr>
  137. <tr class="separator:a147e6a76005690ff89a710162c072630 inherit pub_static_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a42bd3df3cd21b320f1255a36b23d13f6 inherit pub_static_methods_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_x_writer.html#a42bd3df3cd21b320f1255a36b23d13f6">emptyWriter</a></td></tr>
  139. <tr class="memdesc:a42bd3df3cd21b320f1255a36b23d13f6 inherit pub_static_methods_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a writer that, as part of its start method, finishes immediately without sending any values to its writeable. <a href="interface_g_r_x_writer.html#a42bd3df3cd21b320f1255a36b23d13f6">More...</a><br /></td></tr>
  140. <tr class="separator:a42bd3df3cd21b320f1255a36b23d13f6 inherit pub_static_methods_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. </table><table class="memberdecls">
  142. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  143. Properties</h2></td></tr>
  144. <tr class="memitem:a59b887ecf7843b5a73bcaf38660e9683"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#a59b887ecf7843b5a73bcaf38660e9683">oauth2AccessToken</a></td></tr>
  145. <tr class="separator:a59b887ecf7843b5a73bcaf38660e9683"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a31a0d06ec3de57ad78f730cd6deef108"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#a31a0d06ec3de57ad78f730cd6deef108">oauth2ChallengeHeader</a></td></tr>
  147. <tr class="separator:a31a0d06ec3de57ad78f730cd6deef108"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a6279b2991b6ebabc8f92e28da4ba0cdb"><td class="memItemLeft" align="right" valign="top">id&lt; <a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html">GRPCAuthorizationProtocol</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#a6279b2991b6ebabc8f92e28da4ba0cdb">tokenProvider</a></td></tr>
  149. <tr class="separator:a6279b2991b6ebabc8f92e28da4ba0cdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="inherit_header properties_interface_g_r_x_writer"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_g_r_x_writer')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_g_r_x_writer.html">GRXWriter</a></td></tr>
  151. <tr class="memitem:a9160ff1b22550fe0f0e1ee6f7edd4838 inherit properties_interface_g_r_x_writer"><td class="memItemLeft" align="right" valign="top">GRXWriterState&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_x_writer.html#a9160ff1b22550fe0f0e1ee6f7edd4838">state</a></td></tr>
  152. <tr class="memdesc:a9160ff1b22550fe0f0e1ee6f7edd4838 inherit properties_interface_g_r_x_writer"><td class="mdescLeft">&#160;</td><td class="mdescRight">This property can be used to query the current state of the writer, which determines how it might currently use its writeable. <a href="interface_g_r_x_writer.html#a9160ff1b22550fe0f0e1ee6f7edd4838">More...</a><br /></td></tr>
  153. <tr class="separator:a9160ff1b22550fe0f0e1ee6f7edd4838 inherit properties_interface_g_r_x_writer"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a2ed2de5d312a9d6e6d350f3f6d1b8756"><td class="memItemLeft" align="right" valign="top">NSMutableDictionary *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#a2ed2de5d312a9d6e6d350f3f6d1b8756">requestHeaders</a></td></tr>
  155. <tr class="memdesc:a2ed2de5d312a9d6e6d350f3f6d1b8756"><td class="mdescLeft">&#160;</td><td class="mdescRight">The container of the request headers of an RPC conforms to this protocol, which is a subset of NSMutableDictionary's interface. <a href="interface_g_r_p_c_call.html#a2ed2de5d312a9d6e6d350f3f6d1b8756">More...</a><br /></td></tr>
  156. <tr class="separator:a2ed2de5d312a9d6e6d350f3f6d1b8756"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:ac169b143f3ff705b6d3f3b3b26a53771"><td class="memItemLeft" align="right" valign="top">NSDictionary *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#ac169b143f3ff705b6d3f3b3b26a53771">responseHeaders</a></td></tr>
  158. <tr class="memdesc:ac169b143f3ff705b6d3f3b3b26a53771"><td class="mdescLeft">&#160;</td><td class="mdescRight">This dictionary is populated with the HTTP headers received from the server. <a href="interface_g_r_p_c_call.html#ac169b143f3ff705b6d3f3b3b26a53771">More...</a><br /></td></tr>
  159. <tr class="separator:ac169b143f3ff705b6d3f3b3b26a53771"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a47397e8d3c5f177e7d40f3b5dfbe11f1"><td class="memItemLeft" align="right" valign="top">NSDictionary *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#a47397e8d3c5f177e7d40f3b5dfbe11f1">responseTrailers</a></td></tr>
  161. <tr class="memdesc:a47397e8d3c5f177e7d40f3b5dfbe11f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as responseHeaders, but populated with the HTTP trailers received from the server before the call finishes. <a href="interface_g_r_p_c_call.html#a47397e8d3c5f177e7d40f3b5dfbe11f1">More...</a><br /></td></tr>
  162. <tr class="separator:a47397e8d3c5f177e7d40f3b5dfbe11f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:aa1c3b1f6bb443722fa23586d19b6036f"><td class="memItemLeft" align="right" valign="top">NSString *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#aa1c3b1f6bb443722fa23586d19b6036f">serverName</a></td></tr>
  164. <tr class="separator:aa1c3b1f6bb443722fa23586d19b6036f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a69939e1a3793eecffa72fb1458bf026a"><td class="memItemLeft" align="right" valign="top">NSTimeInterval&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call.html#a69939e1a3793eecffa72fb1458bf026a">timeout</a></td></tr>
  166. <tr class="separator:a69939e1a3793eecffa72fb1458bf026a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ac7c62d02b07afab81f94e41472e506d3"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call.html#ac7c62d02b07afab81f94e41472e506d3">initWithHost:path:requestsWriter:</a></td></tr>
  168. <tr class="memdesc:ac7c62d02b07afab81f94e41472e506d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The request writer has to write NSData objects into the provided Writeable. <a href="interface_g_r_p_c_call.html#ac7c62d02b07afab81f94e41472e506d3">More...</a><br /></td></tr>
  169. <tr class="separator:ac7c62d02b07afab81f94e41472e506d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a0fde84e208ae42ca92bc8a0d7d1e8df3"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call.html#a0fde84e208ae42ca92bc8a0d7d1e8df3">cancel</a></td></tr>
  171. <tr class="memdesc:a0fde84e208ae42ca92bc8a0d7d1e8df3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finishes the request side of this call, notifies the server that the RPC should be cancelled, and finishes the response side of the call with an error of code CANCELED. <a href="interface_g_r_p_c_call.html#a0fde84e208ae42ca92bc8a0d7d1e8df3">More...</a><br /></td></tr>
  172. <tr class="separator:a0fde84e208ae42ca92bc8a0d7d1e8df3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:a7707260e4fdc5c8f7f366db63cbba8b9"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call.html#a7707260e4fdc5c8f7f366db63cbba8b9">setResponseDispatchQueue:</a></td></tr>
  174. <tr class="separator:a7707260e4fdc5c8f7f366db63cbba8b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:ad395d56d49b1b7293cc9981440619fb0"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call.html#ad395d56d49b1b7293cc9981440619fb0">setCallSafety:host:path:</a></td></tr>
  176. <tr class="memdesc:ad395d56d49b1b7293cc9981440619fb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following methods are deprecated. <a href="interface_g_r_p_c_call.html#ad395d56d49b1b7293cc9981440619fb0">More...</a><br /></td></tr>
  177. <tr class="separator:ad395d56d49b1b7293cc9981440619fb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. </table>
  179. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  180. <div class="textblock"><p>This is the legacy interface of this gRPC library. </p>
  181. <p>This API is deprecated and users should use <a class="el" href="interface_g_r_p_c_call2.html" title="A GRPCCall2 object represents an RPC call.">GRPCCall2</a> in <a class="el" href="_g_r_p_c_call_8h.html">GRPCCall.h</a>. This API exists solely for the purpose of backwards compatibility. Represents a single gRPC remote call. </p>
  182. </div><h2 class="groupheader">Method Documentation</h2>
  183. <a id="a0fde84e208ae42ca92bc8a0d7d1e8df3"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#a0fde84e208ae42ca92bc8a0d7d1e8df3">&#9670;&nbsp;</a></span>cancel</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">- (void) cancel </td>
  190. <td></td>
  191. <td class="paramname"></td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Finishes the request side of this call, notifies the server that the RPC should be cancelled, and finishes the response side of the call with an error of code CANCELED. </p>
  197. </div>
  198. </div>
  199. <a id="a8d36aa504711973fc1cd14772d9fed7d"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#a8d36aa504711973fc1cd14772d9fed7d">&#9670;&nbsp;</a></span>cronetEngine</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">+ (<a class="el" href="_g_r_p_c_call_09_cronet_8h.html#a7af5da50e43e0e2787473025918ed4ca">stream_engine</a>*) cronetEngine </td>
  206. <td></td>
  207. <td class="paramname"></td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_cronet_08.html#a8d36aa504711973fc1cd14772d9fed7d">GRPCCall(Cronet)</a>.</p>
  213. </div>
  214. </div>
  215. <a id="a8d045ade7403654462b6318e9df482e1"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#a8d045ade7403654462b6318e9df482e1">&#9670;&nbsp;</a></span>DEPRECATED_MSG_ATTRIBUTE</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">+ (&quot;The API for this feature is experimental, &quot; &quot;and might be removed or modified at any &quot; &quot;time.&quot;) DEPRECATED_MSG_ATTRIBUTE </td>
  222. <td></td>
  223. <td class="paramname"></td>
  224. <td></td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#a8d045ade7403654462b6318e9df482e1">GRPCCall(ChannelArg)</a>.</p>
  229. </div>
  230. </div>
  231. <a id="ab2f3162babe3c83da8897dd4c127b994"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#ab2f3162babe3c83da8897dd4c127b994">&#9670;&nbsp;</a></span>enableRetry:forHost:</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">+ (void) enableRetry: </td>
  238. <td></td>
  239. <td class="paramtype">(BOOL)&#160;</td>
  240. <td class="paramname"><em>enabled</em></td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey">forHost:</td>
  244. <td></td>
  245. <td class="paramtype">(nonnull NSString *)&#160;</td>
  246. <td class="paramname"><em>host</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td></td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#ab2f3162babe3c83da8897dd4c127b994">GRPCCall(ChannelArg)</a>.</p>
  256. </div>
  257. </div>
  258. <a id="ac7c62d02b07afab81f94e41472e506d3"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#ac7c62d02b07afab81f94e41472e506d3">&#9670;&nbsp;</a></span>initWithHost:path:requestsWriter:</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">- (instancetype) initWithHost: </td>
  265. <td></td>
  266. <td class="paramtype">(NSString *)&#160;</td>
  267. <td class="paramname"><em>host</em></td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey">path:</td>
  271. <td></td>
  272. <td class="paramtype">(NSString *)&#160;</td>
  273. <td class="paramname"><em>path</em></td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey">requestsWriter:</td>
  277. <td></td>
  278. <td class="paramtype">(<a class="el" href="interface_g_r_x_writer.html">GRXWriter</a> *)&#160;</td>
  279. <td class="paramname"><em>requestWriter</em>&#160;</td>
  280. </tr>
  281. <tr>
  282. <td></td>
  283. <td></td>
  284. <td></td><td></td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. <p>The request writer has to write NSData objects into the provided Writeable. </p>
  289. <p>The server will receive each of those separately and in order as distinct messages. A gRPC call might not complete until the request writer finishes. On the other hand, the request finishing doesn't necessarily make the call to finish, as the server might continue sending messages to the response side of the call indefinitely (depending on the semantics of the specific remote method called). To finish a call right away, invoke cancel. host parameter should not contain the scheme (<a href="http://">http://</a> or <a href="https://">https://</a>), only the name or IP addr and the port number, for example "localhost:5050". </p>
  290. </div>
  291. </div>
  292. <a id="abacdea4968b72c4a30c1bc35b51d4b2a"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#abacdea4968b72c4a30c1bc35b51d4b2a">&#9670;&nbsp;</a></span>isUsingCronet</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">+ (BOOL) isUsingCronet </td>
  299. <td></td>
  300. <td class="paramname"></td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_cronet_08.html#abacdea4968b72c4a30c1bc35b51d4b2a">GRPCCall(Cronet)</a>.</p>
  306. </div>
  307. </div>
  308. <a id="a4a103787d117d9a2c96ac6bd19427ea9"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#a4a103787d117d9a2c96ac6bd19427ea9">&#9670;&nbsp;</a></span>NS_UNAVAILABLE</h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">- (instancetype) NS_UNAVAILABLE </td>
  315. <td></td>
  316. <td class="paramname"></td>
  317. <td></td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. </div>
  322. </div>
  323. <a id="aeceaad197ffe1e67e147c9537149dd60"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#aeceaad197ffe1e67e147c9537149dd60">&#9670;&nbsp;</a></span>resetHostSettings</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">+ (void) resetHostSettings </td>
  330. <td></td>
  331. <td class="paramname"></td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_tests_08.html#aeceaad197ffe1e67e147c9537149dd60">GRPCCall(Tests)</a>.</p>
  337. </div>
  338. </div>
  339. <a id="ad395d56d49b1b7293cc9981440619fb0"></a>
  340. <h2 class="memtitle"><span class="permalink"><a href="#ad395d56d49b1b7293cc9981440619fb0">&#9670;&nbsp;</a></span>setCallSafety:host:path:</h2>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">+ (void) setCallSafety: </td>
  346. <td></td>
  347. <td class="paramtype">(GRPCCallSafety)&#160;</td>
  348. <td class="paramname"><em>callSafety</em></td>
  349. </tr>
  350. <tr>
  351. <td class="paramkey">host:</td>
  352. <td></td>
  353. <td class="paramtype">(NSString *)&#160;</td>
  354. <td class="paramname"><em>host</em></td>
  355. </tr>
  356. <tr>
  357. <td class="paramkey">path:</td>
  358. <td></td>
  359. <td class="paramtype">(NSString *)&#160;</td>
  360. <td class="paramname"><em>path</em>&#160;</td>
  361. </tr>
  362. <tr>
  363. <td></td>
  364. <td></td>
  365. <td></td><td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>The following methods are deprecated. </p>
  370. </div>
  371. </div>
  372. <a id="ad00bae93f995c25a1991e81435ac155c"></a>
  373. <h2 class="memtitle"><span class="permalink"><a href="#ad00bae93f995c25a1991e81435ac155c">&#9670;&nbsp;</a></span>setDefaultCompressMethod:forhost:</h2>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="memname">
  377. <tr>
  378. <td class="memname">+ (void) setDefaultCompressMethod: </td>
  379. <td></td>
  380. <td class="paramtype">(<a class="el" href="_g_r_p_c_types_8h.html#a6d1c0685676b450f85433dc8b8920153">GRPCCompressAlgorithm</a>)&#160;</td>
  381. <td class="paramname"><em>algorithm</em></td>
  382. </tr>
  383. <tr>
  384. <td class="paramkey">forhost:</td>
  385. <td></td>
  386. <td class="paramtype">(nonnull NSString *)&#160;</td>
  387. <td class="paramname"><em>host</em>&#160;</td>
  388. </tr>
  389. <tr>
  390. <td></td>
  391. <td></td>
  392. <td></td><td></td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#ad00bae93f995c25a1991e81435ac155c">GRPCCall(ChannelArg)</a>.</p>
  397. </div>
  398. </div>
  399. <a id="a7c74e844be31d7fd0c4aa8c6db44716c"></a>
  400. <h2 class="memtitle"><span class="permalink"><a href="#a7c74e844be31d7fd0c4aa8c6db44716c">&#9670;&nbsp;</a></span>setKeepaliveWithInterval:timeout:forHost:</h2>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">+ (void) setKeepaliveWithInterval: </td>
  406. <td></td>
  407. <td class="paramtype">(int)&#160;</td>
  408. <td class="paramname"><em>interval</em></td>
  409. </tr>
  410. <tr>
  411. <td class="paramkey">timeout:</td>
  412. <td></td>
  413. <td class="paramtype">(int)&#160;</td>
  414. <td class="paramname"><em>timeout</em></td>
  415. </tr>
  416. <tr>
  417. <td class="paramkey">forHost:</td>
  418. <td></td>
  419. <td class="paramtype">(nonnull NSString *)&#160;</td>
  420. <td class="paramname"><em>host</em>&#160;</td>
  421. </tr>
  422. <tr>
  423. <td></td>
  424. <td></td>
  425. <td></td><td></td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#a7c74e844be31d7fd0c4aa8c6db44716c">GRPCCall(ChannelArg)</a>.</p>
  430. </div>
  431. </div>
  432. <a id="acdfbd6ff0658ee731b8c0c7242f44580"></a>
  433. <h2 class="memtitle"><span class="permalink"><a href="#acdfbd6ff0658ee731b8c0c7242f44580">&#9670;&nbsp;</a></span>setMinConnectTimeout:initialBackoff:maxBackoff:forHost:</h2>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">+ (void) setMinConnectTimeout: </td>
  439. <td></td>
  440. <td class="paramtype">(unsigned int)&#160;</td>
  441. <td class="paramname"><em>timeout</em></td>
  442. </tr>
  443. <tr>
  444. <td class="paramkey">initialBackoff:</td>
  445. <td></td>
  446. <td class="paramtype">(unsigned int)&#160;</td>
  447. <td class="paramname"><em>initialBackoff</em></td>
  448. </tr>
  449. <tr>
  450. <td class="paramkey">maxBackoff:</td>
  451. <td></td>
  452. <td class="paramtype">(unsigned int)&#160;</td>
  453. <td class="paramname"><em>maxBackoff</em></td>
  454. </tr>
  455. <tr>
  456. <td class="paramkey">forHost:</td>
  457. <td></td>
  458. <td class="paramtype">(nonnull NSString *)&#160;</td>
  459. <td class="paramname"><em>host</em>&#160;</td>
  460. </tr>
  461. <tr>
  462. <td></td>
  463. <td></td>
  464. <td></td><td></td>
  465. </tr>
  466. </table>
  467. </div><div class="memdoc">
  468. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#acdfbd6ff0658ee731b8c0c7242f44580">GRPCCall(ChannelArg)</a>.</p>
  469. </div>
  470. </div>
  471. <a id="a7707260e4fdc5c8f7f366db63cbba8b9"></a>
  472. <h2 class="memtitle"><span class="permalink"><a href="#a7707260e4fdc5c8f7f366db63cbba8b9">&#9670;&nbsp;</a></span>setResponseDispatchQueue:</h2>
  473. <div class="memitem">
  474. <div class="memproto">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">- (void) setResponseDispatchQueue: </td>
  478. <td></td>
  479. <td class="paramtype">(dispatch_queue_t)&#160;</td>
  480. <td class="paramname"><em>queue</em></td>
  481. <td></td>
  482. </tr>
  483. </table>
  484. </div><div class="memdoc">
  485. </div>
  486. </div>
  487. <a id="a3ef8153d1ea2a2bb8bcfc7e037451b06"></a>
  488. <h2 class="memtitle"><span class="permalink"><a href="#a3ef8153d1ea2a2bb8bcfc7e037451b06">&#9670;&nbsp;</a></span>setResponseSizeLimit:forHost:</h2>
  489. <div class="memitem">
  490. <div class="memproto">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname">+ (void) setResponseSizeLimit: </td>
  494. <td></td>
  495. <td class="paramtype">(NSUInteger)&#160;</td>
  496. <td class="paramname"><em>limit</em></td>
  497. </tr>
  498. <tr>
  499. <td class="paramkey">forHost:</td>
  500. <td></td>
  501. <td class="paramtype">(nonnull NSString *)&#160;</td>
  502. <td class="paramname"><em>host</em>&#160;</td>
  503. </tr>
  504. <tr>
  505. <td></td>
  506. <td></td>
  507. <td></td><td></td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#a3ef8153d1ea2a2bb8bcfc7e037451b06">GRPCCall(ChannelArg)</a>.</p>
  512. </div>
  513. </div>
  514. <a id="a7106a28e27c41795fb4b4a08d597ccf1"></a>
  515. <h2 class="memtitle"><span class="permalink"><a href="#a7106a28e27c41795fb4b4a08d597ccf1">&#9670;&nbsp;</a></span>setTLSPEMRootCerts:forHost:error:</h2>
  516. <div class="memitem">
  517. <div class="memproto">
  518. <table class="memname">
  519. <tr>
  520. <td class="memname">+ (BOOL) setTLSPEMRootCerts: </td>
  521. <td></td>
  522. <td class="paramtype">(nullable NSString *)&#160;</td>
  523. <td class="paramname"><em>pemRootCert</em></td>
  524. </tr>
  525. <tr>
  526. <td class="paramkey">forHost:</td>
  527. <td></td>
  528. <td class="paramtype">(nonnull NSString *)&#160;</td>
  529. <td class="paramname"><em>host</em></td>
  530. </tr>
  531. <tr>
  532. <td class="paramkey">error:</td>
  533. <td></td>
  534. <td class="paramtype">(NSError *_Nullable *_Nullable)&#160;</td>
  535. <td class="paramname"><em>errorPtr</em>&#160;</td>
  536. </tr>
  537. <tr>
  538. <td></td>
  539. <td></td>
  540. <td></td><td></td>
  541. </tr>
  542. </table>
  543. </div><div class="memdoc">
  544. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_credentials_08.html#a7106a28e27c41795fb4b4a08d597ccf1">GRPCCall(ChannelCredentials)</a>.</p>
  545. </div>
  546. </div>
  547. <a id="a42a163489b038817adef235be8776825"></a>
  548. <h2 class="memtitle"><span class="permalink"><a href="#a42a163489b038817adef235be8776825">&#9670;&nbsp;</a></span>setTLSPEMRootCerts:withPrivateKey:withCertChain:forHost:error:</h2>
  549. <div class="memitem">
  550. <div class="memproto">
  551. <table class="memname">
  552. <tr>
  553. <td class="memname">+ (BOOL) setTLSPEMRootCerts: </td>
  554. <td></td>
  555. <td class="paramtype">(nullable NSString *)&#160;</td>
  556. <td class="paramname"><em>pemRootCerts</em></td>
  557. </tr>
  558. <tr>
  559. <td class="paramkey">withPrivateKey:</td>
  560. <td></td>
  561. <td class="paramtype">(nullable NSString *)&#160;</td>
  562. <td class="paramname"><em>pemPrivateKey</em></td>
  563. </tr>
  564. <tr>
  565. <td class="paramkey">withCertChain:</td>
  566. <td></td>
  567. <td class="paramtype">(nullable NSString *)&#160;</td>
  568. <td class="paramname"><em>pemCertChain</em></td>
  569. </tr>
  570. <tr>
  571. <td class="paramkey">forHost:</td>
  572. <td></td>
  573. <td class="paramtype">(nonnull NSString *)&#160;</td>
  574. <td class="paramname"><em>host</em></td>
  575. </tr>
  576. <tr>
  577. <td class="paramkey">error:</td>
  578. <td></td>
  579. <td class="paramtype">(NSError *_Nullable *_Nullable)&#160;</td>
  580. <td class="paramname"><em>errorPtr</em>&#160;</td>
  581. </tr>
  582. <tr>
  583. <td></td>
  584. <td></td>
  585. <td></td><td></td>
  586. </tr>
  587. </table>
  588. </div><div class="memdoc">
  589. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_credentials_08.html#a42a163489b038817adef235be8776825">GRPCCall(ChannelCredentials)</a>.</p>
  590. </div>
  591. </div>
  592. <a id="a37dcd500194ef6a88bdfef0e7300a0a3"></a>
  593. <h2 class="memtitle"><span class="permalink"><a href="#a37dcd500194ef6a88bdfef0e7300a0a3">&#9670;&nbsp;</a></span>setUserAgentPrefix:forHost:</h2>
  594. <div class="memitem">
  595. <div class="memproto">
  596. <table class="memname">
  597. <tr>
  598. <td class="memname">+ (void) setUserAgentPrefix: </td>
  599. <td></td>
  600. <td class="paramtype">(nonnull NSString *)&#160;</td>
  601. <td class="paramname"><em>userAgentPrefix</em></td>
  602. </tr>
  603. <tr>
  604. <td class="paramkey">forHost:</td>
  605. <td></td>
  606. <td class="paramtype">(nonnull NSString *)&#160;</td>
  607. <td class="paramname"><em>host</em>&#160;</td>
  608. </tr>
  609. <tr>
  610. <td></td>
  611. <td></td>
  612. <td></td><td></td>
  613. </tr>
  614. </table>
  615. </div><div class="memdoc">
  616. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html#a37dcd500194ef6a88bdfef0e7300a0a3">GRPCCall(ChannelArg)</a>.</p>
  617. </div>
  618. </div>
  619. <a id="ad1b2c6c52d457ef3430cd4231cadff35"></a>
  620. <h2 class="memtitle"><span class="permalink"><a href="#ad1b2c6c52d457ef3430cd4231cadff35">&#9670;&nbsp;</a></span>useCronetWithEngine:</h2>
  621. <div class="memitem">
  622. <div class="memproto">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">+ (void) useCronetWithEngine: </td>
  626. <td></td>
  627. <td class="paramtype">(<a class="el" href="_g_r_p_c_call_09_cronet_8h.html#a7af5da50e43e0e2787473025918ed4ca">stream_engine</a> *)&#160;</td>
  628. <td class="paramname"><em>engine</em></td>
  629. <td></td>
  630. </tr>
  631. </table>
  632. </div><div class="memdoc">
  633. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_cronet_08.html#ad1b2c6c52d457ef3430cd4231cadff35">GRPCCall(Cronet)</a>.</p>
  634. </div>
  635. </div>
  636. <a id="ab691fa92ba6452827759ef75b11045b8"></a>
  637. <h2 class="memtitle"><span class="permalink"><a href="#ab691fa92ba6452827759ef75b11045b8">&#9670;&nbsp;</a></span>useInsecureConnectionsForHost:</h2>
  638. <div class="memitem">
  639. <div class="memproto">
  640. <table class="memname">
  641. <tr>
  642. <td class="memname">+ (void) useInsecureConnectionsForHost: </td>
  643. <td></td>
  644. <td class="paramtype">(NSString *)&#160;</td>
  645. <td class="paramname"><em>host</em></td>
  646. <td></td>
  647. </tr>
  648. </table>
  649. </div><div class="memdoc">
  650. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_tests_08.html#ab691fa92ba6452827759ef75b11045b8">GRPCCall(Tests)</a>.</p>
  651. </div>
  652. </div>
  653. <a id="afd48790f9bed75d15a23312fa2bed1d1"></a>
  654. <h2 class="memtitle"><span class="permalink"><a href="#afd48790f9bed75d15a23312fa2bed1d1">&#9670;&nbsp;</a></span>useTestCertsPath:testName:forHost:</h2>
  655. <div class="memitem">
  656. <div class="memproto">
  657. <table class="memname">
  658. <tr>
  659. <td class="memname">+ (void) useTestCertsPath: </td>
  660. <td></td>
  661. <td class="paramtype">(NSString *)&#160;</td>
  662. <td class="paramname"><em>certsPath</em></td>
  663. </tr>
  664. <tr>
  665. <td class="paramkey">testName:</td>
  666. <td></td>
  667. <td class="paramtype">(NSString *)&#160;</td>
  668. <td class="paramname"><em>testName</em></td>
  669. </tr>
  670. <tr>
  671. <td class="paramkey">forHost:</td>
  672. <td></td>
  673. <td class="paramtype">(NSString *)&#160;</td>
  674. <td class="paramname"><em>host</em>&#160;</td>
  675. </tr>
  676. <tr>
  677. <td></td>
  678. <td></td>
  679. <td></td><td></td>
  680. </tr>
  681. </table>
  682. </div><div class="memdoc">
  683. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_tests_08.html#afd48790f9bed75d15a23312fa2bed1d1">GRPCCall(Tests)</a>.</p>
  684. </div>
  685. </div>
  686. <h2 class="groupheader">Property Documentation</h2>
  687. <a id="a59b887ecf7843b5a73bcaf38660e9683"></a>
  688. <h2 class="memtitle"><span class="permalink"><a href="#a59b887ecf7843b5a73bcaf38660e9683">&#9670;&nbsp;</a></span>oauth2AccessToken</h2>
  689. <div class="memitem">
  690. <div class="memproto">
  691. <table class="mlabels">
  692. <tr>
  693. <td class="mlabels-left">
  694. <table class="memname">
  695. <tr>
  696. <td class="memname">- (NSString*) oauth2AccessToken</td>
  697. </tr>
  698. </table>
  699. </td>
  700. <td class="mlabels-right">
  701. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  702. </tr>
  703. </table>
  704. </div><div class="memdoc">
  705. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_o_auth2_08.html#a59b887ecf7843b5a73bcaf38660e9683">GRPCCall(OAuth2)</a>.</p>
  706. </div>
  707. </div>
  708. <a id="a31a0d06ec3de57ad78f730cd6deef108"></a>
  709. <h2 class="memtitle"><span class="permalink"><a href="#a31a0d06ec3de57ad78f730cd6deef108">&#9670;&nbsp;</a></span>oauth2ChallengeHeader</h2>
  710. <div class="memitem">
  711. <div class="memproto">
  712. <table class="mlabels">
  713. <tr>
  714. <td class="mlabels-left">
  715. <table class="memname">
  716. <tr>
  717. <td class="memname">- (NSString*) oauth2ChallengeHeader</td>
  718. </tr>
  719. </table>
  720. </td>
  721. <td class="mlabels-right">
  722. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  723. </tr>
  724. </table>
  725. </div><div class="memdoc">
  726. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_o_auth2_08.html#a31a0d06ec3de57ad78f730cd6deef108">GRPCCall(OAuth2)</a>.</p>
  727. </div>
  728. </div>
  729. <a id="a2ed2de5d312a9d6e6d350f3f6d1b8756"></a>
  730. <h2 class="memtitle"><span class="permalink"><a href="#a2ed2de5d312a9d6e6d350f3f6d1b8756">&#9670;&nbsp;</a></span>requestHeaders</h2>
  731. <div class="memitem">
  732. <div class="memproto">
  733. <table class="mlabels">
  734. <tr>
  735. <td class="mlabels-left">
  736. <table class="memname">
  737. <tr>
  738. <td class="memname">- (NSMutableDictionary*) requestHeaders</td>
  739. </tr>
  740. </table>
  741. </td>
  742. <td class="mlabels-right">
  743. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  744. </tr>
  745. </table>
  746. </div><div class="memdoc">
  747. <p>The container of the request headers of an RPC conforms to this protocol, which is a subset of NSMutableDictionary's interface. </p>
  748. <p>It will become a NSMutableDictionary later on. The keys of this container are the header names, which per the HTTP standard are case- insensitive. They are stored in lowercase (which is how HTTP/2 mandates them on the wire), and can only consist of ASCII characters. A header value is a NSString object (with only ASCII characters), unless the header name has the suffix "-bin", in which case the value has to be a NSData object. These HTTP headers will be passed to the server as part of this call. Each HTTP header is a name-value pair with string names and either string or binary values.</p>
  749. <p>The passed dictionary has to use NSString keys, corresponding to the header names. The value associated to each can be a NSString object or a NSData object. E.g.:</p>
  750. <p>call.requestHeaders ="authorization": @"Bearer ..."};</p>
  751. <p>call.requestHeaders["my-header-bin"] = someData;</p>
  752. <p>After the call is started, trying to modify this property is an error.</p>
  753. <p>The property is initialized to an empty NSMutableDictionary. </p>
  754. </div>
  755. </div>
  756. <a id="ac169b143f3ff705b6d3f3b3b26a53771"></a>
  757. <h2 class="memtitle"><span class="permalink"><a href="#ac169b143f3ff705b6d3f3b3b26a53771">&#9670;&nbsp;</a></span>responseHeaders</h2>
  758. <div class="memitem">
  759. <div class="memproto">
  760. <table class="mlabels">
  761. <tr>
  762. <td class="mlabels-left">
  763. <table class="memname">
  764. <tr>
  765. <td class="memname">- (NSDictionary*) responseHeaders</td>
  766. </tr>
  767. </table>
  768. </td>
  769. <td class="mlabels-right">
  770. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  771. </tr>
  772. </table>
  773. </div><div class="memdoc">
  774. <p>This dictionary is populated with the HTTP headers received from the server. </p>
  775. <p>This happens before any response message is received from the server. It has the same structure as the request headers dictionary: Keys are NSString header names; names ending with the suffix "-bin" have a NSData value; the others have a NSString value.</p>
  776. <p>The value of this property is nil until all response headers are received, and will change before any of -writeValue: or -writesFinishedWithError: are sent to the writeable. </p>
  777. </div>
  778. </div>
  779. <a id="a47397e8d3c5f177e7d40f3b5dfbe11f1"></a>
  780. <h2 class="memtitle"><span class="permalink"><a href="#a47397e8d3c5f177e7d40f3b5dfbe11f1">&#9670;&nbsp;</a></span>responseTrailers</h2>
  781. <div class="memitem">
  782. <div class="memproto">
  783. <table class="mlabels">
  784. <tr>
  785. <td class="mlabels-left">
  786. <table class="memname">
  787. <tr>
  788. <td class="memname">- (NSDictionary*) responseTrailers</td>
  789. </tr>
  790. </table>
  791. </td>
  792. <td class="mlabels-right">
  793. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  794. </tr>
  795. </table>
  796. </div><div class="memdoc">
  797. <p>Same as responseHeaders, but populated with the HTTP trailers received from the server before the call finishes. </p>
  798. <p>The value of this property is nil until all response trailers are received, and will change before -writesFinishedWithError: is sent to the writeable. </p>
  799. </div>
  800. </div>
  801. <a id="aa1c3b1f6bb443722fa23586d19b6036f"></a>
  802. <h2 class="memtitle"><span class="permalink"><a href="#aa1c3b1f6bb443722fa23586d19b6036f">&#9670;&nbsp;</a></span>serverName</h2>
  803. <div class="memitem">
  804. <div class="memproto">
  805. <table class="mlabels">
  806. <tr>
  807. <td class="mlabels-left">
  808. <table class="memname">
  809. <tr>
  810. <td class="memname">- (NSString*) serverName</td>
  811. </tr>
  812. </table>
  813. </td>
  814. <td class="mlabels-right">
  815. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  816. </tr>
  817. </table>
  818. </div><div class="memdoc">
  819. </div>
  820. </div>
  821. <a id="a69939e1a3793eecffa72fb1458bf026a"></a>
  822. <h2 class="memtitle"><span class="permalink"><a href="#a69939e1a3793eecffa72fb1458bf026a">&#9670;&nbsp;</a></span>timeout</h2>
  823. <div class="memitem">
  824. <div class="memproto">
  825. <table class="mlabels">
  826. <tr>
  827. <td class="mlabels-left">
  828. <table class="memname">
  829. <tr>
  830. <td class="memname">- (NSTimeInterval) timeout</td>
  831. </tr>
  832. </table>
  833. </td>
  834. <td class="mlabels-right">
  835. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">atomic</span></span> </td>
  836. </tr>
  837. </table>
  838. </div><div class="memdoc">
  839. </div>
  840. </div>
  841. <a id="a6279b2991b6ebabc8f92e28da4ba0cdb"></a>
  842. <h2 class="memtitle"><span class="permalink"><a href="#a6279b2991b6ebabc8f92e28da4ba0cdb">&#9670;&nbsp;</a></span>tokenProvider</h2>
  843. <div class="memitem">
  844. <div class="memproto">
  845. <table class="mlabels">
  846. <tr>
  847. <td class="mlabels-left">
  848. <table class="memname">
  849. <tr>
  850. <td class="memname">- (id&lt;<a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html">GRPCAuthorizationProtocol</a>&gt;) tokenProvider</td>
  851. </tr>
  852. </table>
  853. </td>
  854. <td class="mlabels-right">
  855. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">atomic</span><span class="mlabel">strong</span></span> </td>
  856. </tr>
  857. </table>
  858. </div><div class="memdoc">
  859. <p>Provided by category <a class="el" href="category_g_r_p_c_call_07_o_auth2_08.html#a6279b2991b6ebabc8f92e28da4ba0cdb">GRPCCall(OAuth2)</a>.</p>
  860. </div>
  861. </div>
  862. <hr/>The documentation for this class was generated from the following file:<ul>
  863. <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_call_legacy_8h_source.html">GRPCCallLegacy.h</a></li>
  864. </ul>
  865. </div><!-- contents -->
  866. <!-- start footer part -->
  867. <hr class="footer"/><address class="footer"><small>
  868. Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  869. <img class="footer" src="doxygen.png" alt="doxygen"/>
  870. </a> 1.8.17
  871. </small></address>
  872. </body>
  873. </html>