interface_g_r_p_c_unary_response_handler.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  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.16"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Objective-C: GRPCUnaryResponseHandler 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.25.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.16 -->
  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="#properties">Properties</a> </div>
  66. <div class="headertitle">
  67. <div class="title">GRPCUnaryResponseHandler Class Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>A convenience class of objects that act as response handlers of calls.
  71. <a href="interface_g_r_p_c_unary_response_handler.html#details">More...</a></p>
  72. <p><code>#import &lt;<a class="el" href="_proto_r_p_c_8h_source.html">ProtoRPC.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:a3e3ff8fcf1d7ef43b322860df72aa930"><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_unary_response_handler.html#a3e3ff8fcf1d7ef43b322860df72aa930">initWithResponseHandler:responseDispatchQueue:</a></td></tr>
  77. <tr class="memdesc:a3e3ff8fcf1d7ef43b322860df72aa930"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a responsehandler object with a unary call handler. <a href="interface_g_r_p_c_unary_response_handler.html#a3e3ff8fcf1d7ef43b322860df72aa930">More...</a><br /></td></tr>
  78. <tr class="separator:a3e3ff8fcf1d7ef43b322860df72aa930"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="inherit_header pub_methods_protocol_g_r_p_c_proto_response_handler-p"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_protocol_g_r_p_c_proto_response_handler-p')"><img src="closed.png" alt="-"/>&#160;Instance Methods inherited from <a class="el" href="protocol_g_r_p_c_proto_response_handler-p.html">&lt;GRPCProtoResponseHandler&gt;</a></td></tr>
  80. <tr class="memitem:a97764fdcf7020efde126e692b530cf87 inherit pub_methods_protocol_g_r_p_c_proto_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_proto_response_handler-p.html#a97764fdcf7020efde126e692b530cf87">didReceiveInitialMetadata:</a></td></tr>
  81. <tr class="memdesc:a97764fdcf7020efde126e692b530cf87 inherit pub_methods_protocol_g_r_p_c_proto_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_proto_response_handler-p.html#a97764fdcf7020efde126e692b530cf87">More...</a><br /></td></tr>
  82. <tr class="separator:a97764fdcf7020efde126e692b530cf87 inherit pub_methods_protocol_g_r_p_c_proto_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a5bff36689f3a8e577b102d4b91995c51 inherit pub_methods_protocol_g_r_p_c_proto_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_proto_response_handler-p.html#a5bff36689f3a8e577b102d4b91995c51">didReceiveProtoMessage:</a></td></tr>
  84. <tr class="memdesc:a5bff36689f3a8e577b102d4b91995c51 inherit pub_methods_protocol_g_r_p_c_proto_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_proto_response_handler-p.html#a5bff36689f3a8e577b102d4b91995c51">More...</a><br /></td></tr>
  85. <tr class="separator:a5bff36689f3a8e577b102d4b91995c51 inherit pub_methods_protocol_g_r_p_c_proto_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a205a75bd87ab81f45786e0017271fb85 inherit pub_methods_protocol_g_r_p_c_proto_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_proto_response_handler-p.html#a205a75bd87ab81f45786e0017271fb85">didCloseWithTrailingMetadata:error:</a></td></tr>
  87. <tr class="memdesc:a205a75bd87ab81f45786e0017271fb85 inherit pub_methods_protocol_g_r_p_c_proto_response_handler-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">Issued when a call finished. <a href="protocol_g_r_p_c_proto_response_handler-p.html#a205a75bd87ab81f45786e0017271fb85">More...</a><br /></td></tr>
  88. <tr class="separator:a205a75bd87ab81f45786e0017271fb85 inherit pub_methods_protocol_g_r_p_c_proto_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a891b99c840b8877987c250e9e312145a inherit pub_methods_protocol_g_r_p_c_proto_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_proto_response_handler-p.html#a891b99c840b8877987c250e9e312145a">didWriteMessage</a></td></tr>
  90. <tr class="memdesc:a891b99c840b8877987c250e9e312145a inherit pub_methods_protocol_g_r_p_c_proto_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 writeMessage: method of <a class="el" href="interface_g_r_p_c_streaming_proto_call.html" title="A client-streaming RPC call with Protobuf.">GRPCStreamingProtoCall</a> or the initializer of <a class="el" href="interface_g_r_p_c_unary_proto_call.html" title="A unary-request RPC call with Protobuf.">GRPCUnaryProtoCall</a>) is passed to gRPC core with SEND_MESSAGE operation. <a href="protocol_g_r_p_c_proto_response_handler-p.html#a891b99c840b8877987c250e9e312145a">More...</a><br /></td></tr>
  91. <tr class="separator:a891b99c840b8877987c250e9e312145a inherit pub_methods_protocol_g_r_p_c_proto_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
  94. Properties</h2></td></tr>
  95. <tr class="memitem:ae9039f0429cab446d2b5455c1c65a5ae"><td class="memItemLeft" align="right" valign="top">NSDictionary *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_unary_response_handler.html#ae9039f0429cab446d2b5455c1c65a5ae">responseHeaders</a></td></tr>
  96. <tr class="memdesc:ae9039f0429cab446d2b5455c1c65a5ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Response headers received during the call. <a href="interface_g_r_p_c_unary_response_handler.html#ae9039f0429cab446d2b5455c1c65a5ae">More...</a><br /></td></tr>
  97. <tr class="separator:ae9039f0429cab446d2b5455c1c65a5ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a33dca1040ee0d7a78c495f3cd510fb6b"><td class="memItemLeft" align="right" valign="top">NSDictionary *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_unary_response_handler.html#a33dca1040ee0d7a78c495f3cd510fb6b">responseTrailers</a></td></tr>
  99. <tr class="memdesc:a33dca1040ee0d7a78c495f3cd510fb6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Response trailers received during the call. <a href="interface_g_r_p_c_unary_response_handler.html#a33dca1040ee0d7a78c495f3cd510fb6b">More...</a><br /></td></tr>
  100. <tr class="separator:a33dca1040ee0d7a78c495f3cd510fb6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="inherit_header properties_protocol_g_r_p_c_proto_response_handler-p"><td colspan="2" onclick="javascript:toggleInherit('properties_protocol_g_r_p_c_proto_response_handler-p')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="protocol_g_r_p_c_proto_response_handler-p.html">&lt;GRPCProtoResponseHandler&gt;</a></td></tr>
  102. <tr class="memitem:a6aeda5c3b028cc8663f6865b751d8eb1 inherit properties_protocol_g_r_p_c_proto_response_handler-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_proto_response_handler-p.html#a6aeda5c3b028cc8663f6865b751d8eb1">dispatchQueue</a></td></tr>
  103. <tr class="memdesc:a6aeda5c3b028cc8663f6865b751d8eb1 inherit properties_protocol_g_r_p_c_proto_response_handler-p"><td class="mdescLeft">&#160;</td><td class="mdescRight">All the responses must be issued to a user-provided dispatch queue. <a href="protocol_g_r_p_c_proto_response_handler-p.html#a6aeda5c3b028cc8663f6865b751d8eb1">More...</a><br /></td></tr>
  104. <tr class="separator:a6aeda5c3b028cc8663f6865b751d8eb1 inherit properties_protocol_g_r_p_c_proto_response_handler-p"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table>
  106. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  107. <div class="textblock"><p>A convenience class of objects that act as response handlers of calls. </p>
  108. <p>Issues response to a single handler when the response is completed. </p>
  109. </div><h2 class="groupheader">Method Documentation</h2>
  110. <a id="a3e3ff8fcf1d7ef43b322860df72aa930"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#a3e3ff8fcf1d7ef43b322860df72aa930">&#9670;&nbsp;</a></span>initWithResponseHandler:responseDispatchQueue:()</h2>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname">- (nullable instancetype) initWithResponseHandler: </td>
  117. <td></td>
  118. <td class="paramtype">(void(^)(GPBMessage *, NSError *))&#160;</td>
  119. <td class="paramname"><em>handler</em></td>
  120. </tr>
  121. <tr>
  122. <td class="paramkey">responseDispatchQueue:</td>
  123. <td></td>
  124. <td class="paramtype">(nullable dispatch_queue_t)&#160;</td>
  125. <td class="paramname"><em>dispatchQueue</em>&#160;</td>
  126. </tr>
  127. <tr>
  128. <td></td>
  129. <td></td>
  130. <td></td><td></td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. <p>Creates a responsehandler object with a unary call handler. </p>
  135. <p>responseHandler: The unary handler to be called when the call is completed. responseDispatchQueue: the dispatch queue on which the response handler should be issued. If it's nil, the handler will use the main queue. </p>
  136. </div>
  137. </div>
  138. <h2 class="groupheader">Property Documentation</h2>
  139. <a id="ae9039f0429cab446d2b5455c1c65a5ae"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#ae9039f0429cab446d2b5455c1c65a5ae">&#9670;&nbsp;</a></span>responseHeaders</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="mlabels">
  144. <tr>
  145. <td class="mlabels-left">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname">- (NSDictionary*) responseHeaders</td>
  149. </tr>
  150. </table>
  151. </td>
  152. <td class="mlabels-right">
  153. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>Response headers received during the call. </p>
  158. </div>
  159. </div>
  160. <a id="a33dca1040ee0d7a78c495f3cd510fb6b"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#a33dca1040ee0d7a78c495f3cd510fb6b">&#9670;&nbsp;</a></span>responseTrailers</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="mlabels">
  165. <tr>
  166. <td class="mlabels-left">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">- (NSDictionary*) responseTrailers</td>
  170. </tr>
  171. </table>
  172. </td>
  173. <td class="mlabels-right">
  174. <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Response trailers received during the call. </p>
  179. </div>
  180. </div>
  181. <hr/>The documentation for this class was generated from the following file:<ul>
  182. <li>src/objective-c/ProtoRPC/<a class="el" href="_proto_r_p_c_8h_source.html">ProtoRPC.h</a></li>
  183. </ul>
  184. </div><!-- contents -->
  185. <!-- start footer part -->
  186. <hr class="footer"/><address class="footer"><small>
  187. Generated on Wed Nov 6 2019 13:10:20 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  188. <img class="footer" src="doxygen.png" alt="doxygen"/>
  189. </a> 1.8.16
  190. </small></address>
  191. </body>
  192. </html>