carto
/
grpc


			
				
					
						
						
							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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC Objective-C: src/objective-c/GRPCClient/GRPCTransport.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
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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_5cc52d91eb5c710f2aae2973ec7ec56c.html">GRPCClient</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">GRPCTransport.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_g_r_p_c_transport_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>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2019 gRPC authors.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<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>
<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>
<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>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<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>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div>
<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>
<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>
<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>
<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>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">// The interface for a transport implementation</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#import &quot;<a class="code" href="_g_r_p_c_interceptor_8h.html">GRPCInterceptor.h</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;NS_ASSUME_NONNULL_BEGIN</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#pragma mark Transport ID</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="struct_g_r_p_c_default_transport_impl_list.html">   31</a></span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span><a class="code" href="struct_g_r_p_c_default_transport_impl_list.html">GRPCDefaultTransportImplList</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="struct_g_r_p_c_default_transport_impl_list.html#a5c0d9361a2025eb78a7a8bbd33903945">   32</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a> <a class="code" href="struct_g_r_p_c_default_transport_impl_list.html#a5c0d9361a2025eb78a7a8bbd33903945">core_secure</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="struct_g_r_p_c_default_transport_impl_list.html#a18c8456c85ddb2bba6ade62461af424f">   33</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a> <a class="code" href="struct_g_r_p_c_default_transport_impl_list.html#a18c8456c85ddb2bba6ade62461af424f">core_insecure</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;} <a class="code" href="_g_r_p_c_transport_8h.html#ad16c661668e4cf064f06c46ec2bc3582">GRPCDefaultTransportImplList</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;BOOL <a class="code" href="_g_r_p_c_transport_8h.html#a8e2c93e95c228339afb5476dcfdbdf23">TransportIDIsEqual</a>(<a class="code" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a> lhs, <a class="code" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a> rhs);</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;NSUInteger <a class="code" href="_g_r_p_c_transport_8h.html#ab8536fda3bc41e502616e208e4f813b8">TransportIDHash</a>(<a class="code" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a>);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor">#pragma mark Transport and factory</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_g_r_p_c_interceptor_interface-p.html">GRPCInterceptorInterface</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_g_r_p_c_response_handler-p.html">GRPCResponseHandler</a>;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="keyword">@class</span> GRPCTransportManager;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="keyword">@class</span> <a class="code" href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<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="l00049"></a><span class="lineno">   49</span>&#160;<span class="keyword">@class</span> <a class="code" href="interface_g_r_p_c_transport.html">GRPCTransport</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="protocol_g_r_p_c_transport_factory-p.html">   52</a></span>&#160;<span class="keyword">@protocol </span><a class="code" href="protocol_g_r_p_c_transport_factory-p.html">GRPCTransportFactory</a> &lt;NSObject&gt;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;- (<a class="code" href="interface_g_r_p_c_transport.html">GRPCTransport</a> *)createTransportWithManager:(GRPCTransportManager *)transportManager;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="protocol_g_r_p_c_transport_factory-p.html#a5b8f42f2df56228993ad6c91a22aba15">   58</a></span>&#160;<span class="keyword">@property</span>(nonatomic, readonly) NSArray&lt;id&lt;GRPCInterceptorFactory&gt;&gt; *<a class="code" href="protocol_g_r_p_c_transport_factory-p.html#a5b8f42f2df56228993ad6c91a22aba15">transportInterceptorFactories</a>;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">@end</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_transport_registry.html">   63</a></span>&#160;<span class="keyword">@interface </span><a class="code" href="interface_g_r_p_c_transport_registry.html">GRPCTransportRegistry</a> : NSObject</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;+ (instancetype)<a class="code" href="interface_g_r_p_c_transport_registry.html#a50779d7e74659a3a83873efeef390e03">sharedInstance</a>;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;- (void)registerTransportWithID:(<a class="code" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a>)transportID</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                        factory:(<span class="keywordtype">id</span>&lt;<a class="code" href="protocol_g_r_p_c_transport_factory-p.html">GRPCTransportFactory</a>&gt;)factory;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="keyword">@end</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="interface_g_r_p_c_transport.html">   82</a></span>&#160;<span class="keyword">@interface </span><a class="code" href="interface_g_r_p_c_transport.html">GRPCTransport</a> : NSObject &lt;<a class="code" href="protocol_g_r_p_c_interceptor_interface-p.html">GRPCInterceptorInterface</a>&gt;</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="keyword">@end</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;NS_ASSUME_NONNULL_END</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="a_g_r_p_c_types_8h_html_a1cf875c3f6d8737657907e38b468d05f"><div class="ttname"><a href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a></div><div class="ttdeci">char *_Nonnull GRPCTransportID</div><div class="ttdoc">The id of a transport implementation.</div><div class="ttdef"><b>Definition:</b> GRPCTypes.h:181</div></div>
<div class="ttc" id="aprotocol_g_r_p_c_transport_factory-p_html_a5b8f42f2df56228993ad6c91a22aba15"><div class="ttname"><a href="protocol_g_r_p_c_transport_factory-p.html#a5b8f42f2df56228993ad6c91a22aba15">GRPCTransportFactory-p::transportInterceptorFactories</a></div><div class="ttdeci">NSArray&lt; id&lt; GRPCInterceptorFactory &gt; &gt; * transportInterceptorFactories</div><div class="ttdoc">Get a list of factories for transport inteceptors.</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:58</div></div>
<div class="ttc" id="ainterface_g_r_p_c_transport_registry_html"><div class="ttname"><a href="interface_g_r_p_c_transport_registry.html">GRPCTransportRegistry</a></div><div class="ttdoc">The registry of transport implementations.</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:63</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="aprotocol_g_r_p_c_interceptor_interface-p_html"><div class="ttname"><a href="protocol_g_r_p_c_interceptor_interface-p.html">GRPCInterceptorInterface-p</a></div><div class="ttdoc">The GRPCInterceptorInterface defines the request events that can occur to an interceptor.</div><div class="ttdef"><b>Definition:</b> GRPCInterceptor.h:130</div></div>
<div class="ttc" id="astruct_g_r_p_c_default_transport_impl_list_html"><div class="ttname"><a href="struct_g_r_p_c_default_transport_impl_list.html">GRPCDefaultTransportImplList</a></div><div class="ttdoc">The default transport implementations available in gRPC.</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:31</div></div>
<div class="ttc" id="ainterface_g_r_p_c_transport_html"><div class="ttname"><a href="interface_g_r_p_c_transport.html">GRPCTransport</a></div><div class="ttdoc">Base class for transport implementations.</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:82</div></div>
<div class="ttc" id="ainterface_g_r_p_c_transport_registry_html_a50779d7e74659a3a83873efeef390e03"><div class="ttname"><a href="interface_g_r_p_c_transport_registry.html#a50779d7e74659a3a83873efeef390e03">+[GRPCTransportRegistry sharedInstance]</a></div><div class="ttdeci">instancetype sharedInstance()</div></div>
<div class="ttc" id="a_g_r_p_c_transport_8h_html_ad16c661668e4cf064f06c46ec2bc3582"><div class="ttname"><a href="_g_r_p_c_transport_8h.html#ad16c661668e4cf064f06c46ec2bc3582">GRPCDefaultTransportImplList</a></div><div class="ttdeci">NS_ASSUME_NONNULL_BEGIN const struct GRPCDefaultTransportImplList GRPCDefaultTransportImplList</div></div>
<div class="ttc" id="aprotocol_g_r_p_c_transport_factory-p_html"><div class="ttname"><a href="protocol_g_r_p_c_transport_factory-p.html">GRPCTransportFactory-p</a></div><div class="ttdoc">The factory to create a transport.</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:52</div></div>
<div class="ttc" id="a_g_r_p_c_transport_8h_html_a8e2c93e95c228339afb5476dcfdbdf23"><div class="ttname"><a href="_g_r_p_c_transport_8h.html#a8e2c93e95c228339afb5476dcfdbdf23">TransportIDIsEqual</a></div><div class="ttdeci">BOOL TransportIDIsEqual(GRPCTransportID lhs, GRPCTransportID rhs)</div><div class="ttdoc">Returns whether two transport id's are identical.</div></div>
<div class="ttc" id="a_g_r_p_c_transport_8h_html_ab8536fda3bc41e502616e208e4f813b8"><div class="ttname"><a href="_g_r_p_c_transport_8h.html#ab8536fda3bc41e502616e208e4f813b8">TransportIDHash</a></div><div class="ttdeci">NSUInteger TransportIDHash(GRPCTransportID)</div><div class="ttdoc">Returns the hash value of a transport id.</div></div>
<div class="ttc" id="astruct_g_r_p_c_default_transport_impl_list_html_a18c8456c85ddb2bba6ade62461af424f"><div class="ttname"><a href="struct_g_r_p_c_default_transport_impl_list.html#a18c8456c85ddb2bba6ade62461af424f">GRPCDefaultTransportImplList::core_insecure</a></div><div class="ttdeci">const GRPCTransportID core_insecure</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:33</div></div>
<div class="ttc" id="a_g_r_p_c_interceptor_8h_html"><div class="ttname"><a href="_g_r_p_c_interceptor_8h.html">GRPCInterceptor.h</a></div></div>
<div class="ttc" id="astruct_g_r_p_c_default_transport_impl_list_html_a5c0d9361a2025eb78a7a8bbd33903945"><div class="ttname"><a href="struct_g_r_p_c_default_transport_impl_list.html#a5c0d9361a2025eb78a7a8bbd33903945">GRPCDefaultTransportImplList::core_secure</a></div><div class="ttdeci">const GRPCTransportID core_secure</div><div class="ttdef"><b>Definition:</b> GRPCTransport.h:32</div></div>
<div class="ttc" id="ainterface_g_r_p_c_request_options_html"><div class="ttname"><a href="interface_g_r_p_c_request_options.html">GRPCRequestOptions</a></div><div class="ttdoc">HTTP request parameters.</div><div class="ttdef"><b>Definition:</b> GRPCCall.h:102</div></div>
<div class="ttc" id="aprotocol_g_r_p_c_response_handler-p_html"><div class="ttname"><a href="protocol_g_r_p_c_response_handler-p.html">GRPCResponseHandler-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> GRPCCall.h:50</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:20:08 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>