interface_g_r_p_c_call2.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448
  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: GRPCCall2 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">GRPCCall2 Class Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>A <a class="el" href="interface_g_r_p_c_call2.html" title="A GRPCCall2 object represents an RPC call.">GRPCCall2</a> object represents an RPC call.
  72. <a href="interface_g_r_p_c_call2.html#details">More...</a></p>
  73. <p><code>#import &lt;<a class="el" href="_g_r_p_c_call_8h_source.html">GRPCCall.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:a3b7330e0d74134162a3cf2f32bdc9b33"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#a3b7330e0d74134162a3cf2f32bdc9b33">NS_UNAVAILABLE</a></td></tr>
  78. <tr class="separator:a3b7330e0d74134162a3cf2f32bdc9b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a280f18c407c3f3292980fadbd1abfd8e"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#a280f18c407c3f3292980fadbd1abfd8e">initWithRequestOptions:responseHandler:callOptions:</a></td></tr>
  80. <tr class="memdesc:a280f18c407c3f3292980fadbd1abfd8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Designated initializer for a call. <a href="interface_g_r_p_c_call2.html#a280f18c407c3f3292980fadbd1abfd8e">More...</a><br /></td></tr>
  81. <tr class="separator:a280f18c407c3f3292980fadbd1abfd8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ad0adb3624b264d9ce2869faec5a7f193"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#ad0adb3624b264d9ce2869faec5a7f193">initWithRequestOptions:responseHandler:</a></td></tr>
  83. <tr class="memdesc:ad0adb3624b264d9ce2869faec5a7f193"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience initializer for a call that uses default call options (see GRPCCallOptions.m for the default options). <a href="interface_g_r_p_c_call2.html#ad0adb3624b264d9ce2869faec5a7f193">More...</a><br /></td></tr>
  84. <tr class="separator:ad0adb3624b264d9ce2869faec5a7f193"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:af31e80526cf25bfc569d620f8a5ad2dd"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#af31e80526cf25bfc569d620f8a5ad2dd">start</a></td></tr>
  86. <tr class="memdesc:af31e80526cf25bfc569d620f8a5ad2dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the call. <a href="interface_g_r_p_c_call2.html#af31e80526cf25bfc569d620f8a5ad2dd">More...</a><br /></td></tr>
  87. <tr class="separator:af31e80526cf25bfc569d620f8a5ad2dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a7336ef3fd484b2425816e118850ae138"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#a7336ef3fd484b2425816e118850ae138">cancel</a></td></tr>
  89. <tr class="memdesc:a7336ef3fd484b2425816e118850ae138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel the request of this call at best effort. <a href="interface_g_r_p_c_call2.html#a7336ef3fd484b2425816e118850ae138">More...</a><br /></td></tr>
  90. <tr class="separator:a7336ef3fd484b2425816e118850ae138"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a63f072fef4fa15798af32aadcf1a775b"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#a63f072fef4fa15798af32aadcf1a775b">writeData:</a></td></tr>
  92. <tr class="memdesc:a63f072fef4fa15798af32aadcf1a775b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message to the server. <a href="interface_g_r_p_c_call2.html#a63f072fef4fa15798af32aadcf1a775b">More...</a><br /></td></tr>
  93. <tr class="separator:a63f072fef4fa15798af32aadcf1a775b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a1b713af434fed56790a18a37b9fc7368"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#a1b713af434fed56790a18a37b9fc7368">finish</a></td></tr>
  95. <tr class="memdesc:a1b713af434fed56790a18a37b9fc7368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish the RPC request and half-close the call. <a href="interface_g_r_p_c_call2.html#a1b713af434fed56790a18a37b9fc7368">More...</a><br /></td></tr>
  96. <tr class="separator:a1b713af434fed56790a18a37b9fc7368"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a90800373d194e3a1ad56dd2cd65d4cc7"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call2.html#a90800373d194e3a1ad56dd2cd65d4cc7">receiveNextMessages:</a></td></tr>
  98. <tr class="memdesc:a90800373d194e3a1ad56dd2cd65d4cc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell gRPC to receive the next N gRPC messages. <a href="interface_g_r_p_c_call2.html#a90800373d194e3a1ad56dd2cd65d4cc7">More...</a><br /></td></tr>
  99. <tr class="separator:a90800373d194e3a1ad56dd2cd65d4cc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table><table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  102. Class Methods</h2></td></tr>
  103. <tr class="memitem:a3b7330e0d74134162a3cf2f32bdc9b33"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call2.html#a3b7330e0d74134162a3cf2f32bdc9b33">NS_UNAVAILABLE</a></td></tr>
  104. <tr class="separator:a3b7330e0d74134162a3cf2f32bdc9b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ab90fbe693288211ace1016cc54664917"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call2.html#ab90fbe693288211ace1016cc54664917">registerGlobalInterceptor:</a></td></tr>
  106. <tr class="memdesc:ab90fbe693288211ace1016cc54664917"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a global interceptor's factory in the current process. <a href="interface_g_r_p_c_call2.html#ab90fbe693288211ace1016cc54664917">More...</a><br /></td></tr>
  107. <tr class="separator:ab90fbe693288211ace1016cc54664917"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a938d45561c3b20586412a61f2afdd996"><td class="memItemLeft" align="right" valign="top">(nullable id&lt; <a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html">GRPCInterceptorFactory</a> &gt;)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_call2.html#a938d45561c3b20586412a61f2afdd996">globalInterceptorFactory</a></td></tr>
  109. <tr class="memdesc:a938d45561c3b20586412a61f2afdd996"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the global interceptor's factory object. <a href="interface_g_r_p_c_call2.html#a938d45561c3b20586412a61f2afdd996">More...</a><br /></td></tr>
  110. <tr class="separator:a938d45561c3b20586412a61f2afdd996"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  113. Properties</h2></td></tr>
  114. <tr class="memitem:aa5eb53c957d82686d1f8f97c4469362f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call2.html#aa5eb53c957d82686d1f8f97c4469362f">callOptions</a></td></tr>
  115. <tr class="memdesc:aa5eb53c957d82686d1f8f97c4469362f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a copy of the original call options. <a href="interface_g_r_p_c_call2.html#aa5eb53c957d82686d1f8f97c4469362f">More...</a><br /></td></tr>
  116. <tr class="separator:aa5eb53c957d82686d1f8f97c4469362f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a7dd38889c137bbdf0b68c3d992a38357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call2.html#a7dd38889c137bbdf0b68c3d992a38357">requestOptions</a></td></tr>
  118. <tr class="memdesc:a7dd38889c137bbdf0b68c3d992a38357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a copy of the original request options. <a href="interface_g_r_p_c_call2.html#a7dd38889c137bbdf0b68c3d992a38357">More...</a><br /></td></tr>
  119. <tr class="separator:a7dd38889c137bbdf0b68c3d992a38357"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <div class="textblock"><p>A <a class="el" href="interface_g_r_p_c_call2.html" title="A GRPCCall2 object represents an RPC call.">GRPCCall2</a> object represents an RPC call. </p>
  123. </div><h2 class="groupheader">Method Documentation</h2>
  124. <a id="a7336ef3fd484b2425816e118850ae138"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a7336ef3fd484b2425816e118850ae138">&#9670;&nbsp;</a></span>cancel</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">- (void) cancel </td>
  131. <td></td>
  132. <td class="paramname"></td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>Cancel the request of this call at best effort. </p>
  138. <p>It attempts to notify the server that the RPC should be cancelled, and issue didCloseWithTrailingMetadata:error: callback with error code CANCELED if no other error code has already been issued. </p>
  139. </div>
  140. </div>
  141. <a id="a1b713af434fed56790a18a37b9fc7368"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#a1b713af434fed56790a18a37b9fc7368">&#9670;&nbsp;</a></span>finish</h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">- (void) finish </td>
  148. <td></td>
  149. <td class="paramname"></td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>Finish the RPC request and half-close the call. </p>
  155. <p>The server may still send messages and/or trailers to the client. The method must only be called once and after start is called. </p>
  156. </div>
  157. </div>
  158. <a id="a938d45561c3b20586412a61f2afdd996"></a>
  159. <h2 class="memtitle"><span class="permalink"><a href="#a938d45561c3b20586412a61f2afdd996">&#9670;&nbsp;</a></span>globalInterceptorFactory</h2>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">+ (nullable id&lt;<a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html">GRPCInterceptorFactory</a>&gt;) globalInterceptorFactory </td>
  165. <td></td>
  166. <td class="paramname"></td>
  167. <td></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Get the global interceptor's factory object. </p>
  172. <p>Provided by category <a class="el" href="category_g_r_p_c_call2_07_interceptor_08.html#a938d45561c3b20586412a61f2afdd996">GRPCCall2(Interceptor)</a>.</p>
  173. </div>
  174. </div>
  175. <a id="ad0adb3624b264d9ce2869faec5a7f193"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#ad0adb3624b264d9ce2869faec5a7f193">&#9670;&nbsp;</a></span>initWithRequestOptions:responseHandler:</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname">- (instancetype) initWithRequestOptions: </td>
  182. <td></td>
  183. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *)&#160;</td>
  184. <td class="paramname"><em>requestOptions</em></td>
  185. </tr>
  186. <tr>
  187. <td class="paramkey">responseHandler:</td>
  188. <td></td>
  189. <td class="paramtype">(id&lt; <a class="el" href="protocol_g_r_p_c_response_handler-p.html">GRPCResponseHandler</a> &gt;)&#160;</td>
  190. <td class="paramname"><em>responseHandler</em>&#160;</td>
  191. </tr>
  192. <tr>
  193. <td></td>
  194. <td></td>
  195. <td></td><td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Convenience initializer for a call that uses default call options (see GRPCCallOptions.m for the default options). </p>
  200. </div>
  201. </div>
  202. <a id="a280f18c407c3f3292980fadbd1abfd8e"></a>
  203. <h2 class="memtitle"><span class="permalink"><a href="#a280f18c407c3f3292980fadbd1abfd8e">&#9670;&nbsp;</a></span>initWithRequestOptions:responseHandler:callOptions:</h2>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">- (instancetype) initWithRequestOptions: </td>
  209. <td></td>
  210. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *)&#160;</td>
  211. <td class="paramname"><em>requestOptions</em></td>
  212. </tr>
  213. <tr>
  214. <td class="paramkey">responseHandler:</td>
  215. <td></td>
  216. <td class="paramtype">(id&lt; <a class="el" href="protocol_g_r_p_c_response_handler-p.html">GRPCResponseHandler</a> &gt;)&#160;</td>
  217. <td class="paramname"><em>responseHandler</em></td>
  218. </tr>
  219. <tr>
  220. <td class="paramkey">callOptions:</td>
  221. <td></td>
  222. <td class="paramtype">(nullable <a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)&#160;</td>
  223. <td class="paramname"><em>NS_DESIGNATED_INITIALIZER</em>&#160;</td>
  224. </tr>
  225. <tr>
  226. <td></td>
  227. <td></td>
  228. <td></td><td></td>
  229. </tr>
  230. </table>
  231. </div><div class="memdoc">
  232. <p>Designated initializer for a call. </p>
  233. <dl class="params"><dt>Parameters</dt><dd>
  234. <table class="params">
  235. <tr><td class="paramname">requestOptions</td><td>Protobuf generated parameters for the call. </td></tr>
  236. <tr><td class="paramname">responseHandler</td><td>The object to which responses should be issued. </td></tr>
  237. <tr><td class="paramname">callOptions</td><td>Options for the call. </td></tr>
  238. </table>
  239. </dd>
  240. </dl>
  241. </div>
  242. </div>
  243. <a id="a3b7330e0d74134162a3cf2f32bdc9b33"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#a3b7330e0d74134162a3cf2f32bdc9b33">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[1/2]</span></h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">+ (instancetype) NS_UNAVAILABLE </td>
  250. <td></td>
  251. <td class="paramname"></td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. </div>
  257. </div>
  258. <a id="a3b7330e0d74134162a3cf2f32bdc9b33"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#a3b7330e0d74134162a3cf2f32bdc9b33">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[2/2]</span></h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">- (instancetype) NS_UNAVAILABLE </td>
  265. <td></td>
  266. <td class="paramname"></td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. </div>
  272. </div>
  273. <a id="a90800373d194e3a1ad56dd2cd65d4cc7"></a>
  274. <h2 class="memtitle"><span class="permalink"><a href="#a90800373d194e3a1ad56dd2cd65d4cc7">&#9670;&nbsp;</a></span>receiveNextMessages:</h2>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">- (void) receiveNextMessages: </td>
  280. <td></td>
  281. <td class="paramtype">(NSUInteger)&#160;</td>
  282. <td class="paramname"><em>numberOfMessages</em></td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Tell gRPC to receive the next N gRPC messages. </p>
  288. <p>This method should only be used when flow control is enabled. When flow control is not enabled, this method is a no-op. </p>
  289. </div>
  290. </div>
  291. <a id="ab90fbe693288211ace1016cc54664917"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#ab90fbe693288211ace1016cc54664917">&#9670;&nbsp;</a></span>registerGlobalInterceptor:</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">+ (void) registerGlobalInterceptor: </td>
  298. <td></td>
  299. <td class="paramtype">(nonnull id&lt; <a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html">GRPCInterceptorFactory</a> &gt;)&#160;</td>
  300. <td class="paramname"><em>interceptorFactory</em></td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Register a global interceptor's factory in the current process. </p>
  306. <p>Only one interceptor can be registered in a process. If another one attempts to be registered, an exception will be raised.</p>
  307. <dl class="params"><dt>Parameters</dt><dd>
  308. <table class="params">
  309. <tr><td class="paramdir">[in]</td><td class="paramname">interceptorFactory</td><td>The factory object that generates the global interceptor for each call. </td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <p>Provided by category <a class="el" href="category_g_r_p_c_call2_07_interceptor_08.html#ab90fbe693288211ace1016cc54664917">GRPCCall2(Interceptor)</a>.</p>
  314. </div>
  315. </div>
  316. <a id="af31e80526cf25bfc569d620f8a5ad2dd"></a>
  317. <h2 class="memtitle"><span class="permalink"><a href="#af31e80526cf25bfc569d620f8a5ad2dd">&#9670;&nbsp;</a></span>start</h2>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">- (void) start </td>
  323. <td></td>
  324. <td class="paramname"></td>
  325. <td></td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>Starts the call. </p>
  330. <p>This function must only be called once for each instance. </p>
  331. </div>
  332. </div>
  333. <a id="a63f072fef4fa15798af32aadcf1a775b"></a>
  334. <h2 class="memtitle"><span class="permalink"><a href="#a63f072fef4fa15798af32aadcf1a775b">&#9670;&nbsp;</a></span>writeData:</h2>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">- (void) writeData: </td>
  340. <td></td>
  341. <td class="paramtype">(id)&#160;</td>
  342. <td class="paramname"><em>data</em></td>
  343. <td></td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <p>Send a message to the server. </p>
  348. <p>The data is subject to marshaller serialization and compression (marshaller is work in progress). </p>
  349. </div>
  350. </div>
  351. <h2 class="groupheader">Property Documentation</h2>
  352. <a id="aa5eb53c957d82686d1f8f97c4469362f"></a>
  353. <h2 class="memtitle"><span class="permalink"><a href="#aa5eb53c957d82686d1f8f97c4469362f">&#9670;&nbsp;</a></span>callOptions</h2>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="mlabels">
  357. <tr>
  358. <td class="mlabels-left">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname">- (<a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a>*) callOptions</td>
  362. </tr>
  363. </table>
  364. </td>
  365. <td class="mlabels-right">
  366. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <p>Get a copy of the original call options. </p>
  371. </div>
  372. </div>
  373. <a id="a7dd38889c137bbdf0b68c3d992a38357"></a>
  374. <h2 class="memtitle"><span class="permalink"><a href="#a7dd38889c137bbdf0b68c3d992a38357">&#9670;&nbsp;</a></span>requestOptions</h2>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="mlabels">
  378. <tr>
  379. <td class="mlabels-left">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">- (<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a>*) requestOptions</td>
  383. </tr>
  384. </table>
  385. </td>
  386. <td class="mlabels-right">
  387. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
  388. </tr>
  389. </table>
  390. </div><div class="memdoc">
  391. <p>Get a copy of the original request options. </p>
  392. </div>
  393. </div>
  394. <hr/>The documentation for this class was generated from the following file:<ul>
  395. <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_call_8h_source.html">GRPCCall.h</a></li>
  396. </ul>
  397. </div><!-- contents -->
  398. <!-- start footer part -->
  399. <hr class="footer"/><address class="footer"><small>
  400. Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  401. <img class="footer" src="doxygen.png" alt="doxygen"/>
  402. </a> 1.8.17
  403. </small></address>
  404. </body>
  405. </html>