grpc/objc/annotated.html

127 lines
20 KiB
HTML

<!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: Data Structures</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.64.0</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">Data Structures</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_i_d_sign_in_07_g_r_p_c_08.html" target="_self">GIDSignIn(GRPC)</a></td><td class="desc">Extend GIDSignIn class to comply <a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html" title="Implement this protocol to provide a token to gRPC when a call is initiated.">GRPCAuthorizationProtocol</a> </td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html" target="_self">&lt;GRPCAuthorizationProtocol&gt;</a></td><td class="desc">Implement this protocol to provide a token to gRPC when a call is initiated </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_call.html" target="_self">GRPCCall</a></td><td class="desc">This is the legacy interface of this gRPC library </td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_p_c_call_07_channel_arg_08.html" target="_self">GRPCCall(ChannelArg)</a></td><td class="desc">The interface is deprecated </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_p_c_call_07_channel_credentials_08.html" target="_self">GRPCCall(ChannelCredentials)</a></td><td class="desc">The interface is deprecated </td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_p_c_call_07_cronet_08.html" target="_self">GRPCCall(Cronet)</a></td><td class="desc">The interface is deprecated </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_p_c_call_07_o_auth2_08.html" target="_self">GRPCCall(OAuth2)</a></td><td class="desc">The interface is deprecated </td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_p_c_call_07_tests_08.html" target="_self">GRPCCall(Tests)</a></td><td class="desc">The interface is deprecated </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_call2.html" target="_self">GRPCCall2</a></td><td class="desc">A <a class="el" href="interface_g_r_p_c_call2.html" title="A GRPCCall2 object represents an RPC call.">GRPCCall2</a> object represents an RPC call </td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_p_c_call2_07_interceptor_08.html" target="_self">GRPCCall2(Interceptor)</a></td><td class="desc">The interface for gRPC global interceptor </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_call_options.html" target="_self">GRPCCallOptions</a></td><td class="desc">Immutable user configurable options for a gRPC call </td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_g_r_p_c_default_transport_impl_list.html" target="_self">GRPCDefaultTransportImplList</a></td><td class="desc">The default transport implementations available in gRPC </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_dispatchable-p.html" target="_self">&lt;GRPCDispatchable&gt;</a></td><td class="desc">An object that processes its methods with a dispatch queue </td></tr>
<tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_interceptor.html" target="_self">GRPCInterceptor</a></td><td class="desc">Base class for a gRPC interceptor </td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html" target="_self">&lt;GRPCInterceptorFactory&gt;</a></td><td class="desc">An interceptor factory object is used to create interceptor object for the call at the call start time </td></tr>
<tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_interceptor_interface-p.html" target="_self">&lt;GRPCInterceptorInterface&gt;</a></td><td class="desc">The <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> defines the request events that can occur to an interceptor </td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_interceptor_manager.html" target="_self">GRPCInterceptorManager</a></td><td class="desc"><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 </td></tr>
<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_mutable_call_options.html" target="_self">GRPCMutableCallOptions</a></td><td class="desc">Mutable user configurable options for a gRPC call </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_proto_call.html" target="_self">GRPCProtoCall</a></td><td class="desc">This subclass is empty now </td></tr>
<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_proto_method.html" target="_self">GRPCProtoMethod</a></td><td class="desc">This subclass is empty now </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_proto_response_handler-p.html" target="_self">&lt;GRPCProtoResponseHandler&gt;</a></td><td class="desc">An object can implement this protocol to receive responses from server from a call </td></tr>
<tr id="row_21_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_proto_service.html" target="_self">GRPCProtoService</a></td><td class="desc">This subclass is empty now </td></tr>
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_request_headers-p.html" target="_self">&lt;GRPCRequestHeaders&gt;</a></td><td class="desc">This protocol is kept for backwards compatibility with existing code </td></tr>
<tr id="row_23_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_request_options.html" target="_self">GRPCRequestOptions</a></td><td class="desc">HTTP request parameters </td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_response_handler-p.html" target="_self">&lt;GRPCResponseHandler&gt;</a></td><td class="desc">An object can implement this protocol to receive responses from server from a call </td></tr>
<tr id="row_25_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_streaming_proto_call.html" target="_self">GRPCStreamingProtoCall</a></td><td class="desc">A client-streaming RPC call with Protobuf </td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_transport.html" target="_self">GRPCTransport</a></td><td class="desc">Base class for transport implementations </td></tr>
<tr id="row_27_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_p_c_transport_factory-p.html" target="_self">&lt;GRPCTransportFactory&gt;</a></td><td class="desc">The factory to create a transport </td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_transport_registry.html" target="_self">GRPCTransportRegistry</a></td><td class="desc">The registry of transport implementations </td></tr>
<tr id="row_29_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_unary_proto_call.html" target="_self">GRPCUnaryProtoCall</a></td><td class="desc">A unary-request RPC call with Protobuf </td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_p_c_unary_response_handler.html" target="_self">GRPCUnaryResponseHandler</a></td><td class="desc">A convenience class of objects that act as response handlers of calls </td></tr>
<tr id="row_31_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_buffered_pipe.html" target="_self">GRXBufferedPipe</a></td><td class="desc">A buffered pipe is a Writer that also acts as a Writeable </td></tr>
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_concurrent_writeable.html" target="_self">GRXConcurrentWriteable</a></td><td class="desc">This is a thread-safe wrapper over a <a class="el" href="interface_g_r_x_writeable.html" title="Utility to create objects that conform to the GRXWriteable protocol, from blocks that handle each of ...">GRXWriteable</a> instance </td></tr>
<tr id="row_33_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_forwarding_writer.html" target="_self">GRXForwardingWriter</a></td><td class="desc">A "proxy" class that simply forwards values, completion, and errors from its input writer to its writeable </td></tr>
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_immediate_single_writer.html" target="_self">GRXImmediateSingleWriter</a></td><td class="desc">Utility to construct <a class="el" href="interface_g_r_x_writer.html" title="An GRXWriter object can produce, on demand, a sequence of values.">GRXWriter</a> instances from values that are immediately available when required </td></tr>
<tr id="row_35_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_immediate_writer.html" target="_self">GRXImmediateWriter</a></td><td class="desc">Utility to construct <a class="el" href="interface_g_r_x_writer.html" title="An GRXWriter object can produce, on demand, a sequence of values.">GRXWriter</a> instances from values that are immediately available when required </td></tr>
<tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_mapping_writer.html" target="_self">GRXMappingWriter</a></td><td class="desc">A "proxy" writer that transforms all the values of its input writer by using a mapping function </td></tr>
<tr id="row_37_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_writeable.html" target="_self">GRXWriteable</a></td><td class="desc">Utility to create objects that conform to the <a class="el" href="interface_g_r_x_writeable.html" title="Utility to create objects that conform to the GRXWriteable protocol, from blocks that handle each of ...">GRXWriteable</a> protocol, from blocks that handle each of the two methods of the protocol </td></tr>
<tr id="row_38_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="protocol_g_r_x_writeable-p.html" target="_self">&lt;GRXWriteable&gt;</a></td><td class="desc">A <a class="el" href="interface_g_r_x_writeable.html" title="Utility to create objects that conform to the GRXWriteable protocol, from blocks that handle each of ...">GRXWriteable</a> is an object to which a sequence of values can be sent </td></tr>
<tr id="row_39_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interface_g_r_x_writer.html" target="_self">GRXWriter</a></td><td class="desc">An <a class="el" href="interface_g_r_x_writer.html" title="An GRXWriter object can produce, on demand, a sequence of values.">GRXWriter</a> object can produce, on demand, a sequence of values </td></tr>
<tr id="row_40_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_x_writer_07_immediate_08.html" target="_self">GRXWriter(Immediate)</a></td><td class="desc"></td></tr>
<tr id="row_41_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_g_r_x_writer_07_transformations_08.html" target="_self">GRXWriter(Transformations)</a></td><td class="desc"></td></tr>
<tr id="row_42_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_n_s_enumerator_07_g_r_x_util_08.html" target="_self">NSEnumerator(GRXUtil)</a></td><td class="desc"></td></tr>
<tr id="row_43_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_n_s_mutable_dictionary_07_g_r_p_c_request_headers_08.html" target="_self">NSMutableDictionary(GRPCRequestHeaders)</a></td><td class="desc">This is only needed for backwards-compatibility </td></tr>
<tr id="row_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="category_proto_service_07_legacy_08.html" target="_self">ProtoService(Legacy)</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri May 17 2024 01:17:55 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>