123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682 |
- <!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 C++: grpc::ChannelArguments 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 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 id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ChannelArguments Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Options for channel creation.
- <a href="classgrpc_1_1_channel_arguments.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2support_2channel__arguments_8h_source.html">channel_arguments.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aecabf1ea1c78a3202544571cf857e8eb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#aecabf1ea1c78a3202544571cf857e8eb">ChannelArguments</a> ()</td></tr>
- <tr class="separator:aecabf1ea1c78a3202544571cf857e8eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8058adf243855c3a44030c23ccec05ad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a8058adf243855c3a44030c23ccec05ad">~ChannelArguments</a> ()</td></tr>
- <tr class="separator:a8058adf243855c3a44030c23ccec05ad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ade11dfb5cac0e1da5e9ed5e86c18c4fe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ade11dfb5cac0e1da5e9ed5e86c18c4fe">ChannelArguments</a> (const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &other)</td></tr>
- <tr class="separator:ade11dfb5cac0e1da5e9ed5e86c18c4fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac75ba90de32a5c7f3cb6c62f7ce649be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ac75ba90de32a5c7f3cb6c62f7ce649be">operator=</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> other)</td></tr>
- <tr class="separator:ac75ba90de32a5c7f3cb6c62f7ce649be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3ff4f22c2cf31c01885b2aaefbdd227d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a3ff4f22c2cf31c01885b2aaefbdd227d">Swap</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &other)</td></tr>
- <tr class="separator:a3ff4f22c2cf31c01885b2aaefbdd227d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ada3b48824deebdc38bc173701ad10e35"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ada3b48824deebdc38bc173701ad10e35">SetChannelArgs</a> (<a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *channel_args) const</td></tr>
- <tr class="memdesc:ada3b48824deebdc38bc173701ad10e35"><td class="mdescLeft"> </td><td class="mdescRight">Dump arguments in this instance to <em>channel_args</em>. <a href="classgrpc_1_1_channel_arguments.html#ada3b48824deebdc38bc173701ad10e35">More...</a><br /></td></tr>
- <tr class="separator:ada3b48824deebdc38bc173701ad10e35"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a42313e3360b50c354c68572e7bf5bccb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a42313e3360b50c354c68572e7bf5bccb">SetSslTargetNameOverride</a> (const std::string &name)</td></tr>
- <tr class="memdesc:a42313e3360b50c354c68572e7bf5bccb"><td class="mdescLeft"> </td><td class="mdescRight">Set target name override for SSL host name checking. <a href="classgrpc_1_1_channel_arguments.html#a42313e3360b50c354c68572e7bf5bccb">More...</a><br /></td></tr>
- <tr class="separator:a42313e3360b50c354c68572e7bf5bccb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf332071bbdff5e4a7f3352f4ad564d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#aaf332071bbdff5e4a7f3352f4ad564d5">SetCompressionAlgorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
- <tr class="memdesc:aaf332071bbdff5e4a7f3352f4ad564d5"><td class="mdescLeft"> </td><td class="mdescRight">Set the compression algorithm for the channel. <a href="classgrpc_1_1_channel_arguments.html#aaf332071bbdff5e4a7f3352f4ad564d5">More...</a><br /></td></tr>
- <tr class="separator:aaf332071bbdff5e4a7f3352f4ad564d5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a34014343bd52a0ed7289a9f8b203d9d1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a34014343bd52a0ed7289a9f8b203d9d1">SetGrpclbFallbackTimeout</a> (int fallback_timeout)</td></tr>
- <tr class="memdesc:a34014343bd52a0ed7289a9f8b203d9d1"><td class="mdescLeft"> </td><td class="mdescRight">Set the grpclb fallback timeout (in ms) for the channel. <a href="classgrpc_1_1_channel_arguments.html#a34014343bd52a0ed7289a9f8b203d9d1">More...</a><br /></td></tr>
- <tr class="separator:a34014343bd52a0ed7289a9f8b203d9d1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a520690f499be85159a20200ddb986a96"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a520690f499be85159a20200ddb986a96">SetSocketMutator</a> (<a class="el" href="grpc__types_8h.html#a72c4781284bb0c964d281e6e46cf4a90">grpc_socket_mutator</a> *mutator)</td></tr>
- <tr class="memdesc:a520690f499be85159a20200ddb986a96"><td class="mdescLeft"> </td><td class="mdescRight">For client channel's, the socket mutator operates on "channel" sockets. <a href="classgrpc_1_1_channel_arguments.html#a520690f499be85159a20200ddb986a96">More...</a><br /></td></tr>
- <tr class="separator:a520690f499be85159a20200ddb986a96"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a86e18071dd5af0880dc86f9305eefe0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a86e18071dd5af0880dc86f9305eefe0a">SetUserAgentPrefix</a> (const std::string &user_agent_prefix)</td></tr>
- <tr class="memdesc:a86e18071dd5af0880dc86f9305eefe0a"><td class="mdescLeft"> </td><td class="mdescRight">Set the string to prepend to the user agent. <a href="classgrpc_1_1_channel_arguments.html#a86e18071dd5af0880dc86f9305eefe0a">More...</a><br /></td></tr>
- <tr class="separator:a86e18071dd5af0880dc86f9305eefe0a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8ccf6088c76cefb188c8d4b0ad353cc0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a8ccf6088c76cefb188c8d4b0ad353cc0">SetResourceQuota</a> (const <a class="el" href="classgrpc_1_1_resource_quota.html">grpc::ResourceQuota</a> &resource_quota)</td></tr>
- <tr class="memdesc:a8ccf6088c76cefb188c8d4b0ad353cc0"><td class="mdescLeft"> </td><td class="mdescRight">Set the buffer pool to be attached to the constructed channel. <a href="classgrpc_1_1_channel_arguments.html#a8ccf6088c76cefb188c8d4b0ad353cc0">More...</a><br /></td></tr>
- <tr class="separator:a8ccf6088c76cefb188c8d4b0ad353cc0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2629f85664dd2822fe54059c4730baf8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a2629f85664dd2822fe54059c4730baf8">SetMaxReceiveMessageSize</a> (int size)</td></tr>
- <tr class="memdesc:a2629f85664dd2822fe54059c4730baf8"><td class="mdescLeft"> </td><td class="mdescRight">Set the max receive and send message sizes. <a href="classgrpc_1_1_channel_arguments.html#a2629f85664dd2822fe54059c4730baf8">More...</a><br /></td></tr>
- <tr class="separator:a2629f85664dd2822fe54059c4730baf8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac1fa513191e8104ec57dfd6598297ce5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ac1fa513191e8104ec57dfd6598297ce5">SetMaxSendMessageSize</a> (int size)</td></tr>
- <tr class="separator:ac1fa513191e8104ec57dfd6598297ce5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acaa6e36346e2fef8833e2f53fd289cf2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#acaa6e36346e2fef8833e2f53fd289cf2">SetLoadBalancingPolicyName</a> (const std::string &lb_policy_name)</td></tr>
- <tr class="memdesc:acaa6e36346e2fef8833e2f53fd289cf2"><td class="mdescLeft"> </td><td class="mdescRight">Set LB policy name. <a href="classgrpc_1_1_channel_arguments.html#acaa6e36346e2fef8833e2f53fd289cf2">More...</a><br /></td></tr>
- <tr class="separator:acaa6e36346e2fef8833e2f53fd289cf2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae9399219c13808b45f3acad088fb0981"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ae9399219c13808b45f3acad088fb0981">SetServiceConfigJSON</a> (const std::string &service_config_json)</td></tr>
- <tr class="memdesc:ae9399219c13808b45f3acad088fb0981"><td class="mdescLeft"> </td><td class="mdescRight">Set service config in JSON form. <a href="classgrpc_1_1_channel_arguments.html#ae9399219c13808b45f3acad088fb0981">More...</a><br /></td></tr>
- <tr class="separator:ae9399219c13808b45f3acad088fb0981"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a95551b0d103d8e2527669aa0744fddcc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a95551b0d103d8e2527669aa0744fddcc">SetInt</a> (const std::string &key, int value)</td></tr>
- <tr class="memdesc:a95551b0d103d8e2527669aa0744fddcc"><td class="mdescLeft"> </td><td class="mdescRight">Set an integer argument <em>value</em> under <em>key</em>. <a href="classgrpc_1_1_channel_arguments.html#a95551b0d103d8e2527669aa0744fddcc">More...</a><br /></td></tr>
- <tr class="separator:a95551b0d103d8e2527669aa0744fddcc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4d0542a29349a1d6345d2278f117adfa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a4d0542a29349a1d6345d2278f117adfa">SetPointer</a> (const std::string &key, void *value)</td></tr>
- <tr class="memdesc:a4d0542a29349a1d6345d2278f117adfa"><td class="mdescLeft"> </td><td class="mdescRight">Set a pointer argument <em>value</em> under <em>key</em>. Owership is not transferred. <a href="classgrpc_1_1_channel_arguments.html#a4d0542a29349a1d6345d2278f117adfa">More...</a><br /></td></tr>
- <tr class="separator:a4d0542a29349a1d6345d2278f117adfa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af8f0632b49b4e281f9f11fcfdda9c446"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#af8f0632b49b4e281f9f11fcfdda9c446">SetPointerWithVtable</a> (const std::string &key, void *value, const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a> *vtable)</td></tr>
- <tr class="separator:af8f0632b49b4e281f9f11fcfdda9c446"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af353198d69aa6e9c04f3451f848d5ae7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#af353198d69aa6e9c04f3451f848d5ae7">SetString</a> (const std::string &key, const std::string &value)</td></tr>
- <tr class="memdesc:af353198d69aa6e9c04f3451f848d5ae7"><td class="mdescLeft"> </td><td class="mdescRight">Set a textual argument <em>value</em> under <em>key</em>. <a href="classgrpc_1_1_channel_arguments.html#af353198d69aa6e9c04f3451f848d5ae7">More...</a><br /></td></tr>
- <tr class="separator:af353198d69aa6e9c04f3451f848d5ae7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aef26c9943c9f19c63b2c8e4023096d5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#aef26c9943c9f19c63b2c8e4023096d5e">c_channel_args</a> () const</td></tr>
- <tr class="memdesc:aef26c9943c9f19c63b2c8e4023096d5e"><td class="mdescLeft"> </td><td class="mdescRight">Return (by value) a C <em><a class="el" href="structgrpc__channel__args.html" title="An array of arguments that can be passed around.">grpc_channel_args</a></em> structure which points to arguments owned by this <em><a class="el" href="classgrpc_1_1_channel_arguments.html" title="Options for channel creation.">ChannelArguments</a></em> instance. <a href="classgrpc_1_1_channel_arguments.html#aef26c9943c9f19c63b2c8e4023096d5e">More...</a><br /></td></tr>
- <tr class="separator:aef26c9943c9f19c63b2c8e4023096d5e"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a37da22b0dddc749b10ff04deab4f5481"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a37da22b0dddc749b10ff04deab4f5481">grpc::SecureChannelCredentials</a></td></tr>
- <tr class="separator:a37da22b0dddc749b10ff04deab4f5481"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a418577e16bfe952f5c7af804255eccd1"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a418577e16bfe952f5c7af804255eccd1">grpc::testing::ChannelArgumentsTest</a></td></tr>
- <tr class="separator:a418577e16bfe952f5c7af804255eccd1"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Options for channel creation. </p>
- <p>The user can use generic setters to pass key value pairs down to C channel creation code. For gRPC related options, concrete setters are provided. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="aecabf1ea1c78a3202544571cf857e8eb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aecabf1ea1c78a3202544571cf857e8eb">◆ </a></span>ChannelArguments() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ChannelArguments::ChannelArguments </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8058adf243855c3a44030c23ccec05ad"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8058adf243855c3a44030c23ccec05ad">◆ </a></span>~ChannelArguments()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ChannelArguments::~ChannelArguments </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ade11dfb5cac0e1da5e9ed5e86c18c4fe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ade11dfb5cac0e1da5e9ed5e86c18c4fe">◆ </a></span>ChannelArguments() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc::ChannelArguments::ChannelArguments </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="aef26c9943c9f19c63b2c8e4023096d5e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aef26c9943c9f19c63b2c8e4023096d5e">◆ </a></span>c_channel_args()</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="structgrpc__channel__args.html">grpc_channel_args</a> grpc::ChannelArguments::c_channel_args </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return (by value) a C <em><a class="el" href="structgrpc__channel__args.html" title="An array of arguments that can be passed around.">grpc_channel_args</a></em> structure which points to arguments owned by this <em><a class="el" href="classgrpc_1_1_channel_arguments.html" title="Options for channel creation.">ChannelArguments</a></em> instance. </p>
- </div>
- </div>
- <a id="ac75ba90de32a5c7f3cb6c62f7ce649be"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac75ba90de32a5c7f3cb6c62f7ce649be">◆ </a></span>operator=()</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="classgrpc_1_1_channel_arguments.html">ChannelArguments</a>& grpc::ChannelArguments::operator= </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ada3b48824deebdc38bc173701ad10e35"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ada3b48824deebdc38bc173701ad10e35">◆ </a></span>SetChannelArgs()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetChannelArgs </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> * </td>
- <td class="paramname"><em>channel_args</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Dump arguments in this instance to <em>channel_args</em>. </p>
- <p>Does not take ownership of <em>channel_args</em>.</p>
- <p>Note that the underlying arguments are shared. Changes made to either <em>channel_args</em> or this instance would be reflected on both. </p>
- </div>
- </div>
- <a id="aaf332071bbdff5e4a7f3352f4ad564d5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aaf332071bbdff5e4a7f3352f4ad564d5">◆ </a></span>SetCompressionAlgorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetCompressionAlgorithm </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td>
- <td class="paramname"><em>algorithm</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the compression algorithm for the channel. </p>
- </div>
- </div>
- <a id="a34014343bd52a0ed7289a9f8b203d9d1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a34014343bd52a0ed7289a9f8b203d9d1">◆ </a></span>SetGrpclbFallbackTimeout()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetGrpclbFallbackTimeout </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>fallback_timeout</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the grpclb fallback timeout (in ms) for the channel. </p>
- <p>If this amount of time has passed but we have not gotten any non-empty <em>serverlist</em> from the balancer, we will fall back to use the backend address(es) returned by the resolver. </p>
- </div>
- </div>
- <a id="a95551b0d103d8e2527669aa0744fddcc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a95551b0d103d8e2527669aa0744fddcc">◆ </a></span>SetInt()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetInt </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set an integer argument <em>value</em> under <em>key</em>. </p>
- </div>
- </div>
- <a id="acaa6e36346e2fef8833e2f53fd289cf2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acaa6e36346e2fef8833e2f53fd289cf2">◆ </a></span>SetLoadBalancingPolicyName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetLoadBalancingPolicyName </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>lb_policy_name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set LB policy name. </p>
- <p>Note that if the name resolver returns only balancer addresses, the grpclb LB policy will be used, regardless of what is specified here. </p>
- </div>
- </div>
- <a id="a2629f85664dd2822fe54059c4730baf8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2629f85664dd2822fe54059c4730baf8">◆ </a></span>SetMaxReceiveMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetMaxReceiveMessageSize </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the max receive and send message sizes. </p>
- </div>
- </div>
- <a id="ac1fa513191e8104ec57dfd6598297ce5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac1fa513191e8104ec57dfd6598297ce5">◆ </a></span>SetMaxSendMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetMaxSendMessageSize </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4d0542a29349a1d6345d2278f117adfa"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4d0542a29349a1d6345d2278f117adfa">◆ </a></span>SetPointer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetPointer </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set a pointer argument <em>value</em> under <em>key</em>. Owership is not transferred. </p>
- </div>
- </div>
- <a id="af8f0632b49b4e281f9f11fcfdda9c446"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af8f0632b49b4e281f9f11fcfdda9c446">◆ </a></span>SetPointerWithVtable()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetPointerWithVtable </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a> * </td>
- <td class="paramname"><em>vtable</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8ccf6088c76cefb188c8d4b0ad353cc0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8ccf6088c76cefb188c8d4b0ad353cc0">◆ </a></span>SetResourceQuota()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetResourceQuota </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgrpc_1_1_resource_quota.html">grpc::ResourceQuota</a> & </td>
- <td class="paramname"><em>resource_quota</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the buffer pool to be attached to the constructed channel. </p>
- </div>
- </div>
- <a id="ae9399219c13808b45f3acad088fb0981"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae9399219c13808b45f3acad088fb0981">◆ </a></span>SetServiceConfigJSON()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetServiceConfigJSON </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>service_config_json</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set service config in JSON form. </p>
- <p>Primarily meant for use in unit tests. </p>
- </div>
- </div>
- <a id="a520690f499be85159a20200ddb986a96"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a520690f499be85159a20200ddb986a96">◆ </a></span>SetSocketMutator()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetSocketMutator </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="grpc__types_8h.html#a72c4781284bb0c964d281e6e46cf4a90">grpc_socket_mutator</a> * </td>
- <td class="paramname"><em>mutator</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>For client channel's, the socket mutator operates on "channel" sockets. </p>
- <p>For server's, the socket mutator operates only on "listen" sockets. TODO(apolcyn): allow socket mutators to also operate on server "channel" sockets, and adjust the socket mutator object to be more speficic about which type of socket it should operate on. </p>
- </div>
- </div>
- <a id="a42313e3360b50c354c68572e7bf5bccb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a42313e3360b50c354c68572e7bf5bccb">◆ </a></span>SetSslTargetNameOverride()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetSslTargetNameOverride </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set target name override for SSL host name checking. </p>
- <p>This option should be used with caution in production. </p>
- </div>
- </div>
- <a id="af353198d69aa6e9c04f3451f848d5ae7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af353198d69aa6e9c04f3451f848d5ae7">◆ </a></span>SetString()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetString </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set a textual argument <em>value</em> under <em>key</em>. </p>
- </div>
- </div>
- <a id="a86e18071dd5af0880dc86f9305eefe0a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a86e18071dd5af0880dc86f9305eefe0a">◆ </a></span>SetUserAgentPrefix()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::SetUserAgentPrefix </td>
- <td>(</td>
- <td class="paramtype">const std::string & </td>
- <td class="paramname"><em>user_agent_prefix</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the string to prepend to the user agent. </p>
- </div>
- </div>
- <a id="a3ff4f22c2cf31c01885b2aaefbdd227d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3ff4f22c2cf31c01885b2aaefbdd227d">◆ </a></span>Swap()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelArguments::Swap </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="a37da22b0dddc749b10ff04deab4f5481"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a37da22b0dddc749b10ff04deab4f5481">◆ </a></span>grpc::SecureChannelCredentials</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class grpc::SecureChannelCredentials</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a418577e16bfe952f5c7af804255eccd1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a418577e16bfe952f5c7af804255eccd1">◆ </a></span>grpc::testing::ChannelArgumentsTest</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class grpc::testing::ChannelArgumentsTest</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/support/<a class="el" href="grpcpp_2support_2channel__arguments_8h_source.html">channel_arguments.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:17:24 for GRPC 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>
|