interface_g_r_p_c_interceptor.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  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: GRPCInterceptor 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> </div>
  66. <div class="headertitle">
  67. <div class="title">GRPCInterceptor Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Base class for a gRPC interceptor.
  71. <a href="interface_g_r_p_c_interceptor.html#details">More...</a></p>
  72. <p><code>#import &lt;<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Instance Methods</h2></td></tr>
  76. <tr class="memitem:ae5df94d26ea028ec2210deb12f08c416"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#ae5df94d26ea028ec2210deb12f08c416">NS_UNAVAILABLE</a></td></tr>
  77. <tr class="separator:ae5df94d26ea028ec2210deb12f08c416"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a29c874944bed7d25a374e5305649aacc"><td class="memItemLeft" align="right" valign="top">(nullable instancetype)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a29c874944bed7d25a374e5305649aacc">initWithInterceptorManager:dispatchQueue:</a></td></tr>
  79. <tr class="memdesc:a29c874944bed7d25a374e5305649aacc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the interceptor with the next interceptor in the chain, and provide the dispatch queue that this interceptor's methods are dispatched onto. <a href="interface_g_r_p_c_interceptor.html#a29c874944bed7d25a374e5305649aacc">More...</a><br /></td></tr>
  80. <tr class="separator:a29c874944bed7d25a374e5305649aacc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:acede282262511aab39a7dc3b57526aac"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#acede282262511aab39a7dc3b57526aac">startWithRequestOptions:callOptions:</a></td></tr>
  82. <tr class="memdesc:acede282262511aab39a7dc3b57526aac"><td class="mdescLeft">&#160;</td><td class="mdescRight">To start the call. <a href="interface_g_r_p_c_interceptor.html#acede282262511aab39a7dc3b57526aac">More...</a><br /></td></tr>
  83. <tr class="separator:acede282262511aab39a7dc3b57526aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a6ee64864731acebc4fa4b3ca47a43f36"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a6ee64864731acebc4fa4b3ca47a43f36">writeData:</a></td></tr>
  85. <tr class="memdesc:a6ee64864731acebc4fa4b3ca47a43f36"><td class="mdescLeft">&#160;</td><td class="mdescRight">To write data to the call. <a href="interface_g_r_p_c_interceptor.html#a6ee64864731acebc4fa4b3ca47a43f36">More...</a><br /></td></tr>
  86. <tr class="separator:a6ee64864731acebc4fa4b3ca47a43f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a53a77a72ebaf711d17e59cb243169032"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a53a77a72ebaf711d17e59cb243169032">finish</a></td></tr>
  88. <tr class="memdesc:a53a77a72ebaf711d17e59cb243169032"><td class="mdescLeft">&#160;</td><td class="mdescRight">To finish the stream of requests. <a href="interface_g_r_p_c_interceptor.html#a53a77a72ebaf711d17e59cb243169032">More...</a><br /></td></tr>
  89. <tr class="separator:a53a77a72ebaf711d17e59cb243169032"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:aaab821f901be3d354d9fce8f98a12979"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#aaab821f901be3d354d9fce8f98a12979">cancel</a></td></tr>
  91. <tr class="memdesc:aaab821f901be3d354d9fce8f98a12979"><td class="mdescLeft">&#160;</td><td class="mdescRight">To cancel the call. <a href="interface_g_r_p_c_interceptor.html#aaab821f901be3d354d9fce8f98a12979">More...</a><br /></td></tr>
  92. <tr class="separator:aaab821f901be3d354d9fce8f98a12979"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a1e93189dcb502c1f85856f712a384877"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a1e93189dcb502c1f85856f712a384877">receiveNextMessages:</a></td></tr>
  94. <tr class="memdesc:a1e93189dcb502c1f85856f712a384877"><td class="mdescLeft">&#160;</td><td class="mdescRight">To indicate the call that the previous interceptor is ready to receive more messages. <a href="interface_g_r_p_c_interceptor.html#a1e93189dcb502c1f85856f712a384877">More...</a><br /></td></tr>
  95. <tr class="separator:a1e93189dcb502c1f85856f712a384877"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a0a50fe0dc7ce33c82814c4949b8f282a"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a0a50fe0dc7ce33c82814c4949b8f282a">didReceiveInitialMetadata:</a></td></tr>
  97. <tr class="memdesc:a0a50fe0dc7ce33c82814c4949b8f282a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when initial metadata is received from the server. <a href="interface_g_r_p_c_interceptor.html#a0a50fe0dc7ce33c82814c4949b8f282a">More...</a><br /></td></tr>
  98. <tr class="separator:a0a50fe0dc7ce33c82814c4949b8f282a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ae1a71998631c23254d3667b6de40b487"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#ae1a71998631c23254d3667b6de40b487">didReceiveData:</a></td></tr>
  100. <tr class="memdesc:ae1a71998631c23254d3667b6de40b487"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when gRPC message is received from the server. <a href="interface_g_r_p_c_interceptor.html#ae1a71998631c23254d3667b6de40b487">More...</a><br /></td></tr>
  101. <tr class="separator:ae1a71998631c23254d3667b6de40b487"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a3788cf6d26ec1df66e975bd571280090"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a3788cf6d26ec1df66e975bd571280090">didCloseWithTrailingMetadata:error:</a></td></tr>
  103. <tr class="memdesc:a3788cf6d26ec1df66e975bd571280090"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when a call finished. <a href="interface_g_r_p_c_interceptor.html#a3788cf6d26ec1df66e975bd571280090">More...</a><br /></td></tr>
  104. <tr class="separator:a3788cf6d26ec1df66e975bd571280090"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a4a9d9fbfe49dbe6305ced6cc516da038"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_interceptor.html#a4a9d9fbfe49dbe6305ced6cc516da038">didWriteData</a></td></tr>
  106. <tr class="memdesc:a4a9d9fbfe49dbe6305ced6cc516da038"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when flow control is enabled for the call and a message written with GRPCCall2::writeData is passed to gRPC core with SEND_MESSAGE operation. <a href="interface_g_r_p_c_interceptor.html#a4a9d9fbfe49dbe6305ced6cc516da038">More...</a><br /></td></tr>
  107. <tr class="separator:a4a9d9fbfe49dbe6305ced6cc516da038"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="inherit_header pub_methods_protocol_g_r_p_c_response_handler-p"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_protocol_g_r_p_c_response_handler-p')"><img src="closed.png" alt="-"/>&#160;Instance Methods inherited from <a class="el" href="protocol_g_r_p_c_response_handler-p.html">&lt;GRPCResponseHandler&gt;</a></td></tr>
  109. <tr class="memitem:a1cc519d6bf578da70a507197c99dc312 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_response_handler-p.html#a1cc519d6bf578da70a507197c99dc312">didReceiveRawMessage:</a></td></tr>
  110. <tr class="memdesc:a1cc519d6bf578da70a507197c99dc312 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when a message is received from the server. <a href="protocol_g_r_p_c_response_handler-p.html#a1cc519d6bf578da70a507197c99dc312">More...</a><br /></td></tr>
  111. <tr class="separator:a1cc519d6bf578da70a507197c99dc312 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table><table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  114. Class Methods</h2></td></tr>
  115. <tr class="memitem:ae5df94d26ea028ec2210deb12f08c416"><td class="memItemLeft" align="right" valign="top">(instancetype)&#160;</td><td class="memItemRight" valign="bottom">+ <a class="el" href="interface_g_r_p_c_interceptor.html#ae5df94d26ea028ec2210deb12f08c416">NS_UNAVAILABLE</a></td></tr>
  116. <tr class="separator:ae5df94d26ea028ec2210deb12f08c416"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table><table class="memberdecls">
  118. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  119. Additional Inherited Members</h2></td></tr>
  120. <tr class="inherit_header properties_protocol_g_r_p_c_dispatchable-p"><td colspan="2" onclick="javascript:toggleInherit('properties_protocol_g_r_p_c_dispatchable-p')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="protocol_g_r_p_c_dispatchable-p.html">&lt;GRPCDispatchable&gt;</a></td></tr>
  121. <tr class="memitem:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="memItemLeft" align="right" valign="top">dispatch_queue_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="protocol_g_r_p_c_dispatchable-p.html#ab896f3635c26fb9185a79c0aa26e89c0">dispatchQueue</a></td></tr>
  122. <tr class="memdesc:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">The dispatch queue where the object's methods should be run on. <a href="protocol_g_r_p_c_dispatchable-p.html#ab896f3635c26fb9185a79c0aa26e89c0">More...</a><br /></td></tr>
  123. <tr class="separator:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table>
  125. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  126. <div class="textblock"><p>Base class for a gRPC interceptor. </p>
  127. <p>The implementation of the base class provides default behavior of an interceptor, which is simply forward a request/callback to the next/previous interceptor in the chain. The base class implementation uses the same dispatch queue for both requests and callbacks.</p>
  128. <p>An interceptor implementation should inherit from this base class and initialize the base class with [super initWithInterceptorManager:dispatchQueue:] for the default implementation to function properly. </p>
  129. </div><h2 class="groupheader">Method Documentation</h2>
  130. <a id="aaab821f901be3d354d9fce8f98a12979"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#aaab821f901be3d354d9fce8f98a12979">&#9670;&nbsp;</a></span>cancel</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">- (void) cancel </td>
  137. <td></td>
  138. <td class="paramname"></td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>To cancel the call. </p>
  144. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#a89a419fec845010f6f90a3e20aa0debe">&lt;GRPCInterceptorInterface&gt;</a>.</p>
  145. </div>
  146. </div>
  147. <a id="a3788cf6d26ec1df66e975bd571280090"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a3788cf6d26ec1df66e975bd571280090">&#9670;&nbsp;</a></span>didCloseWithTrailingMetadata:error:</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">- (void) didCloseWithTrailingMetadata: </td>
  154. <td></td>
  155. <td class="paramtype">(nullable NSDictionary *)&#160;</td>
  156. <td class="paramname"><em>trailingMetadata</em></td>
  157. </tr>
  158. <tr>
  159. <td class="paramkey">error:</td>
  160. <td></td>
  161. <td class="paramtype">(nullable NSError *)&#160;</td>
  162. <td class="paramname"><em>error</em>&#160;</td>
  163. </tr>
  164. <tr>
  165. <td></td>
  166. <td></td>
  167. <td></td><td></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Issued when a call finished. </p>
  172. <p>If the call finished successfully, <code>error</code> is nil and <code>trailingMetadata</code> consists any trailing metadata received from the server. Otherwise, <code>error</code> is non-nil and contains the corresponding error information, including gRPC error codes and error descriptions. </p>
  173. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_response_handler-p.html#af69153885066acb9c4431d93dc320049">&lt;GRPCResponseHandler&gt;</a>.</p>
  174. </div>
  175. </div>
  176. <a id="ae1a71998631c23254d3667b6de40b487"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#ae1a71998631c23254d3667b6de40b487">&#9670;&nbsp;</a></span>didReceiveData:</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname">- (void) didReceiveData: </td>
  183. <td></td>
  184. <td class="paramtype">(id)&#160;</td>
  185. <td class="paramname"><em>data</em></td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Issued when gRPC message is received from the server. </p>
  191. <p>The data is always decompressed with gRPC or HTTP compression algorithm specified in the response header. <code>data</code> could be any type as transport layer and interceptors may modify the type of the data (e.g. a Protobuf interceptor may consume NSData typed data and issue GPBMessage typed data to user). Users should interpret <code>data</code> according to the configuration of their calls. Interceptor authors should not assume the type of <code>data</code> unless an agreement is made on how it should be used in a particular call setting. </p>
  192. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_response_handler-p.html#a384dd702a37a2fa7db82b8330cfcddcf">&lt;GRPCResponseHandler&gt;</a>.</p>
  193. </div>
  194. </div>
  195. <a id="a0a50fe0dc7ce33c82814c4949b8f282a"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a0a50fe0dc7ce33c82814c4949b8f282a">&#9670;&nbsp;</a></span>didReceiveInitialMetadata:</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">- (void) didReceiveInitialMetadata: </td>
  202. <td></td>
  203. <td class="paramtype">(nullable NSDictionary *)&#160;</td>
  204. <td class="paramname"><em>initialMetadata</em></td>
  205. <td></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Issued when initial metadata is received from the server. </p>
  210. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_response_handler-p.html#adc82f4ed3ffc8f7c0e91beed9538dbd6">&lt;GRPCResponseHandler&gt;</a>.</p>
  211. </div>
  212. </div>
  213. <a id="a4a9d9fbfe49dbe6305ced6cc516da038"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#a4a9d9fbfe49dbe6305ced6cc516da038">&#9670;&nbsp;</a></span>didWriteData</h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">- (void) didWriteData </td>
  220. <td></td>
  221. <td class="paramname"></td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Issued when flow control is enabled for the call and a message written with GRPCCall2::writeData is passed to gRPC core with SEND_MESSAGE operation. </p>
  227. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_response_handler-p.html#a5c5aa4f2f8623e00344ca5e6a3180300">&lt;GRPCResponseHandler&gt;</a>.</p>
  228. </div>
  229. </div>
  230. <a id="a53a77a72ebaf711d17e59cb243169032"></a>
  231. <h2 class="memtitle"><span class="permalink"><a href="#a53a77a72ebaf711d17e59cb243169032">&#9670;&nbsp;</a></span>finish</h2>
  232. <div class="memitem">
  233. <div class="memproto">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">- (void) finish </td>
  237. <td></td>
  238. <td class="paramname"></td>
  239. <td></td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. <p>To finish the stream of requests. </p>
  244. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#af01872822c9e4adb7c08a51833cde1b7">&lt;GRPCInterceptorInterface&gt;</a>.</p>
  245. </div>
  246. </div>
  247. <a id="a29c874944bed7d25a374e5305649aacc"></a>
  248. <h2 class="memtitle"><span class="permalink"><a href="#a29c874944bed7d25a374e5305649aacc">&#9670;&nbsp;</a></span>initWithInterceptorManager:dispatchQueue:</h2>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">- (nullable instancetype) initWithInterceptorManager: </td>
  254. <td></td>
  255. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_interceptor_manager.html">GRPCInterceptorManager</a> *)&#160;</td>
  256. <td class="paramname"><em>interceptorManager</em></td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey">dispatchQueue:</td>
  260. <td></td>
  261. <td class="paramtype">(dispatch_queue_t)&#160;</td>
  262. <td class="paramname"><em>dispatchQueue</em>&#160;</td>
  263. </tr>
  264. <tr>
  265. <td></td>
  266. <td></td>
  267. <td></td><td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Initialize the interceptor with the next interceptor in the chain, and provide the dispatch queue that this interceptor's methods are dispatched onto. </p>
  272. </div>
  273. </div>
  274. <a id="ae5df94d26ea028ec2210deb12f08c416"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#ae5df94d26ea028ec2210deb12f08c416">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[1/2]</span></h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">+ (instancetype) NS_UNAVAILABLE </td>
  281. <td></td>
  282. <td class="paramname"></td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. </div>
  288. </div>
  289. <a id="ae5df94d26ea028ec2210deb12f08c416"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#ae5df94d26ea028ec2210deb12f08c416">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[2/2]</span></h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <table class="memname">
  294. <tr>
  295. <td class="memname">- (instancetype) NS_UNAVAILABLE </td>
  296. <td></td>
  297. <td class="paramname"></td>
  298. <td></td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. </div>
  303. </div>
  304. <a id="a1e93189dcb502c1f85856f712a384877"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a1e93189dcb502c1f85856f712a384877">&#9670;&nbsp;</a></span>receiveNextMessages:</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">- (void) receiveNextMessages: </td>
  311. <td></td>
  312. <td class="paramtype">(NSUInteger)&#160;</td>
  313. <td class="paramname"><em>numberOfMessages</em></td>
  314. <td></td>
  315. </tr>
  316. </table>
  317. </div><div class="memdoc">
  318. <p>To indicate the call that the previous interceptor is ready to receive more messages. </p>
  319. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#add7e9df3d4d740fb065ef372ad56046a">&lt;GRPCInterceptorInterface&gt;</a>.</p>
  320. </div>
  321. </div>
  322. <a id="acede282262511aab39a7dc3b57526aac"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#acede282262511aab39a7dc3b57526aac">&#9670;&nbsp;</a></span>startWithRequestOptions:callOptions:</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">- (void) startWithRequestOptions: </td>
  329. <td></td>
  330. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *)&#160;</td>
  331. <td class="paramname"><em>requestOptions</em></td>
  332. </tr>
  333. <tr>
  334. <td class="paramkey">callOptions:</td>
  335. <td></td>
  336. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)&#160;</td>
  337. <td class="paramname"><em>callOptions</em>&#160;</td>
  338. </tr>
  339. <tr>
  340. <td></td>
  341. <td></td>
  342. <td></td><td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>To start the call. </p>
  347. <p>This method will only be called once for each instance. </p>
  348. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#aa7b0ae45db128e5862e2e23f7431185c">&lt;GRPCInterceptorInterface&gt;</a>.</p>
  349. </div>
  350. </div>
  351. <a id="a6ee64864731acebc4fa4b3ca47a43f36"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#a6ee64864731acebc4fa4b3ca47a43f36">&#9670;&nbsp;</a></span>writeData:</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">- (void) writeData: </td>
  358. <td></td>
  359. <td class="paramtype">(id)&#160;</td>
  360. <td class="paramname"><em>data</em></td>
  361. <td></td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p>To write data to the call. </p>
  366. <p>Reimplemented from <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#afce563b3047786b6525bfe22020fc287">&lt;GRPCInterceptorInterface&gt;</a>.</p>
  367. </div>
  368. </div>
  369. <hr/>The documentation for this class was generated from the following file:<ul>
  370. <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a></li>
  371. </ul>
  372. </div><!-- contents -->
  373. <!-- start footer part -->
  374. <hr class="footer"/><address class="footer"><small>
  375. Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  376. <img class="footer" src="doxygen.png" alt="doxygen"/>
  377. </a> 1.8.17
  378. </small></address>
  379. </body>
  380. </html>