classgrpc_1_1_channel_arguments.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ChannelArguments Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#nested-classes">Data Structures</a> &#124;
  69. <a href="#pub-methods">Public Member Functions</a> &#124;
  70. <a href="#friends">Friends</a> </div>
  71. <div class="headertitle">
  72. <div class="title">grpc::ChannelArguments Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p>Options for channel creation.
  76. <a href="classgrpc_1_1_channel_arguments.html#details">More...</a></p>
  77. <p><code>#include &lt;<a class="el" href="grpcpp_2support_2channel__arguments_8h_source.html">channel_arguments.h</a>&gt;</code></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:aecabf1ea1c78a3202544571cf857e8eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#aecabf1ea1c78a3202544571cf857e8eb">ChannelArguments</a> ()</td></tr>
  82. <tr class="separator:aecabf1ea1c78a3202544571cf857e8eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a8058adf243855c3a44030c23ccec05ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a8058adf243855c3a44030c23ccec05ad">~ChannelArguments</a> ()</td></tr>
  84. <tr class="separator:a8058adf243855c3a44030c23ccec05ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ade11dfb5cac0e1da5e9ed5e86c18c4fe"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;other)</td></tr>
  86. <tr class="separator:ade11dfb5cac0e1da5e9ed5e86c18c4fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:ac75ba90de32a5c7f3cb6c62f7ce649be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &amp;&#160;</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>
  88. <tr class="separator:ac75ba90de32a5c7f3cb6c62f7ce649be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a3ff4f22c2cf31c01885b2aaefbdd227d"><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;other)</td></tr>
  90. <tr class="separator:a3ff4f22c2cf31c01885b2aaefbdd227d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ada3b48824deebdc38bc173701ad10e35"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  92. <tr class="memdesc:ada3b48824deebdc38bc173701ad10e35"><td class="mdescLeft">&#160;</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>
  93. <tr class="separator:ada3b48824deebdc38bc173701ad10e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a42313e3360b50c354c68572e7bf5bccb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a42313e3360b50c354c68572e7bf5bccb">SetSslTargetNameOverride</a> (const std::string &amp;name)</td></tr>
  95. <tr class="memdesc:a42313e3360b50c354c68572e7bf5bccb"><td class="mdescLeft">&#160;</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>
  96. <tr class="separator:a42313e3360b50c354c68572e7bf5bccb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:aaf332071bbdff5e4a7f3352f4ad564d5"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  98. <tr class="memdesc:aaf332071bbdff5e4a7f3352f4ad564d5"><td class="mdescLeft">&#160;</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>
  99. <tr class="separator:aaf332071bbdff5e4a7f3352f4ad564d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a34014343bd52a0ed7289a9f8b203d9d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a34014343bd52a0ed7289a9f8b203d9d1">SetGrpclbFallbackTimeout</a> (int fallback_timeout)</td></tr>
  101. <tr class="memdesc:a34014343bd52a0ed7289a9f8b203d9d1"><td class="mdescLeft">&#160;</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>
  102. <tr class="separator:a34014343bd52a0ed7289a9f8b203d9d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a520690f499be85159a20200ddb986a96"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
  104. <tr class="memdesc:a520690f499be85159a20200ddb986a96"><td class="mdescLeft">&#160;</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>
  105. <tr class="separator:a520690f499be85159a20200ddb986a96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a86e18071dd5af0880dc86f9305eefe0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a86e18071dd5af0880dc86f9305eefe0a">SetUserAgentPrefix</a> (const std::string &amp;user_agent_prefix)</td></tr>
  107. <tr class="memdesc:a86e18071dd5af0880dc86f9305eefe0a"><td class="mdescLeft">&#160;</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>
  108. <tr class="separator:a86e18071dd5af0880dc86f9305eefe0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a8ccf6088c76cefb188c8d4b0ad353cc0"><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;resource_quota)</td></tr>
  110. <tr class="memdesc:a8ccf6088c76cefb188c8d4b0ad353cc0"><td class="mdescLeft">&#160;</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>
  111. <tr class="separator:a8ccf6088c76cefb188c8d4b0ad353cc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a2629f85664dd2822fe54059c4730baf8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a2629f85664dd2822fe54059c4730baf8">SetMaxReceiveMessageSize</a> (int size)</td></tr>
  113. <tr class="memdesc:a2629f85664dd2822fe54059c4730baf8"><td class="mdescLeft">&#160;</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>
  114. <tr class="separator:a2629f85664dd2822fe54059c4730baf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ac1fa513191e8104ec57dfd6598297ce5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ac1fa513191e8104ec57dfd6598297ce5">SetMaxSendMessageSize</a> (int size)</td></tr>
  116. <tr class="separator:ac1fa513191e8104ec57dfd6598297ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:acaa6e36346e2fef8833e2f53fd289cf2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#acaa6e36346e2fef8833e2f53fd289cf2">SetLoadBalancingPolicyName</a> (const std::string &amp;lb_policy_name)</td></tr>
  118. <tr class="memdesc:acaa6e36346e2fef8833e2f53fd289cf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set LB policy name. <a href="classgrpc_1_1_channel_arguments.html#acaa6e36346e2fef8833e2f53fd289cf2">More...</a><br /></td></tr>
  119. <tr class="separator:acaa6e36346e2fef8833e2f53fd289cf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ae9399219c13808b45f3acad088fb0981"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#ae9399219c13808b45f3acad088fb0981">SetServiceConfigJSON</a> (const std::string &amp;service_config_json)</td></tr>
  121. <tr class="memdesc:ae9399219c13808b45f3acad088fb0981"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set service config in JSON form. <a href="classgrpc_1_1_channel_arguments.html#ae9399219c13808b45f3acad088fb0981">More...</a><br /></td></tr>
  122. <tr class="separator:ae9399219c13808b45f3acad088fb0981"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a95551b0d103d8e2527669aa0744fddcc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a95551b0d103d8e2527669aa0744fddcc">SetInt</a> (const std::string &amp;key, int value)</td></tr>
  124. <tr class="memdesc:a95551b0d103d8e2527669aa0744fddcc"><td class="mdescLeft">&#160;</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>
  125. <tr class="separator:a95551b0d103d8e2527669aa0744fddcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a4d0542a29349a1d6345d2278f117adfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a4d0542a29349a1d6345d2278f117adfa">SetPointer</a> (const std::string &amp;key, void *value)</td></tr>
  127. <tr class="memdesc:a4d0542a29349a1d6345d2278f117adfa"><td class="mdescLeft">&#160;</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>
  128. <tr class="separator:a4d0542a29349a1d6345d2278f117adfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:af8f0632b49b4e281f9f11fcfdda9c446"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#af8f0632b49b4e281f9f11fcfdda9c446">SetPointerWithVtable</a> (const std::string &amp;key, void *value, const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a> *vtable)</td></tr>
  130. <tr class="separator:af8f0632b49b4e281f9f11fcfdda9c446"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:af353198d69aa6e9c04f3451f848d5ae7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#af353198d69aa6e9c04f3451f848d5ae7">SetString</a> (const std::string &amp;key, const std::string &amp;value)</td></tr>
  132. <tr class="memdesc:af353198d69aa6e9c04f3451f848d5ae7"><td class="mdescLeft">&#160;</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>
  133. <tr class="separator:af353198d69aa6e9c04f3451f848d5ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:aef26c9943c9f19c63b2c8e4023096d5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#aef26c9943c9f19c63b2c8e4023096d5e">c_channel_args</a> () const</td></tr>
  135. <tr class="memdesc:aef26c9943c9f19c63b2c8e4023096d5e"><td class="mdescLeft">&#160;</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>
  136. <tr class="separator:aef26c9943c9f19c63b2c8e4023096d5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table><table class="memberdecls">
  138. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  139. Friends</h2></td></tr>
  140. <tr class="memitem:a37da22b0dddc749b10ff04deab4f5481"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a37da22b0dddc749b10ff04deab4f5481">grpc::SecureChannelCredentials</a></td></tr>
  141. <tr class="separator:a37da22b0dddc749b10ff04deab4f5481"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a418577e16bfe952f5c7af804255eccd1"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_arguments.html#a418577e16bfe952f5c7af804255eccd1">grpc::testing::ChannelArgumentsTest</a></td></tr>
  143. <tr class="separator:a418577e16bfe952f5c7af804255eccd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. </table>
  145. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  146. <div class="textblock"><p>Options for channel creation. </p>
  147. <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>
  148. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  149. <a id="aecabf1ea1c78a3202544571cf857e8eb"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#aecabf1ea1c78a3202544571cf857e8eb">&#9670;&nbsp;</a></span>ChannelArguments() <span class="overload">[1/2]</span></h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">grpc::ChannelArguments::ChannelArguments </td>
  156. <td>(</td>
  157. <td class="paramname"></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <a id="a8058adf243855c3a44030c23ccec05ad"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a8058adf243855c3a44030c23ccec05ad">&#9670;&nbsp;</a></span>~ChannelArguments()</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">grpc::ChannelArguments::~ChannelArguments </td>
  171. <td>(</td>
  172. <td class="paramname"></td><td>)</td>
  173. <td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a id="ade11dfb5cac0e1da5e9ed5e86c18c4fe"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#ade11dfb5cac0e1da5e9ed5e86c18c4fe">&#9670;&nbsp;</a></span>ChannelArguments() <span class="overload">[2/2]</span></h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">grpc::ChannelArguments::ChannelArguments </td>
  186. <td>(</td>
  187. <td class="paramtype">const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &amp;&#160;</td>
  188. <td class="paramname"><em>other</em></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <h2 class="groupheader">Member Function Documentation</h2>
  196. <a id="aef26c9943c9f19c63b2c8e4023096d5e"></a>
  197. <h2 class="memtitle"><span class="permalink"><a href="#aef26c9943c9f19c63b2c8e4023096d5e">&#9670;&nbsp;</a></span>c_channel_args()</h2>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="mlabels">
  201. <tr>
  202. <td class="mlabels-left">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> grpc::ChannelArguments::c_channel_args </td>
  206. <td>(</td>
  207. <td class="paramname"></td><td>)</td>
  208. <td> const</td>
  209. </tr>
  210. </table>
  211. </td>
  212. <td class="mlabels-right">
  213. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <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>
  218. </div>
  219. </div>
  220. <a id="ac75ba90de32a5c7f3cb6c62f7ce649be"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#ac75ba90de32a5c7f3cb6c62f7ce649be">&#9670;&nbsp;</a></span>operator=()</h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a>&amp; grpc::ChannelArguments::operator= </td>
  230. <td>(</td>
  231. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a>&#160;</td>
  232. <td class="paramname"><em>other</em></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. </div>
  243. </div>
  244. <a id="ada3b48824deebdc38bc173701ad10e35"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#ada3b48824deebdc38bc173701ad10e35">&#9670;&nbsp;</a></span>SetChannelArgs()</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">void grpc::ChannelArguments::SetChannelArgs </td>
  251. <td>(</td>
  252. <td class="paramtype"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
  253. <td class="paramname"><em>channel_args</em></td><td>)</td>
  254. <td> const</td>
  255. </tr>
  256. </table>
  257. </div><div class="memdoc">
  258. <p>Dump arguments in this instance to <em>channel_args</em>. </p>
  259. <p>Does not take ownership of <em>channel_args</em>.</p>
  260. <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>
  261. </div>
  262. </div>
  263. <a id="aaf332071bbdff5e4a7f3352f4ad564d5"></a>
  264. <h2 class="memtitle"><span class="permalink"><a href="#aaf332071bbdff5e4a7f3352f4ad564d5">&#9670;&nbsp;</a></span>SetCompressionAlgorithm()</h2>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">void grpc::ChannelArguments::SetCompressionAlgorithm </td>
  270. <td>(</td>
  271. <td class="paramtype"><a class="el" href="compression__types_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td>
  272. <td class="paramname"><em>algorithm</em></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Set the compression algorithm for the channel. </p>
  278. </div>
  279. </div>
  280. <a id="a34014343bd52a0ed7289a9f8b203d9d1"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#a34014343bd52a0ed7289a9f8b203d9d1">&#9670;&nbsp;</a></span>SetGrpclbFallbackTimeout()</h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">void grpc::ChannelArguments::SetGrpclbFallbackTimeout </td>
  287. <td>(</td>
  288. <td class="paramtype">int&#160;</td>
  289. <td class="paramname"><em>fallback_timeout</em></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <p>Set the grpclb fallback timeout (in ms) for the channel. </p>
  295. <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>
  296. </div>
  297. </div>
  298. <a id="a95551b0d103d8e2527669aa0744fddcc"></a>
  299. <h2 class="memtitle"><span class="permalink"><a href="#a95551b0d103d8e2527669aa0744fddcc">&#9670;&nbsp;</a></span>SetInt()</h2>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname">void grpc::ChannelArguments::SetInt </td>
  305. <td>(</td>
  306. <td class="paramtype">const std::string &amp;&#160;</td>
  307. <td class="paramname"><em>key</em>, </td>
  308. </tr>
  309. <tr>
  310. <td class="paramkey"></td>
  311. <td></td>
  312. <td class="paramtype">int&#160;</td>
  313. <td class="paramname"><em>value</em>&#160;</td>
  314. </tr>
  315. <tr>
  316. <td></td>
  317. <td>)</td>
  318. <td></td><td></td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <p>Set an integer argument <em>value</em> under <em>key</em>. </p>
  323. </div>
  324. </div>
  325. <a id="acaa6e36346e2fef8833e2f53fd289cf2"></a>
  326. <h2 class="memtitle"><span class="permalink"><a href="#acaa6e36346e2fef8833e2f53fd289cf2">&#9670;&nbsp;</a></span>SetLoadBalancingPolicyName()</h2>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">void grpc::ChannelArguments::SetLoadBalancingPolicyName </td>
  332. <td>(</td>
  333. <td class="paramtype">const std::string &amp;&#160;</td>
  334. <td class="paramname"><em>lb_policy_name</em></td><td>)</td>
  335. <td></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Set LB policy name. </p>
  340. <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>
  341. </div>
  342. </div>
  343. <a id="a2629f85664dd2822fe54059c4730baf8"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a2629f85664dd2822fe54059c4730baf8">&#9670;&nbsp;</a></span>SetMaxReceiveMessageSize()</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">void grpc::ChannelArguments::SetMaxReceiveMessageSize </td>
  350. <td>(</td>
  351. <td class="paramtype">int&#160;</td>
  352. <td class="paramname"><em>size</em></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Set the max receive and send message sizes. </p>
  358. </div>
  359. </div>
  360. <a id="ac1fa513191e8104ec57dfd6598297ce5"></a>
  361. <h2 class="memtitle"><span class="permalink"><a href="#ac1fa513191e8104ec57dfd6598297ce5">&#9670;&nbsp;</a></span>SetMaxSendMessageSize()</h2>
  362. <div class="memitem">
  363. <div class="memproto">
  364. <table class="memname">
  365. <tr>
  366. <td class="memname">void grpc::ChannelArguments::SetMaxSendMessageSize </td>
  367. <td>(</td>
  368. <td class="paramtype">int&#160;</td>
  369. <td class="paramname"><em>size</em></td><td>)</td>
  370. <td></td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. </div>
  375. </div>
  376. <a id="a4d0542a29349a1d6345d2278f117adfa"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#a4d0542a29349a1d6345d2278f117adfa">&#9670;&nbsp;</a></span>SetPointer()</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">void grpc::ChannelArguments::SetPointer </td>
  383. <td>(</td>
  384. <td class="paramtype">const std::string &amp;&#160;</td>
  385. <td class="paramname"><em>key</em>, </td>
  386. </tr>
  387. <tr>
  388. <td class="paramkey"></td>
  389. <td></td>
  390. <td class="paramtype">void *&#160;</td>
  391. <td class="paramname"><em>value</em>&#160;</td>
  392. </tr>
  393. <tr>
  394. <td></td>
  395. <td>)</td>
  396. <td></td><td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <p>Set a pointer argument <em>value</em> under <em>key</em>. Owership is not transferred. </p>
  401. </div>
  402. </div>
  403. <a id="af8f0632b49b4e281f9f11fcfdda9c446"></a>
  404. <h2 class="memtitle"><span class="permalink"><a href="#af8f0632b49b4e281f9f11fcfdda9c446">&#9670;&nbsp;</a></span>SetPointerWithVtable()</h2>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="memname">
  408. <tr>
  409. <td class="memname">void grpc::ChannelArguments::SetPointerWithVtable </td>
  410. <td>(</td>
  411. <td class="paramtype">const std::string &amp;&#160;</td>
  412. <td class="paramname"><em>key</em>, </td>
  413. </tr>
  414. <tr>
  415. <td class="paramkey"></td>
  416. <td></td>
  417. <td class="paramtype">void *&#160;</td>
  418. <td class="paramname"><em>value</em>, </td>
  419. </tr>
  420. <tr>
  421. <td class="paramkey"></td>
  422. <td></td>
  423. <td class="paramtype">const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a> *&#160;</td>
  424. <td class="paramname"><em>vtable</em>&#160;</td>
  425. </tr>
  426. <tr>
  427. <td></td>
  428. <td>)</td>
  429. <td></td><td></td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. </div>
  434. </div>
  435. <a id="a8ccf6088c76cefb188c8d4b0ad353cc0"></a>
  436. <h2 class="memtitle"><span class="permalink"><a href="#a8ccf6088c76cefb188c8d4b0ad353cc0">&#9670;&nbsp;</a></span>SetResourceQuota()</h2>
  437. <div class="memitem">
  438. <div class="memproto">
  439. <table class="memname">
  440. <tr>
  441. <td class="memname">void grpc::ChannelArguments::SetResourceQuota </td>
  442. <td>(</td>
  443. <td class="paramtype">const <a class="el" href="classgrpc_1_1_resource_quota.html">grpc::ResourceQuota</a> &amp;&#160;</td>
  444. <td class="paramname"><em>resource_quota</em></td><td>)</td>
  445. <td></td>
  446. </tr>
  447. </table>
  448. </div><div class="memdoc">
  449. <p>Set the buffer pool to be attached to the constructed channel. </p>
  450. </div>
  451. </div>
  452. <a id="ae9399219c13808b45f3acad088fb0981"></a>
  453. <h2 class="memtitle"><span class="permalink"><a href="#ae9399219c13808b45f3acad088fb0981">&#9670;&nbsp;</a></span>SetServiceConfigJSON()</h2>
  454. <div class="memitem">
  455. <div class="memproto">
  456. <table class="memname">
  457. <tr>
  458. <td class="memname">void grpc::ChannelArguments::SetServiceConfigJSON </td>
  459. <td>(</td>
  460. <td class="paramtype">const std::string &amp;&#160;</td>
  461. <td class="paramname"><em>service_config_json</em></td><td>)</td>
  462. <td></td>
  463. </tr>
  464. </table>
  465. </div><div class="memdoc">
  466. <p>Set service config in JSON form. </p>
  467. <p>Primarily meant for use in unit tests. </p>
  468. </div>
  469. </div>
  470. <a id="a520690f499be85159a20200ddb986a96"></a>
  471. <h2 class="memtitle"><span class="permalink"><a href="#a520690f499be85159a20200ddb986a96">&#9670;&nbsp;</a></span>SetSocketMutator()</h2>
  472. <div class="memitem">
  473. <div class="memproto">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname">void grpc::ChannelArguments::SetSocketMutator </td>
  477. <td>(</td>
  478. <td class="paramtype"><a class="el" href="grpc__types_8h.html#a72c4781284bb0c964d281e6e46cf4a90">grpc_socket_mutator</a> *&#160;</td>
  479. <td class="paramname"><em>mutator</em></td><td>)</td>
  480. <td></td>
  481. </tr>
  482. </table>
  483. </div><div class="memdoc">
  484. <p>For client channel's, the socket mutator operates on "channel" sockets. </p>
  485. <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>
  486. </div>
  487. </div>
  488. <a id="a42313e3360b50c354c68572e7bf5bccb"></a>
  489. <h2 class="memtitle"><span class="permalink"><a href="#a42313e3360b50c354c68572e7bf5bccb">&#9670;&nbsp;</a></span>SetSslTargetNameOverride()</h2>
  490. <div class="memitem">
  491. <div class="memproto">
  492. <table class="memname">
  493. <tr>
  494. <td class="memname">void grpc::ChannelArguments::SetSslTargetNameOverride </td>
  495. <td>(</td>
  496. <td class="paramtype">const std::string &amp;&#160;</td>
  497. <td class="paramname"><em>name</em></td><td>)</td>
  498. <td></td>
  499. </tr>
  500. </table>
  501. </div><div class="memdoc">
  502. <p>Set target name override for SSL host name checking. </p>
  503. <p>This option should be used with caution in production. </p>
  504. </div>
  505. </div>
  506. <a id="af353198d69aa6e9c04f3451f848d5ae7"></a>
  507. <h2 class="memtitle"><span class="permalink"><a href="#af353198d69aa6e9c04f3451f848d5ae7">&#9670;&nbsp;</a></span>SetString()</h2>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <table class="memname">
  511. <tr>
  512. <td class="memname">void grpc::ChannelArguments::SetString </td>
  513. <td>(</td>
  514. <td class="paramtype">const std::string &amp;&#160;</td>
  515. <td class="paramname"><em>key</em>, </td>
  516. </tr>
  517. <tr>
  518. <td class="paramkey"></td>
  519. <td></td>
  520. <td class="paramtype">const std::string &amp;&#160;</td>
  521. <td class="paramname"><em>value</em>&#160;</td>
  522. </tr>
  523. <tr>
  524. <td></td>
  525. <td>)</td>
  526. <td></td><td></td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>Set a textual argument <em>value</em> under <em>key</em>. </p>
  531. </div>
  532. </div>
  533. <a id="a86e18071dd5af0880dc86f9305eefe0a"></a>
  534. <h2 class="memtitle"><span class="permalink"><a href="#a86e18071dd5af0880dc86f9305eefe0a">&#9670;&nbsp;</a></span>SetUserAgentPrefix()</h2>
  535. <div class="memitem">
  536. <div class="memproto">
  537. <table class="memname">
  538. <tr>
  539. <td class="memname">void grpc::ChannelArguments::SetUserAgentPrefix </td>
  540. <td>(</td>
  541. <td class="paramtype">const std::string &amp;&#160;</td>
  542. <td class="paramname"><em>user_agent_prefix</em></td><td>)</td>
  543. <td></td>
  544. </tr>
  545. </table>
  546. </div><div class="memdoc">
  547. <p>Set the string to prepend to the user agent. </p>
  548. </div>
  549. </div>
  550. <a id="a3ff4f22c2cf31c01885b2aaefbdd227d"></a>
  551. <h2 class="memtitle"><span class="permalink"><a href="#a3ff4f22c2cf31c01885b2aaefbdd227d">&#9670;&nbsp;</a></span>Swap()</h2>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <table class="memname">
  555. <tr>
  556. <td class="memname">void grpc::ChannelArguments::Swap </td>
  557. <td>(</td>
  558. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &amp;&#160;</td>
  559. <td class="paramname"><em>other</em></td><td>)</td>
  560. <td></td>
  561. </tr>
  562. </table>
  563. </div><div class="memdoc">
  564. </div>
  565. </div>
  566. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  567. <a id="a37da22b0dddc749b10ff04deab4f5481"></a>
  568. <h2 class="memtitle"><span class="permalink"><a href="#a37da22b0dddc749b10ff04deab4f5481">&#9670;&nbsp;</a></span>grpc::SecureChannelCredentials</h2>
  569. <div class="memitem">
  570. <div class="memproto">
  571. <table class="mlabels">
  572. <tr>
  573. <td class="mlabels-left">
  574. <table class="memname">
  575. <tr>
  576. <td class="memname">friend class grpc::SecureChannelCredentials</td>
  577. </tr>
  578. </table>
  579. </td>
  580. <td class="mlabels-right">
  581. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  582. </tr>
  583. </table>
  584. </div><div class="memdoc">
  585. </div>
  586. </div>
  587. <a id="a418577e16bfe952f5c7af804255eccd1"></a>
  588. <h2 class="memtitle"><span class="permalink"><a href="#a418577e16bfe952f5c7af804255eccd1">&#9670;&nbsp;</a></span>grpc::testing::ChannelArgumentsTest</h2>
  589. <div class="memitem">
  590. <div class="memproto">
  591. <table class="mlabels">
  592. <tr>
  593. <td class="mlabels-left">
  594. <table class="memname">
  595. <tr>
  596. <td class="memname">friend class grpc::testing::ChannelArgumentsTest</td>
  597. </tr>
  598. </table>
  599. </td>
  600. <td class="mlabels-right">
  601. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  602. </tr>
  603. </table>
  604. </div><div class="memdoc">
  605. </div>
  606. </div>
  607. <hr/>The documentation for this class was generated from the following file:<ul>
  608. <li>include/grpcpp/support/<a class="el" href="grpcpp_2support_2channel__arguments_8h_source.html">channel_arguments.h</a></li>
  609. </ul>
  610. </div><!-- contents -->
  611. <!-- start footer part -->
  612. <hr class="footer"/><address class="footer"><small>
  613. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  614. <img class="footer" src="doxygen.png" alt="doxygen"/>
  615. </a> 1.8.17
  616. </small></address>
  617. </body>
  618. </html>