protocol_g_r_p_c_interceptor_interface-p.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  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: &lt;GRPCInterceptorInterface&gt; Protocol 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> </div>
  65. <div class="headertitle">
  66. <div class="title">&lt;GRPCInterceptorInterface&gt; Protocol Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>The <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html" title="The GRPCInterceptorInterface defines the request events that can occur to an interceptor.">GRPCInterceptorInterface</a> defines the request events that can occur to an interceptor.
  70. <a href="protocol_g_r_p_c_interceptor_interface-p.html#details">More...</a></p>
  71. <p><code>#import &lt;<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Instance Methods</h2></td></tr>
  75. <tr class="memitem:aa7b0ae45db128e5862e2e23f7431185c"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#aa7b0ae45db128e5862e2e23f7431185c">startWithRequestOptions:callOptions:</a></td></tr>
  76. <tr class="memdesc:aa7b0ae45db128e5862e2e23f7431185c"><td class="mdescLeft">&#160;</td><td class="mdescRight">To start the call. <a href="protocol_g_r_p_c_interceptor_interface-p.html#aa7b0ae45db128e5862e2e23f7431185c">More...</a><br /></td></tr>
  77. <tr class="separator:aa7b0ae45db128e5862e2e23f7431185c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:afce563b3047786b6525bfe22020fc287"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#afce563b3047786b6525bfe22020fc287">writeData:</a></td></tr>
  79. <tr class="memdesc:afce563b3047786b6525bfe22020fc287"><td class="mdescLeft">&#160;</td><td class="mdescRight">To write data to the call. <a href="protocol_g_r_p_c_interceptor_interface-p.html#afce563b3047786b6525bfe22020fc287">More...</a><br /></td></tr>
  80. <tr class="separator:afce563b3047786b6525bfe22020fc287"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:af01872822c9e4adb7c08a51833cde1b7"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#af01872822c9e4adb7c08a51833cde1b7">finish</a></td></tr>
  82. <tr class="memdesc:af01872822c9e4adb7c08a51833cde1b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">To finish the stream of requests. <a href="protocol_g_r_p_c_interceptor_interface-p.html#af01872822c9e4adb7c08a51833cde1b7">More...</a><br /></td></tr>
  83. <tr class="separator:af01872822c9e4adb7c08a51833cde1b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a89a419fec845010f6f90a3e20aa0debe"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#a89a419fec845010f6f90a3e20aa0debe">cancel</a></td></tr>
  85. <tr class="memdesc:a89a419fec845010f6f90a3e20aa0debe"><td class="mdescLeft">&#160;</td><td class="mdescRight">To cancel the call. <a href="protocol_g_r_p_c_interceptor_interface-p.html#a89a419fec845010f6f90a3e20aa0debe">More...</a><br /></td></tr>
  86. <tr class="separator:a89a419fec845010f6f90a3e20aa0debe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:add7e9df3d4d740fb065ef372ad56046a"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html#add7e9df3d4d740fb065ef372ad56046a">receiveNextMessages:</a></td></tr>
  88. <tr class="memdesc:add7e9df3d4d740fb065ef372ad56046a"><td class="mdescLeft">&#160;</td><td class="mdescRight">To indicate the call that the previous interceptor is ready to receive more messages. <a href="protocol_g_r_p_c_interceptor_interface-p.html#add7e9df3d4d740fb065ef372ad56046a">More...</a><br /></td></tr>
  89. <tr class="separator:add7e9df3d4d740fb065ef372ad56046a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table><table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  92. Additional Inherited Members</h2></td></tr>
  93. <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>
  94. <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>
  95. <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>
  96. <tr class="separator:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table>
  98. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  99. <div class="textblock"><p>The <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html" title="The GRPCInterceptorInterface defines the request events that can occur to an interceptor.">GRPCInterceptorInterface</a> defines the request events that can occur to an interceptor. </p>
  100. </div><h2 class="groupheader">Method Documentation</h2>
  101. <a id="a89a419fec845010f6f90a3e20aa0debe"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#a89a419fec845010f6f90a3e20aa0debe">&#9670;&nbsp;</a></span>cancel</h2>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">- (void) cancel </td>
  108. <td></td>
  109. <td class="paramname"></td>
  110. <td></td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. <p>To cancel the call. </p>
  115. <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#aaab821f901be3d354d9fce8f98a12979">GRPCInterceptor</a>.</p>
  116. </div>
  117. </div>
  118. <a id="af01872822c9e4adb7c08a51833cde1b7"></a>
  119. <h2 class="memtitle"><span class="permalink"><a href="#af01872822c9e4adb7c08a51833cde1b7">&#9670;&nbsp;</a></span>finish</h2>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">- (void) finish </td>
  125. <td></td>
  126. <td class="paramname"></td>
  127. <td></td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>To finish the stream of requests. </p>
  132. <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a53a77a72ebaf711d17e59cb243169032">GRPCInterceptor</a>.</p>
  133. </div>
  134. </div>
  135. <a id="add7e9df3d4d740fb065ef372ad56046a"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#add7e9df3d4d740fb065ef372ad56046a">&#9670;&nbsp;</a></span>receiveNextMessages:</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">- (void) receiveNextMessages: </td>
  142. <td></td>
  143. <td class="paramtype">(NSUInteger)&#160;</td>
  144. <td class="paramname"><em>numberOfMessages</em></td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>To indicate the call that the previous interceptor is ready to receive more messages. </p>
  150. <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a1e93189dcb502c1f85856f712a384877">GRPCInterceptor</a>.</p>
  151. </div>
  152. </div>
  153. <a id="aa7b0ae45db128e5862e2e23f7431185c"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#aa7b0ae45db128e5862e2e23f7431185c">&#9670;&nbsp;</a></span>startWithRequestOptions:callOptions:</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">- (void) startWithRequestOptions: </td>
  160. <td></td>
  161. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *)&#160;</td>
  162. <td class="paramname"><em>requestOptions</em></td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey">callOptions:</td>
  166. <td></td>
  167. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)&#160;</td>
  168. <td class="paramname"><em>callOptions</em>&#160;</td>
  169. </tr>
  170. <tr>
  171. <td></td>
  172. <td></td>
  173. <td></td><td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>To start the call. </p>
  178. <p>This method will only be called once for each instance. </p>
  179. <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#acede282262511aab39a7dc3b57526aac">GRPCInterceptor</a>.</p>
  180. </div>
  181. </div>
  182. <a id="afce563b3047786b6525bfe22020fc287"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#afce563b3047786b6525bfe22020fc287">&#9670;&nbsp;</a></span>writeData:</h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">- (void) writeData: </td>
  189. <td></td>
  190. <td class="paramtype">(id)&#160;</td>
  191. <td class="paramname"><em>data</em></td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>To write data to the call. </p>
  197. <p>Reimplemented in <a class="el" href="interface_g_r_p_c_interceptor.html#a6ee64864731acebc4fa4b3ca47a43f36">GRPCInterceptor</a>.</p>
  198. </div>
  199. </div>
  200. <hr/>The documentation for this protocol was generated from the following file:<ul>
  201. <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a></li>
  202. </ul>
  203. </div><!-- contents -->
  204. <!-- start footer part -->
  205. <hr class="footer"/><address class="footer"><small>
  206. Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  207. <img class="footer" src="doxygen.png" alt="doxygen"/>
  208. </a> 1.8.17
  209. </small></address>
  210. </body>
  211. </html>