_g_r_p_c_call_legacy_8h_source.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  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: src/objective-c/GRPCClient/GRPCCallLegacy.h Source File</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 id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4cd61089102e4513f03798aaef5eda59.html">objective-c</a></li><li class="navelem"><a class="el" href="dir_5cc52d91eb5c710f2aae2973ec7ec56c.html">GRPCClient</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">GRPCCallLegacy.h</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="_g_r_p_c_call_legacy_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
  72. <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
  73. <div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2019 gRPC authors.</span></div>
  74. <div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div>
  75. <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
  76. <div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
  77. <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
  78. <div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
  79. <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
  80. <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
  81. <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
  82. <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
  83. <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
  84. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
  85. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
  86. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div>
  87. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> */</span></div>
  88. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
  89. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#import &lt;<a class="code" href="_g_r_x_writer_8h.html">RxLibrary/GRXWriter.h</a>&gt;</span></div>
  90. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#import &quot;<a class="code" href="_g_r_p_c_types_8h.html">GRPCTypes.h</a>&quot;</span></div>
  91. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  92. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div>
  93. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wnullability-completeness&quot;</span></div>
  94. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
  95. <div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_call.html"> 30</a></span>&#160;<span class="keyword">@interface </span><a class="code" href="interface_g_r_p_c_call.html">GRPCCall</a> : <a class="code" href="interface_g_r_x_writer.html">GRXWriter</a></div>
  96. <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
  97. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;- (instancetype)init <a class="code" href="interface_g_r_p_c_call.html#a4a103787d117d9a2c96ac6bd19427ea9">NS_UNAVAILABLE</a>;</div>
  98. <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
  99. <div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_call.html#a2ed2de5d312a9d6e6d350f3f6d1b8756"> 58</a></span>&#160;<span class="keyword">@property</span>(atomic, readonly) NSMutableDictionary *<a class="code" href="interface_g_r_p_c_call.html#a2ed2de5d312a9d6e6d350f3f6d1b8756">requestHeaders</a>;</div>
  100. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
  101. <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_call.html#ac169b143f3ff705b6d3f3b3b26a53771"> 69</a></span>&#160;<span class="keyword">@property</span>(atomic, readonly) NSDictionary *<a class="code" href="interface_g_r_p_c_call.html#ac169b143f3ff705b6d3f3b3b26a53771">responseHeaders</a>;</div>
  102. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
  103. <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_call.html#a47397e8d3c5f177e7d40f3b5dfbe11f1"> 78</a></span>&#160;<span class="keyword">@property</span>(atomic, readonly) NSDictionary *<a class="code" href="interface_g_r_p_c_call.html#a47397e8d3c5f177e7d40f3b5dfbe11f1">responseTrailers</a>;</div>
  104. <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
  105. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;- (instancetype)initWithHost:(NSString *)host</div>
  106. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; path:(NSString *)path</div>
  107. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; requestsWriter:(<a class="code" href="interface_g_r_x_writer.html">GRXWriter</a> *)requestWriter;</div>
  108. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
  109. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;- (void)<a class="code" href="interface_g_r_p_c_call.html#a0fde84e208ae42ca92bc8a0d7d1e8df3">cancel</a>;</div>
  110. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
  111. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;+ (void)setCallSafety:(GRPCCallSafety)callSafety host:(NSString *)host path:(NSString *)path;</div>
  112. <div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_call.html#aa1c3b1f6bb443722fa23586d19b6036f"> 105</a></span>&#160;<span class="keyword">@property</span>(atomic, copy, readwrite) NSString *<a class="code" href="interface_g_r_p_c_call.html#aa1c3b1f6bb443722fa23586d19b6036f">serverName</a>;</div>
  113. <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_call.html#a69939e1a3793eecffa72fb1458bf026a"> 106</a></span>&#160;<span class="keyword">@property</span> NSTimeInterval <a class="code" href="interface_g_r_p_c_call.html#a69939e1a3793eecffa72fb1458bf026a">timeout</a>;</div>
  114. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;- (void)setResponseDispatchQueue:(dispatch_queue_t)queue;</div>
  115. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; </div>
  116. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="keyword">@end</span></div>
  117. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
  118. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="preprocessor">#pragma mark Backwards compatibiity</span></div>
  119. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
  120. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<a class="code" href="category_g_r_p_c_call_07_channel_arg_08.html#a8d045ade7403654462b6318e9df482e1">DEPRECATED_MSG_ATTRIBUTE</a>(<span class="stringliteral">&quot;Use NSDictionary or NSMutableDictionary instead.&quot;</span>)</div>
  121. <div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="protocol_g_r_p_c_request_headers-p.html"> 115</a></span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_g_r_p_c_request_headers-p.html">GRPCRequestHeaders</a> &lt;NSObject&gt;</div>
  122. <div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="protocol_g_r_p_c_request_headers-p.html#a6907a5df1d28d6580304cd4653969a0c"> 116</a></span>&#160;<span class="keyword">@property</span>(nonatomic, readonly) NSUInteger <a class="code" href="protocol_g_r_p_c_request_headers-p.html#a6907a5df1d28d6580304cd4653969a0c">count</a>;</div>
  123. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
  124. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;- (id)objectForKeyedSubscript:(<span class="keywordtype">id</span>)key;</div>
  125. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;- (void)setObject:(<span class="keywordtype">id</span>)obj forKeyedSubscript:(<span class="keywordtype">id</span>)key;</div>
  126. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
  127. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;- (void)<a class="code" href="protocol_g_r_p_c_request_headers-p.html#a2c70d17d2feba3b80e6688b9eec3a06a">removeAllObjects</a>;</div>
  128. <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;- (void)removeObjectForKey:(<span class="keywordtype">id</span>)key;</div>
  129. <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160;<span class="keyword">@end</span></div>
  130. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
  131. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div>
  132. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wdeprecated&quot;</span></div>
  133. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; </div>
  134. <div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="category_n_s_mutable_dictionary_07_g_r_p_c_request_headers_08.html"> 128</a></span>&#160;<span class="keyword">@interface </span><a class="code" href="category_n_s_mutable_dictionary_07_g_r_p_c_request_headers_08.html">NSMutableDictionary (GRPCRequestHeaders)</a> &lt;<a class="code" href="protocol_g_r_p_c_request_headers-p.html">GRPCRequestHeaders</a>&gt;</div>
  135. <div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="keyword">@end</span></div>
  136. <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div>
  137. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div>
  138. </div><!-- fragment --></div><!-- contents -->
  139. <div class="ttc" id="ainterface_g_r_p_c_call_html_a69939e1a3793eecffa72fb1458bf026a"><div class="ttname"><a href="interface_g_r_p_c_call.html#a69939e1a3793eecffa72fb1458bf026a">GRPCCall::timeout</a></div><div class="ttdeci">NSTimeInterval timeout</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:106</div></div>
  140. <div class="ttc" id="a_g_r_x_writer_8h_html"><div class="ttname"><a href="_g_r_x_writer_8h.html">GRXWriter.h</a></div></div>
  141. <div class="ttc" id="aprotocol_g_r_p_c_request_headers-p_html_a6907a5df1d28d6580304cd4653969a0c"><div class="ttname"><a href="protocol_g_r_p_c_request_headers-p.html#a6907a5df1d28d6580304cd4653969a0c">GRPCRequestHeaders-p::count</a></div><div class="ttdeci">NSUInteger count</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:116</div></div>
  142. <div class="ttc" id="ainterface_g_r_p_c_call_html_aa1c3b1f6bb443722fa23586d19b6036f"><div class="ttname"><a href="interface_g_r_p_c_call.html#aa1c3b1f6bb443722fa23586d19b6036f">GRPCCall::serverName</a></div><div class="ttdeci">NSString * serverName</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:105</div></div>
  143. <div class="ttc" id="acategory_n_s_mutable_dictionary_07_g_r_p_c_request_headers_08_html"><div class="ttname"><a href="category_n_s_mutable_dictionary_07_g_r_p_c_request_headers_08.html">NSMutableDictionary(GRPCRequestHeaders)</a></div><div class="ttdoc">This is only needed for backwards-compatibility.</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:128</div></div>
  144. <div class="ttc" id="ainterface_g_r_p_c_call_html_a47397e8d3c5f177e7d40f3b5dfbe11f1"><div class="ttname"><a href="interface_g_r_p_c_call.html#a47397e8d3c5f177e7d40f3b5dfbe11f1">GRPCCall::responseTrailers</a></div><div class="ttdeci">NSDictionary * responseTrailers</div><div class="ttdoc">Same as responseHeaders, but populated with the HTTP trailers received from the server before the cal...</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:78</div></div>
  145. <div class="ttc" id="ainterface_g_r_p_c_call_html_a2ed2de5d312a9d6e6d350f3f6d1b8756"><div class="ttname"><a href="interface_g_r_p_c_call.html#a2ed2de5d312a9d6e6d350f3f6d1b8756">GRPCCall::requestHeaders</a></div><div class="ttdeci">NSMutableDictionary * requestHeaders</div><div class="ttdoc">The container of the request headers of an RPC conforms to this protocol, which is a subset of NSMuta...</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:58</div></div>
  146. <div class="ttc" id="ainterface_g_r_p_c_call_html_ac169b143f3ff705b6d3f3b3b26a53771"><div class="ttname"><a href="interface_g_r_p_c_call.html#ac169b143f3ff705b6d3f3b3b26a53771">GRPCCall::responseHeaders</a></div><div class="ttdeci">NSDictionary * responseHeaders</div><div class="ttdoc">This dictionary is populated with the HTTP headers received from the server.</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:69</div></div>
  147. <div class="ttc" id="ainterface_g_r_p_c_call_html"><div class="ttname"><a href="interface_g_r_p_c_call.html">GRPCCall</a></div><div class="ttdoc">This is the legacy interface of this gRPC library.</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:30</div></div>
  148. <div class="ttc" id="aprotocol_g_r_p_c_request_headers-p_html_a2c70d17d2feba3b80e6688b9eec3a06a"><div class="ttname"><a href="protocol_g_r_p_c_request_headers-p.html#a2c70d17d2feba3b80e6688b9eec3a06a">-[GRPCRequestHeaders-p removeAllObjects]</a></div><div class="ttdeci">void removeAllObjects()</div></div>
  149. <div class="ttc" id="ainterface_g_r_p_c_call_html_a0fde84e208ae42ca92bc8a0d7d1e8df3"><div class="ttname"><a href="interface_g_r_p_c_call.html#a0fde84e208ae42ca92bc8a0d7d1e8df3">-[GRPCCall cancel]</a></div><div class="ttdeci">void cancel()</div><div class="ttdoc">Finishes the request side of this call, notifies the server that the RPC should be cancelled,...</div></div>
  150. <div class="ttc" id="a_g_r_p_c_types_8h_html"><div class="ttname"><a href="_g_r_p_c_types_8h.html">GRPCTypes.h</a></div></div>
  151. <div class="ttc" id="aprotocol_g_r_p_c_request_headers-p_html"><div class="ttname"><a href="protocol_g_r_p_c_request_headers-p.html">GRPCRequestHeaders-p</a></div><div class="ttdoc">This protocol is kept for backwards compatibility with existing code.</div><div class="ttdef"><b>Definition:</b> GRPCCallLegacy.h:115</div></div>
  152. <div class="ttc" id="ainterface_g_r_p_c_call_html_a4a103787d117d9a2c96ac6bd19427ea9"><div class="ttname"><a href="interface_g_r_p_c_call.html#a4a103787d117d9a2c96ac6bd19427ea9">-[GRPCCall NS_UNAVAILABLE]</a></div><div class="ttdeci">instancetype NS_UNAVAILABLE()</div></div>
  153. <div class="ttc" id="ainterface_g_r_x_writer_html"><div class="ttname"><a href="interface_g_r_x_writer.html">GRXWriter</a></div><div class="ttdoc">An GRXWriter object can produce, on demand, a sequence of values.</div><div class="ttdef"><b>Definition:</b> GRXWriter.h:77</div></div>
  154. <div class="ttc" id="acategory_g_r_p_c_call_07_channel_arg_08_html_a8d045ade7403654462b6318e9df482e1"><div class="ttname"><a href="category_g_r_p_c_call_07_channel_arg_08.html#a8d045ade7403654462b6318e9df482e1">+[GRPCCall(ChannelArg) DEPRECATED_MSG_ATTRIBUTE]</a></div><div class="ttdeci">&quot;The API for this feature is experimental, &quot; &quot;and might be removed or modified at any &quot; &quot;time.&quot; DEPRECATED_MSG_ATTRIBUTE()</div></div>
  155. <!-- start footer part -->
  156. <hr class="footer"/><address class="footer"><small>
  157. Generated on Wed Mar 3 2021 19:20:08 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  158. <img class="footer" src="doxygen.png" alt="doxygen"/>
  159. </a> 1.8.17
  160. </small></address>
  161. </body>
  162. </html>