| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=9"/><meta name="generator" content="Doxygen 1.8.16"/><meta name="viewport" content="width=device-width, initial-scale=1"/><title>GRPC Objective-C: src/objective-c/ProtoRPC/ProtoService.h Source File</title><link href="tabs.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="dynsections.js"></script><link href="search/search.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="search/searchdata.js"></script><script type="text/javascript" src="search/search.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css" /></head><body><div id="top"><!-- do not remove this div, it is closed by doxygen! --><div id="titlearea"><table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;">  <td id="projectalign" style="padding-left: 0.5em;">   <div id="projectname">GRPC Objective-C    <span id="projectnumber">1.25.0</span>   </div>  </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.16 --><script type="text/javascript">/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */var searchBox = new SearchBox("searchBox", "search",false,'Search');/* @license-end */</script><script type="text/javascript" src="menudata.js"></script><script type="text/javascript" src="menu.js"></script><script type="text/javascript">/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */$(function() {  initMenu('',true,false,'search.php','Search');  $(document).ready(function() { init_search(); });});/* @license-end */</script><div id="main-nav"></div><!-- window showing the filter options --><div id="MSearchSelectWindow"     onmouseover="return searchBox.OnSearchSelectShow()"     onmouseout="return searchBox.OnSearchSelectHide()"     onkeydown="return searchBox.OnSearchSelectKey(event)"></div><!-- iframe showing the search results (closed by default) --><div id="MSearchResultsWindow"><iframe src="javascript:void(0)" frameborder="0"         name="MSearchResults" id="MSearchResults"></iframe></div><div id="nav-path" class="navpath">  <ul><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_a1b3eed7d9ff3e94b4e425a902e10bae.html">ProtoRPC</a></li>  </ul></div></div><!-- top --><div class="header">  <div class="headertitle"><div class="title">ProtoService.h</div>  </div></div><!--header--><div class="contents"><a href="_proto_service_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> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span> <span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span> <span class="comment"> * Copyright 2015 gRPC authors.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span> <span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span> <span class="comment"> */</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>  </div><div class="line"><a name="l00019"></a><span class="lineno">   19</span> <span class="preprocessor">#import <Foundation/Foundation.h></span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>  </div><div class="line"><a name="l00021"></a><span class="lineno">   21</span> <span class="preprocessor">#import <<a class="code" href="_g_r_p_c_call_options_8h.html">GRPCClient/GRPCCallOptions.h</a>></span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span> <span class="preprocessor">#import "<a class="code" href="_proto_r_p_c_8h.html">ProtoRPC.h</a>"</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>  </div><div class="line"><a name="l00024"></a><span class="lineno">   24</span> <span class="keyword">@protocol </span><a class="code" href="interface_g_r_x_writeable.html">GRXWriteable</a>;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span> <span class="keyword">@class</span> <a class="code" href="interface_g_r_x_writer.html">GRXWriter</a>;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span> <span class="keyword">@class</span> <a class="code" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a>;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>  </div><div class="line"><a name="l00028"></a><span class="lineno">   28</span> <span class="preprocessor">#pragma clang diagnostic push</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span> <span class="preprocessor">#pragma clang diagnostic ignored "-Wnullability-completeness"</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>  </div><div class="line"><a name="l00031"></a><span class="lineno">   31</span> <a class="code" href="_proto_r_p_c_legacy_8h.html#af9043347586081269571eb223166f817">__attribute__</a>((deprecated(<span class="stringliteral">"Please use GRPCProtoService."</span>))) <span class="keyword">@interface </span>ProtoService</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>     : NSObject</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>  </div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>       -</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>       (nullable instancetype)initWithHost : (nonnull NSString *)host packageName</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>     : (nonnull NSString *)packageName serviceName : (nonnull NSString *)serviceName callOptions</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>     : (nullable <a class="code" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)callOptions NS_DESIGNATED_INITIALIZER;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>  </div><div class="line"><a name="l00039"></a><span class="lineno">   39</span> - (nullable <a class="code" href="interface_g_r_p_c_unary_proto_call.html">GRPCUnaryProtoCall</a> *)RPCToMethod:(nonnull NSString *)method</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>                                      message:(nonnull <span class="keywordtype">id</span>)message</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>                              responseHandler:(nonnull <span class="keywordtype">id</span><<a class="code" href="protocol_g_r_p_c_proto_response_handler-p.html">GRPCProtoResponseHandler</a>>)handler</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>                                  callOptions:(nullable <a class="code" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)callOptions</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>                                responseClass:(nonnull Class)responseClass;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>  </div><div class="line"><a name="l00045"></a><span class="lineno">   45</span> - (nullable <a class="code" href="interface_g_r_p_c_streaming_proto_call.html">GRPCStreamingProtoCall</a> *)RPCToMethod:(nonnull NSString *)method</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>                                  responseHandler:(nonnull <span class="keywordtype">id</span><<a class="code" href="protocol_g_r_p_c_proto_response_handler-p.html">GRPCProtoResponseHandler</a>>)handler</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>                                      callOptions:(nullable <a class="code" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *)callOptions</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>                                    responseClass:(nonnull Class)responseClass;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>  </div><div class="line"><a name="l00050"></a><span class="lineno">   50</span> <span class="keyword">@end</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>  </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="category_proto_service_07_legacy_08.html">   52</a></span>     <span class="keyword">@interface </span><a class="code" href="category_proto_service_07_legacy_08.html">ProtoService(Legacy)</a></div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>  </div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>     - (instancetype)initWithHost : (NSString *)host packageName</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>     : (NSString *)packageName serviceName : (NSString *)serviceName;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>  </div><div class="line"><a name="l00057"></a><span class="lineno">   57</span> - (<a class="code" href="interface_g_r_p_c_proto_call.html">GRPCProtoCall</a> *)RPCToMethod:(NSString *)method</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>                 requestsWriter:(<a class="code" href="interface_g_r_x_writer.html">GRXWriter</a> *)requestsWriter</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>                  responseClass:(Class)responseClass</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>             responsesWriteable:(<span class="keywordtype">id</span><<a class="code" href="interface_g_r_x_writeable.html">GRXWriteable</a>>)responsesWriteable;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>  </div><div class="line"><a name="l00062"></a><span class="lineno">   62</span> <span class="keyword">@end</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>  </div><div class="line"><a name="l00064"></a><span class="lineno">   64</span> <span class="preprocessor">#pragma clang diagnostic pop</span></div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>  </div><div class="line"><a name="l00070"></a><span class="lineno">   70</span> <span class="preprocessor">#pragma clang diagnostic push</span></div><div class="line"><a name="l00071"></a><span class="lineno">   71</span> <span class="preprocessor">#pragma clang diagnostic ignored "-Wdeprecated-declarations"</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_proto_service.html">   72</a></span>     <span class="keyword">@interface </span><a class="code" href="interface_g_r_p_c_proto_service.html">GRPCProtoService</a> : ProtoService</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span> <span class="preprocessor">#pragma clang diagnostic pop</span></div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>  </div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>                                   <span class="keyword">@end</span></div></div><!-- fragment --></div><!-- contents --><div class="ttc" id="a_proto_r_p_c_legacy_8h_html_af9043347586081269571eb223166f817"><div class="ttname"><a href="_proto_r_p_c_legacy_8h.html#af9043347586081269571eb223166f817">__attribute__</a></div><div class="ttdeci">__attribute__(void) start</div><div class="ttdoc">host parameter should not contain the scheme (http:// or https://), only the name or IP addr and the ...</div></div><div class="ttc" id="ainterface_g_r_p_c_proto_call_html"><div class="ttname"><a href="interface_g_r_p_c_proto_call.html">GRPCProtoCall</a></div><div class="ttdoc">This subclass is empty now.</div><div class="ttdef"><b>Definition:</b> ProtoRPCLegacy.h:56</div></div><div class="ttc" id="ainterface_g_r_p_c_call_options_html"><div class="ttname"><a href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a></div><div class="ttdoc">Immutable user configurable options for a gRPC call.</div><div class="ttdef"><b>Definition:</b> GRPCCallOptions.h:30</div></div><div class="ttc" id="a_proto_r_p_c_8h_html"><div class="ttname"><a href="_proto_r_p_c_8h.html">ProtoRPC.h</a></div></div><div class="ttc" id="ainterface_g_r_p_c_proto_service_html"><div class="ttname"><a href="interface_g_r_p_c_proto_service.html">GRPCProtoService</a></div><div class="ttdoc">This subclass is empty now.</div><div class="ttdef"><b>Definition:</b> ProtoService.h:72</div></div><div class="ttc" id="ainterface_g_r_p_c_streaming_proto_call_html"><div class="ttname"><a href="interface_g_r_p_c_streaming_proto_call.html">GRPCStreamingProtoCall</a></div><div class="ttdoc">A client-streaming RPC call with Protobuf.</div><div class="ttdef"><b>Definition:</b> ProtoRPC.h:129</div></div><div class="ttc" id="ainterface_g_r_p_c_unary_proto_call_html"><div class="ttname"><a href="interface_g_r_p_c_unary_proto_call.html">GRPCUnaryProtoCall</a></div><div class="ttdoc">A unary-request RPC call with Protobuf.</div><div class="ttdef"><b>Definition:</b> ProtoRPC.h:98</div></div><div class="ttc" id="a_g_r_p_c_call_options_8h_html"><div class="ttname"><a href="_g_r_p_c_call_options_8h.html">GRPCCallOptions.h</a></div></div><div class="ttc" id="ainterface_g_r_x_writeable_html"><div class="ttname"><a href="interface_g_r_x_writeable.html">GRXWriteable</a></div><div class="ttdoc">Utility to create objects that conform to the GRXWriteable protocol, from blocks that handle each of ...</div><div class="ttdef"><b>Definition:</b> GRXWriteable.h:47</div></div><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><div class="ttc" id="acategory_proto_service_07_legacy_08_html"><div class="ttname"><a href="category_proto_service_07_legacy_08.html">ProtoService(Legacy)</a></div><div class="ttdef"><b>Definition:</b> ProtoService.h:52</div></div><div class="ttc" id="aprotocol_g_r_p_c_proto_response_handler-p_html"><div class="ttname"><a href="protocol_g_r_p_c_proto_response_handler-p.html">GRPCProtoResponseHandler-p</a></div><div class="ttdoc">An object can implement this protocol to receive responses from server from a call.</div><div class="ttdef"><b>Definition:</b> ProtoRPC.h:33</div></div><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Wed Nov 6 2019 13:10:20 for GRPC Objective-C by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16</small></address></body></html>
 |