namespacegrpc__impl_1_1experimental.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  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_impl::experimental Namespace 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.23.0</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="namespacegrpc__impl_1_1experimental.html">experimental</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="#func-members">Functions</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc_impl::experimental Namespace Reference</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  73. Data Structures</h2></td></tr>
  74. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a></td></tr>
  75. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options used to build AltsCredentials. <a href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html#details">More...</a><br /></td></tr>
  76. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a></td></tr>
  78. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options to create <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> with ALTS. <a href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.html#details">More...</a><br /></td></tr>
  79. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_bidi_reactor.html">ClientBidiReactor</a></td></tr>
  81. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_bidi_reactor.html" title="ClientBidiReactor is the interface for a bidirectional streaming RPC. ">ClientBidiReactor</a></em> is the interface for a bidirectional streaming RPC. <a href="classgrpc__impl_1_1experimental_1_1_client_bidi_reactor.html#details">More...</a><br /></td></tr>
  82. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_callback_reader.html">ClientCallbackReader</a></td></tr>
  84. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_callback_reader_writer.html">ClientCallbackReaderWriter</a></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_callback_unary.html">ClientCallbackUnary</a></td></tr>
  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_callback_writer.html">ClientCallbackWriter</a></td></tr>
  90. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_read_reactor.html">ClientReadReactor</a></td></tr>
  92. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_read_reactor.html" title="ClientReadReactor is the interface for a server-streaming RPC. ">ClientReadReactor</a></em> is the interface for a server-streaming RPC. <a href="classgrpc__impl_1_1experimental_1_1_client_read_reactor.html#details">More...</a><br /></td></tr>
  93. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_unary_reactor.html">ClientUnaryReactor</a></td></tr>
  95. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_unary_reactor.html" title="ClientUnaryReactor is a reactor-style interface for a unary RPC. ">ClientUnaryReactor</a></em> is a reactor-style interface for a unary RPC. <a href="classgrpc__impl_1_1experimental_1_1_client_unary_reactor.html#details">More...</a><br /></td></tr>
  96. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_write_reactor.html">ClientWriteReactor</a></td></tr>
  98. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_client_write_reactor.html" title="ClientWriteReactor is the interface for a client-streaming RPC. ">ClientWriteReactor</a></em> is the interface for a client-streaming RPC. <a href="classgrpc__impl_1_1experimental_1_1_client_write_reactor.html#details">More...</a><br /></td></tr>
  99. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_bidi_reactor.html">ServerBidiReactor</a></td></tr>
  101. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC. ">ServerBidiReactor</a></em> is the interface for a bidirectional streaming RPC. <a href="classgrpc__impl_1_1experimental_1_1_server_bidi_reactor.html#details">More...</a><br /></td></tr>
  102. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_callback_reader.html">ServerCallbackReader</a></td></tr>
  104. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_callback_reader_writer.html">ServerCallbackReaderWriter</a></td></tr>
  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_callback_rpc_controller.html">ServerCallbackRpcController</a></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_callback_writer.html">ServerCallbackWriter</a></td></tr>
  110. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_read_reactor.html">ServerReadReactor</a></td></tr>
  112. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_read_reactor.html" title="ServerReadReactor is the interface for a client-streaming RPC. ">ServerReadReactor</a></em> is the interface for a client-streaming RPC. <a href="classgrpc__impl_1_1experimental_1_1_server_read_reactor.html#details">More...</a><br /></td></tr>
  113. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_write_reactor.html">ServerWriteReactor</a></td></tr>
  115. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><em><a class="el" href="classgrpc__impl_1_1experimental_1_1_server_write_reactor.html" title="ServerWriteReactor is the interface for a server-streaming RPC. ">ServerWriteReactor</a></em> is the interface for a server-streaming RPC. <a href="classgrpc__impl_1_1experimental_1_1_server_write_reactor.html#details">More...</a><br /></td></tr>
  116. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a></td></tr>
  118. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options for creating STS Oauth Token Exchange credentials following the IETF draft <a href="https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16">https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16</a>. <a href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html#details">More...</a><br /></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  122. Functions</h2></td></tr>
  123. <tr class="memitem:a48c141a4c0a991fd94bcd455e9392492"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a48c141a4c0a991fd94bcd455e9392492">ChannelResetConnectionBackoff</a> (<a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a> *channel)</td></tr>
  124. <tr class="memdesc:a48c141a4c0a991fd94bcd455e9392492"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the channel's connection backoff. <a href="#a48c141a4c0a991fd94bcd455e9392492">More...</a><br /></td></tr>
  125. <tr class="separator:a48c141a4c0a991fd94bcd455e9392492"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a9c746351c2dfd50ca78d7929c66e2a89"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a9c746351c2dfd50ca78d7929c66e2a89">CreateCustomChannelWithInterceptors</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;target, const std::shared_ptr&lt; <a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> &gt; &amp;creds, const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &amp;args, std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> &gt;&gt; interceptor_creators)</td></tr>
  127. <tr class="memdesc:a9c746351c2dfd50ca78d7929c66e2a89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <em>custom</em> <em><a class="el" href="classgrpc__impl_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a></em> pointing to <em>target</em> with <em>interceptors</em> being invoked per call. <a href="#a9c746351c2dfd50ca78d7929c66e2a89">More...</a><br /></td></tr>
  128. <tr class="separator:a9c746351c2dfd50ca78d7929c66e2a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a4eda68e84a71c21961901f0ef45d130b"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a4eda68e84a71c21961901f0ef45d130b">CreateCustomChannelWithInterceptors</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;target, const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;creds, const <a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a> &amp;args, std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> &gt;&gt; interceptor_creators)</td></tr>
  130. <tr class="separator:a4eda68e84a71c21961901f0ef45d130b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a83d31778cd73e3b708d8cd422038c09b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a83d31778cd73e3b708d8cd422038c09b">StsCredentialsOptionsFromJson</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;json_string, <a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a> *options)</td></tr>
  132. <tr class="memdesc:a83d31778cd73e3b708d8cd422038c09b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates STS Options from a JSON string. <a href="#a83d31778cd73e3b708d8cd422038c09b">More...</a><br /></td></tr>
  133. <tr class="separator:a83d31778cd73e3b708d8cd422038c09b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:aede3f7e0584dea73197d2913b0a4defe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#aede3f7e0584dea73197d2913b0a4defe">StsCredentialsOptionsFromEnv</a> (<a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a> *options)</td></tr>
  135. <tr class="memdesc:aede3f7e0584dea73197d2913b0a4defe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates STS credentials options from the $STS_CREDENTIALS environment variable. <a href="#aede3f7e0584dea73197d2913b0a4defe">More...</a><br /></td></tr>
  136. <tr class="separator:aede3f7e0584dea73197d2913b0a4defe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a0438f46fa3968eb6e904005356b8c531"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a0438f46fa3968eb6e904005356b8c531">StsCredentials</a> (const <a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a> &amp;options)</td></tr>
  138. <tr class="separator:a0438f46fa3968eb6e904005356b8c531"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a451bdb10d6605054a44c6dc39b233ddc"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a451bdb10d6605054a44c6dc39b233ddc">AltsCredentials</a> (const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a> &amp;options)</td></tr>
  140. <tr class="memdesc:a451bdb10d6605054a44c6dc39b233ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds ALTS Credentials given ALTS specific options. <a href="#a451bdb10d6605054a44c6dc39b233ddc">More...</a><br /></td></tr>
  141. <tr class="separator:a451bdb10d6605054a44c6dc39b233ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a64ae0296aed5117e1eb5c48bbed67604"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a64ae0296aed5117e1eb5c48bbed67604">LocalCredentials</a> (<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type)</td></tr>
  143. <tr class="memdesc:a64ae0296aed5117e1eb5c48bbed67604"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds Local Credentials. <a href="#a64ae0296aed5117e1eb5c48bbed67604">More...</a><br /></td></tr>
  144. <tr class="separator:a64ae0296aed5117e1eb5c48bbed67604"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:abf04d0563b8351571af5cb044495682d"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#abf04d0563b8351571af5cb044495682d">AltsServerCredentials</a> (const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> &amp;options)</td></tr>
  146. <tr class="memdesc:abf04d0563b8351571af5cb044495682d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds ALTS <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> given ALTS specific options. <a href="#abf04d0563b8351571af5cb044495682d">More...</a><br /></td></tr>
  147. <tr class="separator:abf04d0563b8351571af5cb044495682d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a805a7a560cf296b9e4b0156c29c32458"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html#a805a7a560cf296b9e4b0156c29c32458">LocalServerCredentials</a> (<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type)</td></tr>
  149. <tr class="memdesc:a805a7a560cf296b9e4b0156c29c32458"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds Local <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a>. <a href="#a805a7a560cf296b9e4b0156c29c32458">More...</a><br /></td></tr>
  150. <tr class="separator:a805a7a560cf296b9e4b0156c29c32458"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. </table>
  152. <h2 class="groupheader">Function Documentation</h2>
  153. <a id="a451bdb10d6605054a44c6dc39b233ddc"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a451bdb10d6605054a44c6dc39b233ddc">&#9670;&nbsp;</a></span>AltsCredentials()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::experimental::AltsCredentials </td>
  160. <td>(</td>
  161. <td class="paramtype">const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a> &amp;&#160;</td>
  162. <td class="paramname"><em>options</em></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Builds ALTS Credentials given ALTS specific options. </p>
  168. </div>
  169. </div>
  170. <a id="abf04d0563b8351571af5cb044495682d"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#abf04d0563b8351571af5cb044495682d">&#9670;&nbsp;</a></span>AltsServerCredentials()</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="memname">
  175. <tr>
  176. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>&gt; grpc_impl::experimental::AltsServerCredentials </td>
  177. <td>(</td>
  178. <td class="paramtype">const <a class="el" href="structgrpc__impl_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> &amp;&#160;</td>
  179. <td class="paramname"><em>options</em></td><td>)</td>
  180. <td></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Builds ALTS <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> given ALTS specific options. </p>
  185. </div>
  186. </div>
  187. <a id="a48c141a4c0a991fd94bcd455e9392492"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#a48c141a4c0a991fd94bcd455e9392492">&#9670;&nbsp;</a></span>ChannelResetConnectionBackoff()</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">void grpc_impl::experimental::ChannelResetConnectionBackoff </td>
  194. <td>(</td>
  195. <td class="paramtype"><a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a> *&#160;</td>
  196. <td class="paramname"><em>channel</em></td><td>)</td>
  197. <td></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Resets the channel's connection backoff. </p>
  202. <p>TODO(roth): Once we see whether this proves useful, either create a gRFC and change this to be a method of the <a class="el" href="classgrpc__impl_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a> class, or remove it. </p>
  203. </div>
  204. </div>
  205. <a id="a4eda68e84a71c21961901f0ef45d130b"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#a4eda68e84a71c21961901f0ef45d130b">&#9670;&nbsp;</a></span>CreateCustomChannelWithInterceptors() <span class="overload">[1/2]</span></h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a>&gt; grpc_impl::experimental::CreateCustomChannelWithInterceptors </td>
  212. <td>(</td>
  213. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  214. <td class="paramname"><em>target</em>, </td>
  215. </tr>
  216. <tr>
  217. <td class="paramkey"></td>
  218. <td></td>
  219. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;&#160;</td>
  220. <td class="paramname"><em>creds</em>, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype">const <a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a> &amp;&#160;</td>
  226. <td class="paramname"><em>args</em>, </td>
  227. </tr>
  228. <tr>
  229. <td class="paramkey"></td>
  230. <td></td>
  231. <td class="paramtype">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> &gt;&gt;&#160;</td>
  232. <td class="paramname"><em>interceptor_creators</em>&#160;</td>
  233. </tr>
  234. <tr>
  235. <td></td>
  236. <td>)</td>
  237. <td></td><td></td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. </div>
  242. </div>
  243. <a id="a9c746351c2dfd50ca78d7929c66e2a89"></a>
  244. <h2 class="memtitle"><span class="permalink"><a href="#a9c746351c2dfd50ca78d7929c66e2a89">&#9670;&nbsp;</a></span>CreateCustomChannelWithInterceptors() <span class="overload">[2/2]</span></h2>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>&gt; grpc_impl::experimental::CreateCustomChannelWithInterceptors </td>
  250. <td>(</td>
  251. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  252. <td class="paramname"><em>target</em>, </td>
  253. </tr>
  254. <tr>
  255. <td class="paramkey"></td>
  256. <td></td>
  257. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> &gt; &amp;&#160;</td>
  258. <td class="paramname"><em>creds</em>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &amp;&#160;</td>
  264. <td class="paramname"><em>args</em>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">grpc::experimental::ClientInterceptorFactoryInterface</a> &gt;&gt;&#160;</td>
  270. <td class="paramname"><em>interceptor_creators</em>&#160;</td>
  271. </tr>
  272. <tr>
  273. <td></td>
  274. <td>)</td>
  275. <td></td><td></td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Create a new <em>custom</em> <em><a class="el" href="classgrpc__impl_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a></em> pointing to <em>target</em> with <em>interceptors</em> being invoked per call. </p>
  280. <dl class="section warning"><dt>Warning</dt><dd>For advanced use and testing ONLY. Override default channel arguments only if necessary.</dd></dl>
  281. <dl class="params"><dt>Parameters</dt><dd>
  282. <table class="params">
  283. <tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
  284. <tr><td class="paramname">creds</td><td>Credentials to use for the created channel. If it does not hold an object or is invalid, a lame channel (one on which all operations fail) is returned. </td></tr>
  285. <tr><td class="paramname">args</td><td>Options for channel creation. </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. </div>
  290. </div>
  291. <a id="a64ae0296aed5117e1eb5c48bbed67604"></a>
  292. <h2 class="memtitle"><span class="permalink"><a href="#a64ae0296aed5117e1eb5c48bbed67604">&#9670;&nbsp;</a></span>LocalCredentials()</h2>
  293. <div class="memitem">
  294. <div class="memproto">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::experimental::LocalCredentials </td>
  298. <td>(</td>
  299. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a>&#160;</td>
  300. <td class="paramname"><em>type</em></td><td>)</td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Builds Local Credentials. </p>
  306. </div>
  307. </div>
  308. <a id="a805a7a560cf296b9e4b0156c29c32458"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#a805a7a560cf296b9e4b0156c29c32458">&#9670;&nbsp;</a></span>LocalServerCredentials()</h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>&gt; grpc_impl::experimental::LocalServerCredentials </td>
  315. <td>(</td>
  316. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a>&#160;</td>
  317. <td class="paramname"><em>type</em></td><td>)</td>
  318. <td></td>
  319. </tr>
  320. </table>
  321. </div><div class="memdoc">
  322. <p>Builds Local <a class="el" href="classgrpc__impl_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a>. </p>
  323. </div>
  324. </div>
  325. <a id="a0438f46fa3968eb6e904005356b8c531"></a>
  326. <h2 class="memtitle"><span class="permalink"><a href="#a0438f46fa3968eb6e904005356b8c531">&#9670;&nbsp;</a></span>StsCredentials()</h2>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::experimental::StsCredentials </td>
  332. <td>(</td>
  333. <td class="paramtype">const <a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a> &amp;&#160;</td>
  334. <td class="paramname"><em>options</em></td><td>)</td>
  335. <td></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. </div>
  340. </div>
  341. <a id="aede3f7e0584dea73197d2913b0a4defe"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#aede3f7e0584dea73197d2913b0a4defe">&#9670;&nbsp;</a></span>StsCredentialsOptionsFromEnv()</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> grpc_impl::experimental::StsCredentialsOptionsFromEnv </td>
  348. <td>(</td>
  349. <td class="paramtype"><a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a> *&#160;</td>
  350. <td class="paramname"><em>options</em></td><td>)</td>
  351. <td></td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Creates STS credentials options from the $STS_CREDENTIALS environment variable. </p>
  356. <p>This environment variable points to the path of a JSON file comforming to the schema described above. </p>
  357. </div>
  358. </div>
  359. <a id="a83d31778cd73e3b708d8cd422038c09b"></a>
  360. <h2 class="memtitle"><span class="permalink"><a href="#a83d31778cd73e3b708d8cd422038c09b">&#9670;&nbsp;</a></span>StsCredentialsOptionsFromJson()</h2>
  361. <div class="memitem">
  362. <div class="memproto">
  363. <table class="memname">
  364. <tr>
  365. <td class="memname"><a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> grpc_impl::experimental::StsCredentialsOptionsFromJson </td>
  366. <td>(</td>
  367. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  368. <td class="paramname"><em>json_string</em>, </td>
  369. </tr>
  370. <tr>
  371. <td class="paramkey"></td>
  372. <td></td>
  373. <td class="paramtype"><a class="el" href="structgrpc__impl_1_1experimental_1_1_sts_credentials_options.html">StsCredentialsOptions</a> *&#160;</td>
  374. <td class="paramname"><em>options</em>&#160;</td>
  375. </tr>
  376. <tr>
  377. <td></td>
  378. <td>)</td>
  379. <td></td><td></td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <p>Creates STS Options from a JSON string. </p>
  384. <p>The JSON schema is as follows: { "title": "STS Credentials Config", "type": "object", "required": ["token_exchange_service_uri", "subject_token_path", "subject_token_type"], "properties": { "token_exchange_service_uri": { "type": "string" }, "resource": { "type": "string" }, "audience": { "type": "string" }, "scope": { "type": "string" }, "requested_token_type": { "type": "string" }, "subject_token_path": { "type": "string" }, "subject_token_type": { "type": "string" }, "actor_token_path" : { "type": "string" }, "actor_token_type": { "type": "string" } } } </p>
  385. </div>
  386. </div>
  387. </div><!-- contents -->
  388. <!-- start footer part -->
  389. <hr class="footer"/><address class="footer"><small>
  390. Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  391. <img class="footer" src="doxygen.png" alt="doxygen"/>
  392. </a> 1.8.13
  393. </small></address>
  394. </body>
  395. </html>