| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc_impl::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.23.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_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_impl::ChannelArguments Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Options for channel creation.
- <a href="classgrpc__impl_1_1_channel_arguments.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="channel__arguments__impl_8h_source.html">channel_arguments_impl.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:ae4fbf794a623d84b01bc0ec9e3800181"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#ae4fbf794a623d84b01bc0ec9e3800181">ChannelArguments</a> ()</td></tr>
- <tr class="separator:ae4fbf794a623d84b01bc0ec9e3800181"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a640198ff5723690573ead652f9ebf276"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a640198ff5723690573ead652f9ebf276">~ChannelArguments</a> ()</td></tr>
- <tr class="separator:a640198ff5723690573ead652f9ebf276"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6def99473bdeb2befe7f6aed82a807fc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a6def99473bdeb2befe7f6aed82a807fc">ChannelArguments</a> (const <a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a> &other)</td></tr>
- <tr class="separator:a6def99473bdeb2befe7f6aed82a807fc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac5e5bbbdd7a30689e40627554fbacd37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#ac5e5bbbdd7a30689e40627554fbacd37">operator=</a> (<a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a> other)</td></tr>
- <tr class="separator:ac5e5bbbdd7a30689e40627554fbacd37"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad8a88bae7db3b66eb7fd317d8c9798fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#ad8a88bae7db3b66eb7fd317d8c9798fe">Swap</a> (<a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a> &other)</td></tr>
- <tr class="separator:ad8a88bae7db3b66eb7fd317d8c9798fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a225a43b2e19605610edf25958d93d259"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a225a43b2e19605610edf25958d93d259">SetChannelArgs</a> (<a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *channel_args) const</td></tr>
- <tr class="memdesc:a225a43b2e19605610edf25958d93d259"><td class="mdescLeft"> </td><td class="mdescRight">Dump arguments in this instance to <em>channel_args</em>. <a href="#a225a43b2e19605610edf25958d93d259">More...</a><br /></td></tr>
- <tr class="separator:a225a43b2e19605610edf25958d93d259"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0d77f161b627cd2ae09c6c2dd4b5632e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a0d77f161b627cd2ae09c6c2dd4b5632e">SetSslTargetNameOverride</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &name)</td></tr>
- <tr class="memdesc:a0d77f161b627cd2ae09c6c2dd4b5632e"><td class="mdescLeft"> </td><td class="mdescRight">Set target name override for SSL host name checking. <a href="#a0d77f161b627cd2ae09c6c2dd4b5632e">More...</a><br /></td></tr>
- <tr class="separator:a0d77f161b627cd2ae09c6c2dd4b5632e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aae117a0bd085ee4e5f487a623f2a4bb1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#aae117a0bd085ee4e5f487a623f2a4bb1">SetCompressionAlgorithm</a> (<a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
- <tr class="memdesc:aae117a0bd085ee4e5f487a623f2a4bb1"><td class="mdescLeft"> </td><td class="mdescRight">Set the compression algorithm for the channel. <a href="#aae117a0bd085ee4e5f487a623f2a4bb1">More...</a><br /></td></tr>
- <tr class="separator:aae117a0bd085ee4e5f487a623f2a4bb1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4094dba493f52af4b5ca70781f1b35f3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a4094dba493f52af4b5ca70781f1b35f3">SetGrpclbFallbackTimeout</a> (int fallback_timeout)</td></tr>
- <tr class="memdesc:a4094dba493f52af4b5ca70781f1b35f3"><td class="mdescLeft"> </td><td class="mdescRight">Set the grpclb fallback timeout (in ms) for the channel. <a href="#a4094dba493f52af4b5ca70781f1b35f3">More...</a><br /></td></tr>
- <tr class="separator:a4094dba493f52af4b5ca70781f1b35f3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5f0b6402d56c1a6be6e0664e27c0b645"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a5f0b6402d56c1a6be6e0664e27c0b645">SetSocketMutator</a> (<a class="el" href="grpc__types_8h.html#a72c4781284bb0c964d281e6e46cf4a90">grpc_socket_mutator</a> *mutator)</td></tr>
- <tr class="memdesc:a5f0b6402d56c1a6be6e0664e27c0b645"><td class="mdescLeft"> </td><td class="mdescRight">For client channel's, the socket mutator operates on "channel" sockets. <a href="#a5f0b6402d56c1a6be6e0664e27c0b645">More...</a><br /></td></tr>
- <tr class="separator:a5f0b6402d56c1a6be6e0664e27c0b645"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a73d350f842b3a8c556813661f8dbd440"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a73d350f842b3a8c556813661f8dbd440">SetUserAgentPrefix</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &user_agent_prefix)</td></tr>
- <tr class="memdesc:a73d350f842b3a8c556813661f8dbd440"><td class="mdescLeft"> </td><td class="mdescRight">Set the string to prepend to the user agent. <a href="#a73d350f842b3a8c556813661f8dbd440">More...</a><br /></td></tr>
- <tr class="separator:a73d350f842b3a8c556813661f8dbd440"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a683fb55ed71a8ae236a59594644d7900"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a683fb55ed71a8ae236a59594644d7900">SetResourceQuota</a> (const <a class="el" href="namespacegrpc.html#ac65c9e53fcc2796ff3033e626e1a5e4b">grpc::ResourceQuota</a> &resource_quota)</td></tr>
- <tr class="memdesc:a683fb55ed71a8ae236a59594644d7900"><td class="mdescLeft"> </td><td class="mdescRight">Set the buffer pool to be attached to the constructed channel. <a href="#a683fb55ed71a8ae236a59594644d7900">More...</a><br /></td></tr>
- <tr class="separator:a683fb55ed71a8ae236a59594644d7900"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7c1925ff9011549cc23e5b16412170f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a7c1925ff9011549cc23e5b16412170f4">SetMaxReceiveMessageSize</a> (int size)</td></tr>
- <tr class="memdesc:a7c1925ff9011549cc23e5b16412170f4"><td class="mdescLeft"> </td><td class="mdescRight">Set the max receive and send message sizes. <a href="#a7c1925ff9011549cc23e5b16412170f4">More...</a><br /></td></tr>
- <tr class="separator:a7c1925ff9011549cc23e5b16412170f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9f8bd238599e6c7b7aae69647d974040"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a9f8bd238599e6c7b7aae69647d974040">SetMaxSendMessageSize</a> (int size)</td></tr>
- <tr class="separator:a9f8bd238599e6c7b7aae69647d974040"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a15048926f06c66f04c04fe7ca0a3592a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a15048926f06c66f04c04fe7ca0a3592a">SetLoadBalancingPolicyName</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &lb_policy_name)</td></tr>
- <tr class="memdesc:a15048926f06c66f04c04fe7ca0a3592a"><td class="mdescLeft"> </td><td class="mdescRight">Set LB policy name. <a href="#a15048926f06c66f04c04fe7ca0a3592a">More...</a><br /></td></tr>
- <tr class="separator:a15048926f06c66f04c04fe7ca0a3592a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a749ebe3180b4385b2b85bf6503d9bb8b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a749ebe3180b4385b2b85bf6503d9bb8b">SetServiceConfigJSON</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &service_config_json)</td></tr>
- <tr class="memdesc:a749ebe3180b4385b2b85bf6503d9bb8b"><td class="mdescLeft"> </td><td class="mdescRight">Set service config in JSON form. <a href="#a749ebe3180b4385b2b85bf6503d9bb8b">More...</a><br /></td></tr>
- <tr class="separator:a749ebe3180b4385b2b85bf6503d9bb8b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a64d9c1954afa24e4a7c01a97302c388e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a64d9c1954afa24e4a7c01a97302c388e">SetInt</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &key, int value)</td></tr>
- <tr class="memdesc:a64d9c1954afa24e4a7c01a97302c388e"><td class="mdescLeft"> </td><td class="mdescRight">Set an integer argument <em>value</em> under <em>key</em>. <a href="#a64d9c1954afa24e4a7c01a97302c388e">More...</a><br /></td></tr>
- <tr class="separator:a64d9c1954afa24e4a7c01a97302c388e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a9bc34b45daa0086427a133e167267f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a7a9bc34b45daa0086427a133e167267f">SetPointer</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &key, void *value)</td></tr>
- <tr class="memdesc:a7a9bc34b45daa0086427a133e167267f"><td class="mdescLeft"> </td><td class="mdescRight">Set a pointer argument <em>value</em> under <em>key</em>. Owership is not transferred. <a href="#a7a9bc34b45daa0086427a133e167267f">More...</a><br /></td></tr>
- <tr class="separator:a7a9bc34b45daa0086427a133e167267f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3812564396da1ee901912ae3704fa3e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a3812564396da1ee901912ae3704fa3e1">SetPointerWithVtable</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &key, void *value, const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a> *vtable)</td></tr>
- <tr class="separator:a3812564396da1ee901912ae3704fa3e1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6506784ed2e66dc2ca2358d68fadf317"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a6506784ed2e66dc2ca2358d68fadf317">SetString</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &key, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &value)</td></tr>
- <tr class="memdesc:a6506784ed2e66dc2ca2358d68fadf317"><td class="mdescLeft"> </td><td class="mdescRight">Set a textual argument <em>value</em> under <em>key</em>. <a href="#a6506784ed2e66dc2ca2358d68fadf317">More...</a><br /></td></tr>
- <tr class="separator:a6506784ed2e66dc2ca2358d68fadf317"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a296006697a027482e86adae83c24c1c9"><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__impl_1_1_channel_arguments.html#a296006697a027482e86adae83c24c1c9">c_channel_args</a> () const</td></tr>
- <tr class="memdesc:a296006697a027482e86adae83c24c1c9"><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__impl_1_1_channel_arguments.html" title="Options for channel creation. ">ChannelArguments</a></em> instance. <a href="#a296006697a027482e86adae83c24c1c9">More...</a><br /></td></tr>
- <tr class="separator:a296006697a027482e86adae83c24c1c9"><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:a43036c92bd17e6695c8f275baf38d727"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html#a43036c92bd17e6695c8f275baf38d727">grpc_impl::SecureChannelCredentials</a></td></tr>
- <tr class="separator:a43036c92bd17e6695c8f275baf38d727"><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__impl_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="ae4fbf794a623d84b01bc0ec9e3800181"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae4fbf794a623d84b01bc0ec9e3800181">◆ </a></span>ChannelArguments() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc_impl::ChannelArguments::ChannelArguments </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a640198ff5723690573ead652f9ebf276"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a640198ff5723690573ead652f9ebf276">◆ </a></span>~ChannelArguments()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc_impl::ChannelArguments::~ChannelArguments </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6def99473bdeb2befe7f6aed82a807fc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6def99473bdeb2befe7f6aed82a807fc">◆ </a></span>ChannelArguments() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">grpc_impl::ChannelArguments::ChannelArguments </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="classgrpc__impl_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="a296006697a027482e86adae83c24c1c9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a296006697a027482e86adae83c24c1c9">◆ </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_impl::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__impl_1_1_channel_arguments.html" title="Options for channel creation. ">ChannelArguments</a></em> instance. </p>
- </div>
- </div>
- <a id="ac5e5bbbdd7a30689e40627554fbacd37"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac5e5bbbdd7a30689e40627554fbacd37">◆ </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__impl_1_1_channel_arguments.html">ChannelArguments</a>& grpc_impl::ChannelArguments::operator= </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_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="a225a43b2e19605610edf25958d93d259"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a225a43b2e19605610edf25958d93d259">◆ </a></span>SetChannelArgs()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::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="aae117a0bd085ee4e5f487a623f2a4bb1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aae117a0bd085ee4e5f487a623f2a4bb1">◆ </a></span>SetCompressionAlgorithm()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::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="a4094dba493f52af4b5ca70781f1b35f3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4094dba493f52af4b5ca70781f1b35f3">◆ </a></span>SetGrpclbFallbackTimeout()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::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="a64d9c1954afa24e4a7c01a97302c388e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a64d9c1954afa24e4a7c01a97302c388e">◆ </a></span>SetInt()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetInt </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a15048926f06c66f04c04fe7ca0a3592a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a15048926f06c66f04c04fe7ca0a3592a">◆ </a></span>SetLoadBalancingPolicyName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetLoadBalancingPolicyName </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a7c1925ff9011549cc23e5b16412170f4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7c1925ff9011549cc23e5b16412170f4">◆ </a></span>SetMaxReceiveMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::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="a9f8bd238599e6c7b7aae69647d974040"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9f8bd238599e6c7b7aae69647d974040">◆ </a></span>SetMaxSendMessageSize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::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="a7a9bc34b45daa0086427a133e167267f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7a9bc34b45daa0086427a133e167267f">◆ </a></span>SetPointer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetPointer </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a3812564396da1ee901912ae3704fa3e1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3812564396da1ee901912ae3704fa3e1">◆ </a></span>SetPointerWithVtable()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetPointerWithVtable </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a683fb55ed71a8ae236a59594644d7900"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a683fb55ed71a8ae236a59594644d7900">◆ </a></span>SetResourceQuota()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetResourceQuota </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ac65c9e53fcc2796ff3033e626e1a5e4b">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="a749ebe3180b4385b2b85bf6503d9bb8b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a749ebe3180b4385b2b85bf6503d9bb8b">◆ </a></span>SetServiceConfigJSON()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetServiceConfigJSON </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a5f0b6402d56c1a6be6e0664e27c0b645"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5f0b6402d56c1a6be6e0664e27c0b645">◆ </a></span>SetSocketMutator()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::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="a0d77f161b627cd2ae09c6c2dd4b5632e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0d77f161b627cd2ae09c6c2dd4b5632e">◆ </a></span>SetSslTargetNameOverride()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetSslTargetNameOverride </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a6506784ed2e66dc2ca2358d68fadf317"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6506784ed2e66dc2ca2358d68fadf317">◆ </a></span>SetString()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetString </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
- <td class="paramname"><em>key</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="a73d350f842b3a8c556813661f8dbd440"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a73d350f842b3a8c556813661f8dbd440">◆ </a></span>SetUserAgentPrefix()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::SetUserAgentPrefix </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </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="ad8a88bae7db3b66eb7fd317d8c9798fe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad8a88bae7db3b66eb7fd317d8c9798fe">◆ </a></span>Swap()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void grpc_impl::ChannelArguments::Swap </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classgrpc__impl_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="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>
- <a id="a43036c92bd17e6695c8f275baf38d727"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a43036c92bd17e6695c8f275baf38d727">◆ </a></span>grpc_impl::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_impl::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>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/support/<a class="el" href="channel__arguments__impl_8h_source.html">channel_arguments_impl.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|