123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827 |
- <!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: GRPCCallOptions Class Reference</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.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&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><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Instance Methods</a> |
- <a href="#properties">Properties</a> </div>
- <div class="headertitle">
- <div class="title">GRPCCallOptions Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Immutable user configurable options for a gRPC call.
- <a href="interface_g_r_p_c_call_options.html#details">More...</a></p>
- <p><code>#import <<a class="el" href="_g_r_p_c_call_options_8h_source.html">GRPCCallOptions.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Instance Methods</h2></td></tr>
- <tr class="memitem:a5ae8dd4e3119e8940a5b8ecccd6b0c81"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_g_r_p_c_call_options.html#a5ae8dd4e3119e8940a5b8ecccd6b0c81">hasChannelOptionsEqualTo:</a></td></tr>
- <tr class="memdesc:a5ae8dd4e3119e8940a5b8ecccd6b0c81"><td class="mdescLeft"> </td><td class="mdescRight">Return if the channel options are equal to another object. <a href="interface_g_r_p_c_call_options.html#a5ae8dd4e3119e8940a5b8ecccd6b0c81">More...</a><br /></td></tr>
- <tr class="separator:a5ae8dd4e3119e8940a5b8ecccd6b0c81"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
- Properties</h2></td></tr>
- <tr class="memitem:a8414f883f2319f6e912ea6eace1799a8"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a8414f883f2319f6e912ea6eace1799a8">serverAuthority</a></td></tr>
- <tr class="memdesc:a8414f883f2319f6e912ea6eace1799a8"><td class="mdescLeft"> </td><td class="mdescRight">The authority for the RPC. <a href="interface_g_r_p_c_call_options.html#a8414f883f2319f6e912ea6eace1799a8">More...</a><br /></td></tr>
- <tr class="separator:a8414f883f2319f6e912ea6eace1799a8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad772eb38a4759bd2704ffaaf88436fff"><td class="memItemLeft" align="right" valign="top">NSTimeInterval </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#ad772eb38a4759bd2704ffaaf88436fff">timeout</a></td></tr>
- <tr class="memdesc:ad772eb38a4759bd2704ffaaf88436fff"><td class="mdescLeft"> </td><td class="mdescRight">The timeout for the RPC call in seconds. <a href="interface_g_r_p_c_call_options.html#ad772eb38a4759bd2704ffaaf88436fff">More...</a><br /></td></tr>
- <tr class="separator:ad772eb38a4759bd2704ffaaf88436fff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a562145222d8aa153ec360a75769d0c83"><td class="memItemLeft" align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a562145222d8aa153ec360a75769d0c83">flowControlEnabled</a></td></tr>
- <tr class="memdesc:a562145222d8aa153ec360a75769d0c83"><td class="mdescLeft"> </td><td class="mdescRight">Enable flow control of a gRPC call. <a href="interface_g_r_p_c_call_options.html#a562145222d8aa153ec360a75769d0c83">More...</a><br /></td></tr>
- <tr class="separator:a562145222d8aa153ec360a75769d0c83"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a227885e226ea89ad173f539b81e921e4"><td class="memItemLeft" align="right" valign="top">NSArray< id< <a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html">GRPCInterceptorFactory</a> > > * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a227885e226ea89ad173f539b81e921e4">interceptorFactories</a></td></tr>
- <tr class="memdesc:a227885e226ea89ad173f539b81e921e4"><td class="mdescLeft"> </td><td class="mdescRight">An array of interceptor factories. <a href="interface_g_r_p_c_call_options.html#a227885e226ea89ad173f539b81e921e4">More...</a><br /></td></tr>
- <tr class="separator:a227885e226ea89ad173f539b81e921e4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e4b368a7e2aa6d2bdc3bfbd5135f682"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a0e4b368a7e2aa6d2bdc3bfbd5135f682">oauth2AccessToken</a></td></tr>
- <tr class="memdesc:a0e4b368a7e2aa6d2bdc3bfbd5135f682"><td class="mdescLeft"> </td><td class="mdescRight">The OAuth2 access token string. <a href="interface_g_r_p_c_call_options.html#a0e4b368a7e2aa6d2bdc3bfbd5135f682">More...</a><br /></td></tr>
- <tr class="separator:a0e4b368a7e2aa6d2bdc3bfbd5135f682"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2aa5130b2af506268df213eda81c94d"><td class="memItemLeft" align="right" valign="top">id< <a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html">GRPCAuthorizationProtocol</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#ad2aa5130b2af506268df213eda81c94d">authTokenProvider</a></td></tr>
- <tr class="memdesc:ad2aa5130b2af506268df213eda81c94d"><td class="mdescLeft"> </td><td class="mdescRight">The interface to get the OAuth2 access token string. <a href="interface_g_r_p_c_call_options.html#ad2aa5130b2af506268df213eda81c94d">More...</a><br /></td></tr>
- <tr class="separator:ad2aa5130b2af506268df213eda81c94d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2ef8624337871abd6f55b8459de1531"><td class="memItemLeft" align="right" valign="top">NSDictionary * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#ad2ef8624337871abd6f55b8459de1531">initialMetadata</a></td></tr>
- <tr class="memdesc:ad2ef8624337871abd6f55b8459de1531"><td class="mdescLeft"> </td><td class="mdescRight">Initial metadata key-value pairs that should be included in the request. <a href="interface_g_r_p_c_call_options.html#ad2ef8624337871abd6f55b8459de1531">More...</a><br /></td></tr>
- <tr class="separator:ad2ef8624337871abd6f55b8459de1531"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b242934e525531f24bb6ef944b977ca"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a0b242934e525531f24bb6ef944b977ca">userAgentPrefix</a></td></tr>
- <tr class="memdesc:a0b242934e525531f24bb6ef944b977ca"><td class="mdescLeft"> </td><td class="mdescRight">Custom string that is prefixed to a request's user-agent header field before gRPC's internal user-agent string. <a href="interface_g_r_p_c_call_options.html#a0b242934e525531f24bb6ef944b977ca">More...</a><br /></td></tr>
- <tr class="separator:a0b242934e525531f24bb6ef944b977ca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adfc34b4132ebb80e45ef939380c2d669"><td class="memItemLeft" align="right" valign="top">NSUInteger </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#adfc34b4132ebb80e45ef939380c2d669">responseSizeLimit</a></td></tr>
- <tr class="memdesc:adfc34b4132ebb80e45ef939380c2d669"><td class="mdescLeft"> </td><td class="mdescRight">The size limit for the response received from server. <a href="interface_g_r_p_c_call_options.html#adfc34b4132ebb80e45ef939380c2d669">More...</a><br /></td></tr>
- <tr class="separator:adfc34b4132ebb80e45ef939380c2d669"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9bb06364dfe4fff623a57f80c8c13c56"><td class="memItemLeft" align="right" valign="top">GRPCCompressionAlgorithm </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a9bb06364dfe4fff623a57f80c8c13c56">compressionAlgorithm</a></td></tr>
- <tr class="memdesc:a9bb06364dfe4fff623a57f80c8c13c56"><td class="mdescLeft"> </td><td class="mdescRight">The compression algorithm to be used by the gRPC call. <a href="interface_g_r_p_c_call_options.html#a9bb06364dfe4fff623a57f80c8c13c56">More...</a><br /></td></tr>
- <tr class="separator:a9bb06364dfe4fff623a57f80c8c13c56"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5f8f4bbb48dab6d80d6117333e618c39"><td class="memItemLeft" align="right" valign="top">BOOL </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a5f8f4bbb48dab6d80d6117333e618c39">retryEnabled</a></td></tr>
- <tr class="memdesc:a5f8f4bbb48dab6d80d6117333e618c39"><td class="mdescLeft"> </td><td class="mdescRight">Enable/Disable gRPC call's retry feature. <a href="interface_g_r_p_c_call_options.html#a5f8f4bbb48dab6d80d6117333e618c39">More...</a><br /></td></tr>
- <tr class="separator:a5f8f4bbb48dab6d80d6117333e618c39"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a28c443631bf8c35ed130b6b3d09ccb32"><td class="memItemLeft" align="right" valign="top">NSTimeInterval </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a28c443631bf8c35ed130b6b3d09ccb32">keepaliveInterval</a></td></tr>
- <tr class="separator:a28c443631bf8c35ed130b6b3d09ccb32"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa0717bcb368a2618f057ae9a2a4d75fb"><td class="memItemLeft" align="right" valign="top">NSTimeInterval </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#aa0717bcb368a2618f057ae9a2a4d75fb">keepaliveTimeout</a></td></tr>
- <tr class="separator:aa0717bcb368a2618f057ae9a2a4d75fb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aec5232b6202b6bcaf5015497c5f16a64"><td class="memItemLeft" align="right" valign="top">NSTimeInterval </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#aec5232b6202b6bcaf5015497c5f16a64">connectMinTimeout</a></td></tr>
- <tr class="separator:aec5232b6202b6bcaf5015497c5f16a64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1281bfee83a60b3294d15e47b7ab4181"><td class="memItemLeft" align="right" valign="top">NSTimeInterval </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a1281bfee83a60b3294d15e47b7ab4181">connectInitialBackoff</a></td></tr>
- <tr class="separator:a1281bfee83a60b3294d15e47b7ab4181"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a18221a069dc28cbfd0952e6ddaffdcad"><td class="memItemLeft" align="right" valign="top">NSTimeInterval </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a18221a069dc28cbfd0952e6ddaffdcad">connectMaxBackoff</a></td></tr>
- <tr class="separator:a18221a069dc28cbfd0952e6ddaffdcad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acaae6c45c2b8e14f70641fd420c26348"><td class="memItemLeft" align="right" valign="top">NSDictionary * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#acaae6c45c2b8e14f70641fd420c26348">additionalChannelArgs</a></td></tr>
- <tr class="memdesc:acaae6c45c2b8e14f70641fd420c26348"><td class="mdescLeft"> </td><td class="mdescRight">Specify channel args to be used for this call. <a href="interface_g_r_p_c_call_options.html#acaae6c45c2b8e14f70641fd420c26348">More...</a><br /></td></tr>
- <tr class="separator:acaae6c45c2b8e14f70641fd420c26348"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a76406ede45d7edc906ea5c6b2456825f"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a76406ede45d7edc906ea5c6b2456825f">PEMRootCertificates</a></td></tr>
- <tr class="memdesc:a76406ede45d7edc906ea5c6b2456825f"><td class="mdescLeft"> </td><td class="mdescRight">PEM format root certifications that is trusted. <a href="interface_g_r_p_c_call_options.html#a76406ede45d7edc906ea5c6b2456825f">More...</a><br /></td></tr>
- <tr class="separator:a76406ede45d7edc906ea5c6b2456825f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae62a83a8eaee16969d3b6a260f0232f6"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#ae62a83a8eaee16969d3b6a260f0232f6">PEMPrivateKey</a></td></tr>
- <tr class="memdesc:ae62a83a8eaee16969d3b6a260f0232f6"><td class="mdescLeft"> </td><td class="mdescRight">PEM format private key for client authentication, if required by the server. <a href="interface_g_r_p_c_call_options.html#ae62a83a8eaee16969d3b6a260f0232f6">More...</a><br /></td></tr>
- <tr class="separator:ae62a83a8eaee16969d3b6a260f0232f6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a366ef2da494a1775ad8086b66f88f46e"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a366ef2da494a1775ad8086b66f88f46e">PEMCertificateChain</a></td></tr>
- <tr class="memdesc:a366ef2da494a1775ad8086b66f88f46e"><td class="mdescLeft"> </td><td class="mdescRight">PEM format certificate chain for client authentication, if required by the server. <a href="interface_g_r_p_c_call_options.html#a366ef2da494a1775ad8086b66f88f46e">More...</a><br /></td></tr>
- <tr class="separator:a366ef2da494a1775ad8086b66f88f46e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac38248d60740e74c9c94be5b84c63736"><td class="memItemLeft" align="right" valign="top">GRPCTransportType </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#ac38248d60740e74c9c94be5b84c63736">transportType</a></td></tr>
- <tr class="memdesc:ac38248d60740e74c9c94be5b84c63736"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated: this option is deprecated. <a href="interface_g_r_p_c_call_options.html#ac38248d60740e74c9c94be5b84c63736">More...</a><br /></td></tr>
- <tr class="separator:ac38248d60740e74c9c94be5b84c63736"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f0320b2b930914466e58f32fcc84cc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a3f0320b2b930914466e58f32fcc84cc1">transport</a></td></tr>
- <tr class="memdesc:a3f0320b2b930914466e58f32fcc84cc1"><td class="mdescLeft"> </td><td class="mdescRight">The transport to be used for this call. <a href="interface_g_r_p_c_call_options.html#a3f0320b2b930914466e58f32fcc84cc1">More...</a><br /></td></tr>
- <tr class="separator:a3f0320b2b930914466e58f32fcc84cc1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a46711bd09bd8f039628cc7e10deaf910"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a46711bd09bd8f039628cc7e10deaf910">hostNameOverride</a></td></tr>
- <tr class="memdesc:a46711bd09bd8f039628cc7e10deaf910"><td class="mdescLeft"> </td><td class="mdescRight">Override the hostname during the TLS hostname validation process. <a href="interface_g_r_p_c_call_options.html#a46711bd09bd8f039628cc7e10deaf910">More...</a><br /></td></tr>
- <tr class="separator:a46711bd09bd8f039628cc7e10deaf910"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af24068f28e9b38a8b84e063e20fad1a6"><td class="memItemLeft" align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#af24068f28e9b38a8b84e063e20fad1a6">channelPoolDomain</a></td></tr>
- <tr class="memdesc:af24068f28e9b38a8b84e063e20fad1a6"><td class="mdescLeft"> </td><td class="mdescRight">A string that specify the domain where channel is being cached. <a href="interface_g_r_p_c_call_options.html#af24068f28e9b38a8b84e063e20fad1a6">More...</a><br /></td></tr>
- <tr class="separator:af24068f28e9b38a8b84e063e20fad1a6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0f15cca69804310c31142e9ad241418"><td class="memItemLeft" align="right" valign="top">NSUInteger </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#af0f15cca69804310c31142e9ad241418">channelID</a></td></tr>
- <tr class="memdesc:af0f15cca69804310c31142e9ad241418"><td class="mdescLeft"> </td><td class="mdescRight">Channel id allows control of channel caching within a channelPoolDomain. <a href="interface_g_r_p_c_call_options.html#af0f15cca69804310c31142e9ad241418">More...</a><br /></td></tr>
- <tr class="separator:af0f15cca69804310c31142e9ad241418"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a337151c941a8fcf367939acd8a21dadc"><td class="memItemLeft" align="right" valign="top">NSUInteger </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_g_r_p_c_call_options.html#a337151c941a8fcf367939acd8a21dadc">channelOptionsHash</a></td></tr>
- <tr class="memdesc:a337151c941a8fcf367939acd8a21dadc"><td class="mdescLeft"> </td><td class="mdescRight">Hash for channel options. <a href="interface_g_r_p_c_call_options.html#a337151c941a8fcf367939acd8a21dadc">More...</a><br /></td></tr>
- <tr class="separator:a337151c941a8fcf367939acd8a21dadc"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Immutable user configurable options for a gRPC call. </p>
- </div><h2 class="groupheader">Method Documentation</h2>
- <a id="a5ae8dd4e3119e8940a5b8ecccd6b0c81"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5ae8dd4e3119e8940a5b8ecccd6b0c81">◆ </a></span>hasChannelOptionsEqualTo:</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">- (BOOL) hasChannelOptionsEqualTo: </td>
- <td></td>
- <td class="paramtype">(<a class="el" href="interface_g_r_p_c_call_options.html">GRPCCallOptions</a> *) </td>
- <td class="paramname"><em>callOptions</em></td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return if the channel options are equal to another object. </p>
- </div>
- </div>
- <h2 class="groupheader">Property Documentation</h2>
- <a id="acaae6c45c2b8e14f70641fd420c26348"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acaae6c45c2b8e14f70641fd420c26348">◆ </a></span>additionalChannelArgs</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSDictionary*) additionalChannelArgs</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Specify channel args to be used for this call. </p>
- <p>For a list of channel args available, see grpc/grpc_types.h </p>
- </div>
- </div>
- <a id="ad2aa5130b2af506268df213eda81c94d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad2aa5130b2af506268df213eda81c94d">◆ </a></span>authTokenProvider</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (id<<a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html">GRPCAuthorizationProtocol</a>>) authTokenProvider</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The interface to get the OAuth2 access token string. </p>
- <p>gRPC will attempt to acquire token when initiating the call. This parameter should not be used simultaneously with <em>oauth2AccessToken</em>. </p>
- </div>
- </div>
- <a id="af0f15cca69804310c31142e9ad241418"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af0f15cca69804310c31142e9ad241418">◆ </a></span>channelID</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSUInteger) channelID</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Channel id allows control of channel caching within a channelPoolDomain. </p>
- <p>A call with a unique channelID will create a new channel (connection) instead of reusing an existing one. Multiple calls in the same channelPoolDomain using identical channelID are allowed to share connection if other channel options are also the same. </p>
- </div>
- </div>
- <a id="a337151c941a8fcf367939acd8a21dadc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a337151c941a8fcf367939acd8a21dadc">◆ </a></span>channelOptionsHash</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSUInteger) channelOptionsHash</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Hash for channel options. </p>
- </div>
- </div>
- <a id="af24068f28e9b38a8b84e063e20fad1a6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af24068f28e9b38a8b84e063e20fad1a6">◆ </a></span>channelPoolDomain</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) channelPoolDomain</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>A string that specify the domain where channel is being cached. </p>
- <p>Channels with different domains will not get cached to the same connection. </p>
- </div>
- </div>
- <a id="a9bb06364dfe4fff623a57f80c8c13c56"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9bb06364dfe4fff623a57f80c8c13c56">◆ </a></span>compressionAlgorithm</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (GRPCCompressionAlgorithm) compressionAlgorithm</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The compression algorithm to be used by the gRPC call. </p>
- <p>For more details refer to <a href="https://github.com/grpc/grpc/blob/master/doc/compression.md">https://github.com/grpc/grpc/blob/master/doc/compression.md</a> </p>
- </div>
- </div>
- <a id="a1281bfee83a60b3294d15e47b7ab4181"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1281bfee83a60b3294d15e47b7ab4181">◆ </a></span>connectInitialBackoff</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSTimeInterval) connectInitialBackoff</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a18221a069dc28cbfd0952e6ddaffdcad"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a18221a069dc28cbfd0952e6ddaffdcad">◆ </a></span>connectMaxBackoff</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSTimeInterval) connectMaxBackoff</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aec5232b6202b6bcaf5015497c5f16a64"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aec5232b6202b6bcaf5015497c5f16a64">◆ </a></span>connectMinTimeout</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSTimeInterval) connectMinTimeout</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a562145222d8aa153ec360a75769d0c83"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a562145222d8aa153ec360a75769d0c83">◆ </a></span>flowControlEnabled</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (BOOL) flowControlEnabled</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enable flow control of a gRPC call. </p>
- <p>The option is default to NO. If set to YES, writeData: method should only be called at most once before a didWriteData callback is issued, and receiveNextMessage: must be called each time before gRPC call issues a didReceiveMessage callback. </p>
- </div>
- </div>
- <a id="a46711bd09bd8f039628cc7e10deaf910"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a46711bd09bd8f039628cc7e10deaf910">◆ </a></span>hostNameOverride</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) hostNameOverride</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Override the hostname during the TLS hostname validation process. </p>
- </div>
- </div>
- <a id="ad2ef8624337871abd6f55b8459de1531"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad2ef8624337871abd6f55b8459de1531">◆ </a></span>initialMetadata</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSDictionary*) initialMetadata</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Initial metadata key-value pairs that should be included in the request. </p>
- </div>
- </div>
- <a id="a227885e226ea89ad173f539b81e921e4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a227885e226ea89ad173f539b81e921e4">◆ </a></span>interceptorFactories</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSArray<id<<a class="el" href="protocol_g_r_p_c_interceptor_factory-p.html">GRPCInterceptorFactory</a>> >*) interceptorFactories</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>An array of interceptor factories. </p>
- <p>When a call starts, interceptors are created by these factories and chained together with the same order as the factories in this array. This parameter should not be modified by any interceptor and will not take effect if done so. </p>
- </div>
- </div>
- <a id="a28c443631bf8c35ed130b6b3d09ccb32"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a28c443631bf8c35ed130b6b3d09ccb32">◆ </a></span>keepaliveInterval</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSTimeInterval) keepaliveInterval</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa0717bcb368a2618f057ae9a2a4d75fb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa0717bcb368a2618f057ae9a2a4d75fb">◆ </a></span>keepaliveTimeout</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSTimeInterval) keepaliveTimeout</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0e4b368a7e2aa6d2bdc3bfbd5135f682"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e4b368a7e2aa6d2bdc3bfbd5135f682">◆ </a></span>oauth2AccessToken</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) oauth2AccessToken</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The OAuth2 access token string. </p>
- <p>The string is prefixed with "Bearer " then used as value of the request's "authorization" header field. This parameter should not be used simultaneously with <em>authTokenProvider</em>. </p>
- </div>
- </div>
- <a id="a366ef2da494a1775ad8086b66f88f46e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a366ef2da494a1775ad8086b66f88f46e">◆ </a></span>PEMCertificateChain</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) PEMCertificateChain</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>PEM format certificate chain for client authentication, if required by the server. </p>
- </div>
- </div>
- <a id="ae62a83a8eaee16969d3b6a260f0232f6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae62a83a8eaee16969d3b6a260f0232f6">◆ </a></span>PEMPrivateKey</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) PEMPrivateKey</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>PEM format private key for client authentication, if required by the server. </p>
- </div>
- </div>
- <a id="a76406ede45d7edc906ea5c6b2456825f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a76406ede45d7edc906ea5c6b2456825f">◆ </a></span>PEMRootCertificates</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) PEMRootCertificates</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>PEM format root certifications that is trusted. </p>
- <p>If set to nil, gRPC uses a list of default root certificates. </p>
- </div>
- </div>
- <a id="adfc34b4132ebb80e45ef939380c2d669"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adfc34b4132ebb80e45ef939380c2d669">◆ </a></span>responseSizeLimit</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSUInteger) responseSizeLimit</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The size limit for the response received from server. </p>
- <p>If it is exceeded, an error with status code GRPCErrorCodeResourceExhausted is returned. </p>
- </div>
- </div>
- <a id="a5f8f4bbb48dab6d80d6117333e618c39"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5f8f4bbb48dab6d80d6117333e618c39">◆ </a></span>retryEnabled</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (BOOL) retryEnabled</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enable/Disable gRPC call's retry feature. </p>
- <p>The default is enabled. For details of this feature refer to <a href="https://github.com/grpc/proposal/blob/master/A6-client-retries.md">https://github.com/grpc/proposal/blob/master/A6-client-retries.md</a> </p>
- </div>
- </div>
- <a id="a8414f883f2319f6e912ea6eace1799a8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8414f883f2319f6e912ea6eace1799a8">◆ </a></span>serverAuthority</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) serverAuthority</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The authority for the RPC. </p>
- <p>If nil, the default authority will be used.</p>
- <p>Note: This property does not have effect on Cronet transport and will be ignored. Note: This property cannot be used to validate a self-signed server certificate. It control the :authority header field of the call and performs an extra check that server's certificate matches the :authority header. </p>
- </div>
- </div>
- <a id="ad772eb38a4759bd2704ffaaf88436fff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad772eb38a4759bd2704ffaaf88436fff">◆ </a></span>timeout</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSTimeInterval) timeout</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The timeout for the RPC call in seconds. </p>
- <p>If set to 0, the call will not timeout. If set to positive, the gRPC call returns with status GRPCErrorCodeDeadlineExceeded if it is not completed within <em>timeout</em> seconds. A negative value is not allowed. </p>
- </div>
- </div>
- <a id="a3f0320b2b930914466e58f32fcc84cc1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3f0320b2b930914466e58f32fcc84cc1">◆ </a></span>transport</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (<a class="el" href="_g_r_p_c_types_8h.html#a1cf875c3f6d8737657907e38b468d05f">GRPCTransportID</a>) transport</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The transport to be used for this call. </p>
- <p>Users may choose a native transport identifier defined in <em><a class="el" href="interface_g_r_p_c_transport.html" title="Base class for transport implementations.">GRPCTransport</a></em> or provided by a non-native transport implementation. If the option is left to be NULL, gRPC will use its default transport.</p>
- <p>This is currently an experimental option. </p>
- </div>
- </div>
- <a id="ac38248d60740e74c9c94be5b84c63736"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac38248d60740e74c9c94be5b84c63736">◆ </a></span>transportType</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (GRPCTransportType) transportType</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">assign</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Deprecated: this option is deprecated. </p>
- <p>Please use the property <em>transport</em> instead.</p>
- <p>Select the transport type to be used for this call. </p>
- </div>
- </div>
- <a id="a0b242934e525531f24bb6ef944b977ca"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0b242934e525531f24bb6ef944b977ca">◆ </a></span>userAgentPrefix</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">- (NSString*) userAgentPrefix</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">read</span><span class="mlabel">atomic</span><span class="mlabel">copy</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Custom string that is prefixed to a request's user-agent header field before gRPC's internal user-agent string. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_call_options_8h_source.html">GRPCCallOptions.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|