classgrpc_1_1_channel_arguments.html 37 KB

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