classgrpc_1_1_channel_arguments.html 37 KB

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