interface_g_r_p_c_interceptor_manager.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  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: GRPCInterceptorManager 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">GRPCInterceptorManager Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><a class="el" href="interface_g_r_p_c_interceptor_manager.html" title="GRPCInterceptorManager is a helper class to forward messages between the interceptors.">GRPCInterceptorManager</a> is a helper class to forward messages between the interceptors.
  71. <a href="interface_g_r_p_c_interceptor_manager.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:a6309ab3d41465c97af0912b50d4253bd"><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_manager.html#a6309ab3d41465c97af0912b50d4253bd">NS_UNAVAILABLE</a></td></tr>
  77. <tr class="separator:a6309ab3d41465c97af0912b50d4253bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a1d2e745a2724351831c5be3fe306abe3"><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_manager.html#a1d2e745a2724351831c5be3fe306abe3">initWithFactories:previousInterceptor:transportID:</a></td></tr>
  79. <tr class="separator:a1d2e745a2724351831c5be3fe306abe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a3bc4ea3ab1052dc4b8f95b2b13743fd5"><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_manager.html#a3bc4ea3ab1052dc4b8f95b2b13743fd5">shutDown</a></td></tr>
  81. <tr class="memdesc:a3bc4ea3ab1052dc4b8f95b2b13743fd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the manager that the interceptor has shut down and the manager should release references to other interceptors and stop forwarding requests/responses. <a href="interface_g_r_p_c_interceptor_manager.html#a3bc4ea3ab1052dc4b8f95b2b13743fd5">More...</a><br /></td></tr>
  82. <tr class="separator:a3bc4ea3ab1052dc4b8f95b2b13743fd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a3aeabcf86a2ca4f0c5c42fc5d34dc8e0"><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_manager.html#a3aeabcf86a2ca4f0c5c42fc5d34dc8e0">startNextInterceptorWithRequest:callOptions:</a></td></tr>
  84. <tr class="memdesc:a3aeabcf86a2ca4f0c5c42fc5d34dc8e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the next interceptor in the chain to start the call and pass arguments. <a href="interface_g_r_p_c_interceptor_manager.html#a3aeabcf86a2ca4f0c5c42fc5d34dc8e0">More...</a><br /></td></tr>
  85. <tr class="separator:a3aeabcf86a2ca4f0c5c42fc5d34dc8e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a995618b67c0546b289277d0b335b3855"><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_manager.html#a995618b67c0546b289277d0b335b3855">writeNextInterceptorWithData:</a></td></tr>
  87. <tr class="memdesc:a995618b67c0546b289277d0b335b3855"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass a message to be sent to the next interceptor in the chain. <a href="interface_g_r_p_c_interceptor_manager.html#a995618b67c0546b289277d0b335b3855">More...</a><br /></td></tr>
  88. <tr class="separator:a995618b67c0546b289277d0b335b3855"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:acb8d895d60cef4c1aa6a59d6fcb760f5"><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_manager.html#acb8d895d60cef4c1aa6a59d6fcb760f5">finishNextInterceptor</a></td></tr>
  90. <tr class="memdesc:acb8d895d60cef4c1aa6a59d6fcb760f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the next interceptor in the chain to finish the call. <a href="interface_g_r_p_c_interceptor_manager.html#acb8d895d60cef4c1aa6a59d6fcb760f5">More...</a><br /></td></tr>
  91. <tr class="separator:acb8d895d60cef4c1aa6a59d6fcb760f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:aa10392a6b50d19d2543e930187f8e7b8"><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_manager.html#aa10392a6b50d19d2543e930187f8e7b8">cancelNextInterceptor</a></td></tr>
  93. <tr class="memdesc:aa10392a6b50d19d2543e930187f8e7b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the next interceptor in the chain to cancel the call. <a href="interface_g_r_p_c_interceptor_manager.html#aa10392a6b50d19d2543e930187f8e7b8">More...</a><br /></td></tr>
  94. <tr class="separator:aa10392a6b50d19d2543e930187f8e7b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a9af11abeae29a37b44dc0301a9b62a51"><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_manager.html#a9af11abeae29a37b44dc0301a9b62a51">receiveNextInterceptorMessages:</a></td></tr>
  96. <tr class="memdesc:a9af11abeae29a37b44dc0301a9b62a51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify the next interceptor in the chain to receive more messages. <a href="interface_g_r_p_c_interceptor_manager.html#a9af11abeae29a37b44dc0301a9b62a51">More...</a><br /></td></tr>
  97. <tr class="separator:a9af11abeae29a37b44dc0301a9b62a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a9de16b46e72d6e914535797b1ad761e2"><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_manager.html#a9de16b46e72d6e914535797b1ad761e2">forwardPreviousInterceptorWithInitialMetadata:</a></td></tr>
  99. <tr class="memdesc:a9de16b46e72d6e914535797b1ad761e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward initial metadata to the previous interceptor in the chain. <a href="interface_g_r_p_c_interceptor_manager.html#a9de16b46e72d6e914535797b1ad761e2">More...</a><br /></td></tr>
  100. <tr class="separator:a9de16b46e72d6e914535797b1ad761e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a87fbbc924320723bd04cc0a7ac3aacbd"><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_manager.html#a87fbbc924320723bd04cc0a7ac3aacbd">forwardPreviousInterceptorWithData:</a></td></tr>
  102. <tr class="memdesc:a87fbbc924320723bd04cc0a7ac3aacbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward a received message to the previous interceptor in the chain. <a href="interface_g_r_p_c_interceptor_manager.html#a87fbbc924320723bd04cc0a7ac3aacbd">More...</a><br /></td></tr>
  103. <tr class="separator:a87fbbc924320723bd04cc0a7ac3aacbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a5b6611b4dd5817e8aa00ec21d6d9edb4"><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_manager.html#a5b6611b4dd5817e8aa00ec21d6d9edb4">forwardPreviousInterceptorCloseWithTrailingMetadata:error:</a></td></tr>
  105. <tr class="memdesc:a5b6611b4dd5817e8aa00ec21d6d9edb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward call close and trailing metadata to the previous interceptor in the chain. <a href="interface_g_r_p_c_interceptor_manager.html#a5b6611b4dd5817e8aa00ec21d6d9edb4">More...</a><br /></td></tr>
  106. <tr class="separator:a5b6611b4dd5817e8aa00ec21d6d9edb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a7c50f52ef0f359dba6247b7fe50a2999"><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_manager.html#a7c50f52ef0f359dba6247b7fe50a2999">forwardPreviousInterceptorDidWriteData</a></td></tr>
  108. <tr class="memdesc:a7c50f52ef0f359dba6247b7fe50a2999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forward write completion to the previous interceptor in the chain. <a href="interface_g_r_p_c_interceptor_manager.html#a7c50f52ef0f359dba6247b7fe50a2999">More...</a><br /></td></tr>
  109. <tr class="separator:a7c50f52ef0f359dba6247b7fe50a2999"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="inherit_header pub_methods_protocol_g_r_p_c_interceptor_interface-p"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_protocol_g_r_p_c_interceptor_interface-p')"><img src="closed.png" alt="-"/>&#160;Instance Methods inherited from <a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html">&lt;GRPCInterceptorInterface&gt;</a></td></tr>
  111. <tr class="memitem:aa7b0ae45db128e5862e2e23f7431185c inherit pub_methods_protocol_g_r_p_c_interceptor_interface-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_interceptor_interface-p.html#aa7b0ae45db128e5862e2e23f7431185c">startWithRequestOptions:callOptions:</a></td></tr>
  112. <tr class="memdesc:aa7b0ae45db128e5862e2e23f7431185c inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><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>
  113. <tr class="separator:aa7b0ae45db128e5862e2e23f7431185c inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:afce563b3047786b6525bfe22020fc287 inherit pub_methods_protocol_g_r_p_c_interceptor_interface-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_interceptor_interface-p.html#afce563b3047786b6525bfe22020fc287">writeData:</a></td></tr>
  115. <tr class="memdesc:afce563b3047786b6525bfe22020fc287 inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><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>
  116. <tr class="separator:afce563b3047786b6525bfe22020fc287 inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:af01872822c9e4adb7c08a51833cde1b7 inherit pub_methods_protocol_g_r_p_c_interceptor_interface-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_interceptor_interface-p.html#af01872822c9e4adb7c08a51833cde1b7">finish</a></td></tr>
  118. <tr class="memdesc:af01872822c9e4adb7c08a51833cde1b7 inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><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>
  119. <tr class="separator:af01872822c9e4adb7c08a51833cde1b7 inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a89a419fec845010f6f90a3e20aa0debe inherit pub_methods_protocol_g_r_p_c_interceptor_interface-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_interceptor_interface-p.html#a89a419fec845010f6f90a3e20aa0debe">cancel</a></td></tr>
  121. <tr class="memdesc:a89a419fec845010f6f90a3e20aa0debe inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><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>
  122. <tr class="separator:a89a419fec845010f6f90a3e20aa0debe inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:add7e9df3d4d740fb065ef372ad56046a inherit pub_methods_protocol_g_r_p_c_interceptor_interface-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_interceptor_interface-p.html#add7e9df3d4d740fb065ef372ad56046a">receiveNextMessages:</a></td></tr>
  124. <tr class="memdesc:add7e9df3d4d740fb065ef372ad56046a inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><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>
  125. <tr class="separator:add7e9df3d4d740fb065ef372ad56046a inherit pub_methods_protocol_g_r_p_c_interceptor_interface-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="memitem:adc82f4ed3ffc8f7c0e91beed9538dbd6 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#adc82f4ed3ffc8f7c0e91beed9538dbd6">didReceiveInitialMetadata:</a></td></tr>
  128. <tr class="memdesc:adc82f4ed3ffc8f7c0e91beed9538dbd6 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when initial metadata is received from the server. <a href="protocol_g_r_p_c_response_handler-p.html#adc82f4ed3ffc8f7c0e91beed9538dbd6">More...</a><br /></td></tr>
  129. <tr class="separator:adc82f4ed3ffc8f7c0e91beed9538dbd6 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <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>
  132. <tr class="separator:a1cc519d6bf578da70a507197c99dc312 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a384dd702a37a2fa7db82b8330cfcddcf 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#a384dd702a37a2fa7db82b8330cfcddcf">didReceiveData:</a></td></tr>
  134. <tr class="memdesc:a384dd702a37a2fa7db82b8330cfcddcf inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when gRPC message is received from the server. <a href="protocol_g_r_p_c_response_handler-p.html#a384dd702a37a2fa7db82b8330cfcddcf">More...</a><br /></td></tr>
  135. <tr class="separator:a384dd702a37a2fa7db82b8330cfcddcf inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:af69153885066acb9c4431d93dc320049 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#af69153885066acb9c4431d93dc320049">didCloseWithTrailingMetadata:error:</a></td></tr>
  137. <tr class="memdesc:af69153885066acb9c4431d93dc320049 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when a call finished. <a href="protocol_g_r_p_c_response_handler-p.html#af69153885066acb9c4431d93dc320049">More...</a><br /></td></tr>
  138. <tr class="separator:af69153885066acb9c4431d93dc320049 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a5c5aa4f2f8623e00344ca5e6a3180300 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#a5c5aa4f2f8623e00344ca5e6a3180300">didWriteData</a></td></tr>
  140. <tr class="memdesc:a5c5aa4f2f8623e00344ca5e6a3180300 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><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="protocol_g_r_p_c_response_handler-p.html#a5c5aa4f2f8623e00344ca5e6a3180300">More...</a><br /></td></tr>
  141. <tr class="separator:a5c5aa4f2f8623e00344ca5e6a3180300 inherit pub_methods_protocol_g_r_p_c_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  144. Class Methods</h2></td></tr>
  145. <tr class="memitem:a6309ab3d41465c97af0912b50d4253bd"><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_manager.html#a6309ab3d41465c97af0912b50d4253bd">NS_UNAVAILABLE</a></td></tr>
  146. <tr class="separator:a6309ab3d41465c97af0912b50d4253bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. </table><table class="memberdecls">
  148. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  149. Additional Inherited Members</h2></td></tr>
  150. <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>
  151. <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>
  152. <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>
  153. <tr class="separator:ab896f3635c26fb9185a79c0aa26e89c0 inherit properties_protocol_g_r_p_c_dispatchable-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table>
  155. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  156. <div class="textblock"><p><a class="el" href="interface_g_r_p_c_interceptor_manager.html" title="GRPCInterceptorManager is a helper class to forward messages between the interceptors.">GRPCInterceptorManager</a> is a helper class to forward messages between the interceptors. </p>
  157. <p>The interceptor manager object retains reference to the next and previous interceptor object in the interceptor chain, and forward corresponding events to them.</p>
  158. <p>All methods except the initializer of the class can only be called on the manager's dispatch queue. Since the manager's dispatch queue targets corresponding interceptor's dispatch queue, it is also safe to call the manager's methods in the corresponding interceptor instance's methods that implement <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>.</p>
  159. <p>When an interceptor is shutting down, it must invoke -shutDown method of its corresponding manager so that references to other interceptors can be released and proper clean-up is made. </p>
  160. </div><h2 class="groupheader">Method Documentation</h2>
  161. <a id="aa10392a6b50d19d2543e930187f8e7b8"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#aa10392a6b50d19d2543e930187f8e7b8">&#9670;&nbsp;</a></span>cancelNextInterceptor</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">- (void) cancelNextInterceptor </td>
  168. <td></td>
  169. <td class="paramname"></td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. <p>Notify the next interceptor in the chain to cancel the call. </p>
  175. </div>
  176. </div>
  177. <a id="acb8d895d60cef4c1aa6a59d6fcb760f5"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#acb8d895d60cef4c1aa6a59d6fcb760f5">&#9670;&nbsp;</a></span>finishNextInterceptor</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">- (void) finishNextInterceptor </td>
  184. <td></td>
  185. <td class="paramname"></td>
  186. <td></td>
  187. </tr>
  188. </table>
  189. </div><div class="memdoc">
  190. <p>Notify the next interceptor in the chain to finish the call. </p>
  191. </div>
  192. </div>
  193. <a id="a5b6611b4dd5817e8aa00ec21d6d9edb4"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#a5b6611b4dd5817e8aa00ec21d6d9edb4">&#9670;&nbsp;</a></span>forwardPreviousInterceptorCloseWithTrailingMetadata:error:</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">- (void) forwardPreviousInterceptorCloseWithTrailingMetadata: </td>
  200. <td></td>
  201. <td class="paramtype">(nullable NSDictionary *)&#160;</td>
  202. <td class="paramname"><em>trailingMetadata</em></td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey">error:</td>
  206. <td></td>
  207. <td class="paramtype">(nullable NSError *)&#160;</td>
  208. <td class="paramname"><em>error</em>&#160;</td>
  209. </tr>
  210. <tr>
  211. <td></td>
  212. <td></td>
  213. <td></td><td></td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Forward call close and trailing metadata to the previous interceptor in the chain. </p>
  218. </div>
  219. </div>
  220. <a id="a7c50f52ef0f359dba6247b7fe50a2999"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a7c50f52ef0f359dba6247b7fe50a2999">&#9670;&nbsp;</a></span>forwardPreviousInterceptorDidWriteData</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">- (void) forwardPreviousInterceptorDidWriteData </td>
  227. <td></td>
  228. <td class="paramname"></td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Forward write completion to the previous interceptor in the chain. </p>
  234. </div>
  235. </div>
  236. <a id="a87fbbc924320723bd04cc0a7ac3aacbd"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a87fbbc924320723bd04cc0a7ac3aacbd">&#9670;&nbsp;</a></span>forwardPreviousInterceptorWithData:</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">- (void) forwardPreviousInterceptorWithData: </td>
  243. <td></td>
  244. <td class="paramtype">(nullable id)&#160;</td>
  245. <td class="paramname"><em>data</em></td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Forward a received message to the previous interceptor in the chain. </p>
  251. </div>
  252. </div>
  253. <a id="a9de16b46e72d6e914535797b1ad761e2"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#a9de16b46e72d6e914535797b1ad761e2">&#9670;&nbsp;</a></span>forwardPreviousInterceptorWithInitialMetadata:</h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">- (void) forwardPreviousInterceptorWithInitialMetadata: </td>
  260. <td></td>
  261. <td class="paramtype">(nullable NSDictionary *)&#160;</td>
  262. <td class="paramname"><em>initialMetadata</em></td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Forward initial metadata to the previous interceptor in the chain. </p>
  268. </div>
  269. </div>
  270. <a id="a1d2e745a2724351831c5be3fe306abe3"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#a1d2e745a2724351831c5be3fe306abe3">&#9670;&nbsp;</a></span>initWithFactories:previousInterceptor:transportID:</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">- (nullable instancetype) initWithFactories: </td>
  277. <td></td>
  278. <td class="paramtype">(nullable NSArray&lt; id&lt; <a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html">GRPCInterceptorFactory</a> &gt;&gt; *)&#160;</td>
  279. <td class="paramname"><em>factories</em></td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey">previousInterceptor:</td>
  283. <td></td>
  284. <td class="paramtype">(nullable id&lt; <a class="el" href="protocol_g_r_p_c_response_handler-p.html">GRPCResponseHandler</a> &gt;)&#160;</td>
  285. <td class="paramname"><em>previousInterceptor</em></td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey">transportID:</td>
  289. <td></td>
  290. <td class="paramtype">(<a class="el" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a>)&#160;</td>
  291. <td class="paramname"><em>transportID</em>&#160;</td>
  292. </tr>
  293. <tr>
  294. <td></td>
  295. <td></td>
  296. <td></td><td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. </div>
  301. </div>
  302. <a id="a6309ab3d41465c97af0912b50d4253bd"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#a6309ab3d41465c97af0912b50d4253bd">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[1/2]</span></h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="memname">
  307. <tr>
  308. <td class="memname">+ (instancetype) NS_UNAVAILABLE </td>
  309. <td></td>
  310. <td class="paramname"></td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. </div>
  316. </div>
  317. <a id="a6309ab3d41465c97af0912b50d4253bd"></a>
  318. <h2 class="memtitle"><span class="permalink"><a href="#a6309ab3d41465c97af0912b50d4253bd">&#9670;&nbsp;</a></span>NS_UNAVAILABLE <span class="overload">[2/2]</span></h2>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">- (instancetype) NS_UNAVAILABLE </td>
  324. <td></td>
  325. <td class="paramname"></td>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. </div>
  331. </div>
  332. <a id="a9af11abeae29a37b44dc0301a9b62a51"></a>
  333. <h2 class="memtitle"><span class="permalink"><a href="#a9af11abeae29a37b44dc0301a9b62a51">&#9670;&nbsp;</a></span>receiveNextInterceptorMessages:</h2>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">- (void) receiveNextInterceptorMessages: </td>
  339. <td></td>
  340. <td class="paramtype">(NSUInteger)&#160;</td>
  341. <td class="paramname"><em>numberOfMessages</em></td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Notify the next interceptor in the chain to receive more messages. </p>
  347. </div>
  348. </div>
  349. <a id="a3bc4ea3ab1052dc4b8f95b2b13743fd5"></a>
  350. <h2 class="memtitle"><span class="permalink"><a href="#a3bc4ea3ab1052dc4b8f95b2b13743fd5">&#9670;&nbsp;</a></span>shutDown</h2>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">- (void) shutDown </td>
  356. <td></td>
  357. <td class="paramname"></td>
  358. <td></td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Notify the manager that the interceptor has shut down and the manager should release references to other interceptors and stop forwarding requests/responses. </p>
  363. </div>
  364. </div>
  365. <a id="a3aeabcf86a2ca4f0c5c42fc5d34dc8e0"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#a3aeabcf86a2ca4f0c5c42fc5d34dc8e0">&#9670;&nbsp;</a></span>startNextInterceptorWithRequest:callOptions:</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">- (void) startNextInterceptorWithRequest: </td>
  372. <td></td>
  373. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a> *)&#160;</td>
  374. <td class="paramname"><em>requestOptions</em></td>
  375. </tr>
  376. <tr>
  377. <td class="paramkey">callOptions:</td>
  378. <td></td>
  379. <td class="paramtype">(<a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)&#160;</td>
  380. <td class="paramname"><em>callOptions</em>&#160;</td>
  381. </tr>
  382. <tr>
  383. <td></td>
  384. <td></td>
  385. <td></td><td></td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <p>Notify the next interceptor in the chain to start the call and pass arguments. </p>
  390. </div>
  391. </div>
  392. <a id="a995618b67c0546b289277d0b335b3855"></a>
  393. <h2 class="memtitle"><span class="permalink"><a href="#a995618b67c0546b289277d0b335b3855">&#9670;&nbsp;</a></span>writeNextInterceptorWithData:</h2>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">- (void) writeNextInterceptorWithData: </td>
  399. <td></td>
  400. <td class="paramtype">(id)&#160;</td>
  401. <td class="paramname"><em>data</em></td>
  402. <td></td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. <p>Pass a message to be sent to the next interceptor in the chain. </p>
  407. </div>
  408. </div>
  409. <hr/>The documentation for this class was generated from the following file:<ul>
  410. <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_interceptor_8h_source.html">GRPCInterceptor.h</a></li>
  411. </ul>
  412. </div><!-- contents -->
  413. <!-- start footer part -->
  414. <hr class="footer"/><address class="footer"><small>
  415. Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  416. <img class="footer" src="doxygen.png" alt="doxygen"/>
  417. </a> 1.8.17
  418. </small></address>
  419. </body>
  420. </html>