namespacegrpc_1_1experimental.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  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::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.18.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.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_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="#enum-members">Enumerations</a> &#124;
  67. <a href="#func-members">Functions</a> </div>
  68. <div class="headertitle">
  69. <div class="title">grpc::experimental Namespace Reference</div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <p><a class="el" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a> represents the state of a particular RPC as it appears to an interceptor.
  73. <a href="#details">More...</a></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  76. Data Structures</h2></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_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a></td></tr>
  78. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options used to build AltsCredentials. <a href="structgrpc_1_1experimental_1_1_alts_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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a></td></tr>
  81. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options to create <a class="el" href="classgrpc_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> with ALTS. <a href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.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_1_1experimental_1_1_client_bidi_reactor.html">ClientBidiReactor</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_1_1experimental_1_1_client_callback_reader.html">ClientCallbackReader</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_1_1experimental_1_1_client_callback_reader_writer.html">ClientCallbackReaderWriter</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_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_1_1experimental_1_1_client_interceptor_factory_interface.html">ClientInterceptorFactoryInterface</a></td></tr>
  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_client_read_reactor.html">ClientReadReactor</a></td></tr>
  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a></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_1_1experimental_1_1_client_write_reactor.html">ClientWriteReactor</a></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html">Interceptor</a></td></tr>
  100. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for an interceptor. <a href="classgrpc_1_1experimental_1_1_interceptor.html#details">More...</a><br /></td></tr>
  101. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html">InterceptorBatchMethods</a></td></tr>
  103. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class that is passed as an argument to the <em>Intercept</em> method of the application's <em><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html" title="Interface for an interceptor. ">Interceptor</a></em> interface implementation. <a href="classgrpc_1_1experimental_1_1_interceptor_batch_methods.html#details">More...</a><br /></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_1_1experimental_1_1_server_bidi_reactor.html">ServerBidiReactor</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_1_1experimental_1_1_server_callback_reader.html">ServerCallbackReader</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_1_1experimental_1_1_server_callback_reader_writer.html">ServerCallbackReaderWriter</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_1_1experimental_1_1_server_callback_rpc_controller.html">ServerCallbackRpcController</a></td></tr>
  112. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_writer.html">ServerCallbackWriter</a></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_interceptor_factory_interface.html">ServerInterceptorFactoryInterface</a></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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_read_reactor.html">ServerReadReactor</a></td></tr>
  118. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_rpc_info.html">ServerRpcInfo</a></td></tr>
  120. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classgrpc_1_1experimental_1_1_server_rpc_info.html" title="ServerRpcInfo represents the state of a particular RPC as it appears to an interceptor. ">ServerRpcInfo</a> represents the state of a particular RPC as it appears to an interceptor. <a href="classgrpc_1_1experimental_1_1_server_rpc_info.html#details">More...</a><br /></td></tr>
  121. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_write_reactor.html">ServerWriteReactor</a></td></tr>
  123. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. </table><table class="memberdecls">
  125. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  126. Enumerations</h2></td></tr>
  127. <tr class="memitem:a03d3481b2c4146f53e90966d4a0fd8a1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">InterceptionHookPoints</a> { <br />
  128. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a68f9cc22793a30bf451f5d94c283f371">InterceptionHookPoints::PRE_SEND_INITIAL_METADATA</a>,
  129. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a78e48d97d3b04c3bc07cc5e015bae473">InterceptionHookPoints::PRE_SEND_MESSAGE</a>,
  130. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a787bde31497aaaccd0e780928a34ba3c">InterceptionHookPoints::PRE_SEND_STATUS</a>,
  131. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aae41c3d206fb78da7ea1baff522fe734">InterceptionHookPoints::PRE_SEND_CLOSE</a>,
  132. <br />
  133. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ae1edf7ebacfc20d107e332ed0df262d2">InterceptionHookPoints::PRE_RECV_INITIAL_METADATA</a>,
  134. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aed5412a55f4c64aab2e6492c79c91422">InterceptionHookPoints::PRE_RECV_MESSAGE</a>,
  135. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1aac79efae31b3773d455797286cd0a3c3">InterceptionHookPoints::PRE_RECV_STATUS</a>,
  136. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a294bdaeb2f3c15f0c7529ecdb04daea8">InterceptionHookPoints::POST_RECV_INITIAL_METADATA</a>,
  137. <br />
  138. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1ab65173742bb81f390a2bbe48279a1d22">InterceptionHookPoints::POST_RECV_MESSAGE</a>,
  139. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a97b298c9f3aa4e0b5b4865eaa93a5909">InterceptionHookPoints::POST_RECV_STATUS</a>,
  140. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a28873db230a854864aaf46ce3c7d282a">InterceptionHookPoints::POST_RECV_CLOSE</a>,
  141. <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1afeaf95b857178c518bb74d59eb39aa23">InterceptionHookPoints::PRE_SEND_CANCEL</a>,
  142. <br />
  143. &#160;&#160;<a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1a005432205f3c52f3321eab4485d84c36">InterceptionHookPoints::NUM_INTERCEPTION_HOOKS</a>
  144. <br />
  145. }<tr class="memdesc:a03d3481b2c4146f53e90966d4a0fd8a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">An enumeration of different possible points at which the <em>Intercept</em> method of the <em>Interceptor</em> interface may be called. <a href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">More...</a><br /></td></tr>
  146. </td></tr>
  147. <tr class="separator:a03d3481b2c4146f53e90966d4a0fd8a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table><table class="memberdecls">
  149. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  150. Functions</h2></td></tr>
  151. <tr class="memitem:ab4c7e40417b37179d52667f3208f69a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#ab4c7e40417b37179d52667f3208f69a3">ChannelResetConnectionBackoff</a> (<a class="el" href="classgrpc_1_1_channel.html">Channel</a> *channel)</td></tr>
  152. <tr class="memdesc:ab4c7e40417b37179d52667f3208f69a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the channel's connection backoff. <a href="#ab4c7e40417b37179d52667f3208f69a3">More...</a><br /></td></tr>
  153. <tr class="separator:ab4c7e40417b37179d52667f3208f69a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:add75d935f9366cf23255959e0baaeff5"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel.html">Channel</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#add75d935f9366cf23255959e0baaeff5">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_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;creds, const <a class="el" href="classgrpc_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">experimental::ClientInterceptorFactoryInterface</a> &gt;&gt; interceptor_creators)</td></tr>
  155. <tr class="memdesc:add75d935f9366cf23255959e0baaeff5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <em>custom</em> <em><a class="el" href="classgrpc_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="#add75d935f9366cf23255959e0baaeff5">More...</a><br /></td></tr>
  156. <tr class="separator:add75d935f9366cf23255959e0baaeff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:abf863776469f08e69e7ca6e82246fd7a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#abf863776469f08e69e7ca6e82246fd7a">RegisterGlobalClientInterceptorFactory</a> (<a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">ClientInterceptorFactoryInterface</a> *factory)</td></tr>
  158. <tr class="separator:abf863776469f08e69e7ca6e82246fd7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:ad871e11876b9e9893ee4f57fc283abfb"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#ad871e11876b9e9893ee4f57fc283abfb">AltsCredentials</a> (const <a class="el" href="structgrpc_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a> &amp;options)</td></tr>
  160. <tr class="memdesc:ad871e11876b9e9893ee4f57fc283abfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds ALTS Credentials given ALTS specific options. <a href="#ad871e11876b9e9893ee4f57fc283abfb">More...</a><br /></td></tr>
  161. <tr class="separator:ad871e11876b9e9893ee4f57fc283abfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a9354c3cab0a74d9d405c00781f789507"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#a9354c3cab0a74d9d405c00781f789507">LocalCredentials</a> (<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type)</td></tr>
  163. <tr class="memdesc:a9354c3cab0a74d9d405c00781f789507"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds Local Credentials. <a href="#a9354c3cab0a74d9d405c00781f789507">More...</a><br /></td></tr>
  164. <tr class="separator:a9354c3cab0a74d9d405c00781f789507"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:abfae1568a31fb0a10b4d973953ddc3b2"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#abfae1568a31fb0a10b4d973953ddc3b2">AltsServerCredentials</a> (const <a class="el" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> &amp;options)</td></tr>
  166. <tr class="memdesc:abfae1568a31fb0a10b4d973953ddc3b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds ALTS <a class="el" href="classgrpc_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="#abfae1568a31fb0a10b4d973953ddc3b2">More...</a><br /></td></tr>
  167. <tr class="separator:abfae1568a31fb0a10b4d973953ddc3b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a6076d466bcfdcb7d7678c2dcafe01f5f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc_1_1experimental.html#a6076d466bcfdcb7d7678c2dcafe01f5f">LocalServerCredentials</a> (<a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a> type)</td></tr>
  169. <tr class="memdesc:a6076d466bcfdcb7d7678c2dcafe01f5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds Local <a class="el" href="classgrpc_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a>. <a href="#a6076d466bcfdcb7d7678c2dcafe01f5f">More...</a><br /></td></tr>
  170. <tr class="separator:a6076d466bcfdcb7d7678c2dcafe01f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. </table>
  172. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  173. <div class="textblock"><p><a class="el" href="classgrpc_1_1experimental_1_1_client_rpc_info.html">ClientRpcInfo</a> represents the state of a particular RPC as it appears to an interceptor. </p>
  174. <p>It is created and owned by the library and passed to the CreateClientInterceptor method of the application's <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">ClientInterceptorFactoryInterface</a> implementation </p>
  175. </div><h2 class="groupheader">Enumeration Type Documentation</h2>
  176. <a id="a03d3481b2c4146f53e90966d4a0fd8a1"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#a03d3481b2c4146f53e90966d4a0fd8a1">&#9670;&nbsp;</a></span>InterceptionHookPoints</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="mlabels">
  181. <tr>
  182. <td class="mlabels-left">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">enum <a class="el" href="namespacegrpc_1_1experimental.html#a03d3481b2c4146f53e90966d4a0fd8a1">grpc::experimental::InterceptionHookPoints</a></td>
  186. </tr>
  187. </table>
  188. </td>
  189. <td class="mlabels-right">
  190. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. <p>An enumeration of different possible points at which the <em>Intercept</em> method of the <em><a class="el" href="classgrpc_1_1experimental_1_1_interceptor.html" title="Interface for an interceptor. ">Interceptor</a></em> interface may be called. </p>
  195. <p>Any given call to <em>Intercept</em> will include one or more of these hook points, and each hook point makes certain types of information available to the interceptor. In these enumeration names, PRE_SEND means that an interception has taken place between the time the application provided a certain type of data (e.g., initial metadata, status) and the time that that data goes to the other side. POST_SEND means that the data has been committed for going to the other side (even if it has not yet been received at the other side). PRE_RECV means an interception between the time that a certain operation has been requested and it is available. POST_RECV means that a result is available but has not yet been passed back to the application. </p>
  196. <table class="fieldtable">
  197. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a68f9cc22793a30bf451f5d94c283f371"></a>PRE_SEND_INITIAL_METADATA&#160;</td><td class="fielddoc"><p>The first two in this list are for clients and servers. </p>
  198. </td></tr>
  199. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a78e48d97d3b04c3bc07cc5e015bae473"></a>PRE_SEND_MESSAGE&#160;</td><td class="fielddoc"></td></tr>
  200. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a787bde31497aaaccd0e780928a34ba3c"></a>PRE_SEND_STATUS&#160;</td><td class="fielddoc"></td></tr>
  201. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1aae41c3d206fb78da7ea1baff522fe734"></a>PRE_SEND_CLOSE&#160;</td><td class="fielddoc"></td></tr>
  202. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1ae1edf7ebacfc20d107e332ed0df262d2"></a>PRE_RECV_INITIAL_METADATA&#160;</td><td class="fielddoc"><p>The following three are for hijacked clients only and can only be registered by the global interceptor. </p>
  203. </td></tr>
  204. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1aed5412a55f4c64aab2e6492c79c91422"></a>PRE_RECV_MESSAGE&#160;</td><td class="fielddoc"></td></tr>
  205. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1aac79efae31b3773d455797286cd0a3c3"></a>PRE_RECV_STATUS&#160;</td><td class="fielddoc"></td></tr>
  206. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a294bdaeb2f3c15f0c7529ecdb04daea8"></a>POST_RECV_INITIAL_METADATA&#160;</td><td class="fielddoc"><p>The following two are for all clients and servers. </p>
  207. </td></tr>
  208. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1ab65173742bb81f390a2bbe48279a1d22"></a>POST_RECV_MESSAGE&#160;</td><td class="fielddoc"></td></tr>
  209. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a97b298c9f3aa4e0b5b4865eaa93a5909"></a>POST_RECV_STATUS&#160;</td><td class="fielddoc"></td></tr>
  210. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a28873db230a854864aaf46ce3c7d282a"></a>POST_RECV_CLOSE&#160;</td><td class="fielddoc"></td></tr>
  211. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1afeaf95b857178c518bb74d59eb39aa23"></a>PRE_SEND_CANCEL&#160;</td><td class="fielddoc"><p>This is a special hook point available to both clients and servers when TryCancel() is performed. </p>
  212. <ul>
  213. <li>No other hook points will be present along with this.</li>
  214. <li>It is illegal for an interceptor to block/delay this operation.</li>
  215. <li>ALL interceptors see this hook point irrespective of whether the RPC was hijacked or not. </li>
  216. </ul>
  217. </td></tr>
  218. <tr><td class="fieldname"><a id="a03d3481b2c4146f53e90966d4a0fd8a1a005432205f3c52f3321eab4485d84c36"></a>NUM_INTERCEPTION_HOOKS&#160;</td><td class="fielddoc"></td></tr>
  219. </table>
  220. </div>
  221. </div>
  222. <h2 class="groupheader">Function Documentation</h2>
  223. <a id="ad871e11876b9e9893ee4f57fc283abfb"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#ad871e11876b9e9893ee4f57fc283abfb">&#9670;&nbsp;</a></span>AltsCredentials()</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc::experimental::AltsCredentials </td>
  230. <td>(</td>
  231. <td class="paramtype">const <a class="el" href="structgrpc_1_1experimental_1_1_alts_credentials_options.html">AltsCredentialsOptions</a> &amp;&#160;</td>
  232. <td class="paramname"><em>options</em></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <p>Builds ALTS Credentials given ALTS specific options. </p>
  238. </div>
  239. </div>
  240. <a id="abfae1568a31fb0a10b4d973953ddc3b2"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#abfae1568a31fb0a10b4d973953ddc3b2">&#9670;&nbsp;</a></span>AltsServerCredentials()</h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a>&gt; grpc::experimental::AltsServerCredentials </td>
  247. <td>(</td>
  248. <td class="paramtype">const <a class="el" href="structgrpc_1_1experimental_1_1_alts_server_credentials_options.html">AltsServerCredentialsOptions</a> &amp;&#160;</td>
  249. <td class="paramname"><em>options</em></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Builds ALTS <a class="el" href="classgrpc_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a> given ALTS specific options. </p>
  255. </div>
  256. </div>
  257. <a id="ab4c7e40417b37179d52667f3208f69a3"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#ab4c7e40417b37179d52667f3208f69a3">&#9670;&nbsp;</a></span>ChannelResetConnectionBackoff()</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">void grpc::experimental::ChannelResetConnectionBackoff </td>
  264. <td>(</td>
  265. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel.html">Channel</a> *&#160;</td>
  266. <td class="paramname"><em>channel</em></td><td>)</td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>Resets the channel's connection backoff. </p>
  272. <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_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a> class, or remove it. </p>
  273. </div>
  274. </div>
  275. <a id="add75d935f9366cf23255959e0baaeff5"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#add75d935f9366cf23255959e0baaeff5">&#9670;&nbsp;</a></span>CreateCustomChannelWithInterceptors()</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="memname">
  280. <tr>
  281. <td class="memname">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel.html">Channel</a> &gt; grpc::experimental::CreateCustomChannelWithInterceptors </td>
  282. <td>(</td>
  283. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  284. <td class="paramname"><em>target</em>, </td>
  285. </tr>
  286. <tr>
  287. <td class="paramkey"></td>
  288. <td></td>
  289. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;&#160;</td>
  290. <td class="paramname"><em>creds</em>, </td>
  291. </tr>
  292. <tr>
  293. <td class="paramkey"></td>
  294. <td></td>
  295. <td class="paramtype">const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &amp;&#160;</td>
  296. <td class="paramname"><em>args</em>, </td>
  297. </tr>
  298. <tr>
  299. <td class="paramkey"></td>
  300. <td></td>
  301. <td class="paramtype">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">experimental::ClientInterceptorFactoryInterface</a> &gt;&gt;&#160;</td>
  302. <td class="paramname"><em>interceptor_creators</em>&#160;</td>
  303. </tr>
  304. <tr>
  305. <td></td>
  306. <td>)</td>
  307. <td></td><td></td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Create a new <em>custom</em> <em><a class="el" href="classgrpc_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>
  312. <dl class="section warning"><dt>Warning</dt><dd>For advanced use and testing ONLY. Override default channel arguments only if necessary.</dd></dl>
  313. <dl class="params"><dt>Parameters</dt><dd>
  314. <table class="params">
  315. <tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
  316. <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>
  317. <tr><td class="paramname">args</td><td>Options for channel creation. </td></tr>
  318. </table>
  319. </dd>
  320. </dl>
  321. </div>
  322. </div>
  323. <a id="a9354c3cab0a74d9d405c00781f789507"></a>
  324. <h2 class="memtitle"><span class="permalink"><a href="#a9354c3cab0a74d9d405c00781f789507">&#9670;&nbsp;</a></span>LocalCredentials()</h2>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc::experimental::LocalCredentials </td>
  330. <td>(</td>
  331. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a>&#160;</td>
  332. <td class="paramname"><em>type</em></td><td>)</td>
  333. <td></td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <p>Builds Local Credentials. </p>
  338. </div>
  339. </div>
  340. <a id="a6076d466bcfdcb7d7678c2dcafe01f5f"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#a6076d466bcfdcb7d7678c2dcafe01f5f">&#9670;&nbsp;</a></span>LocalServerCredentials()</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a>&gt; grpc::experimental::LocalServerCredentials </td>
  347. <td>(</td>
  348. <td class="paramtype"><a class="el" href="grpc__security__constants_8h.html#a31d00ce5c064e1fff4261a6d6298dc11">grpc_local_connect_type</a>&#160;</td>
  349. <td class="paramname"><em>type</em></td><td>)</td>
  350. <td></td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Builds Local <a class="el" href="classgrpc_1_1_server_credentials.html" title="Wrapper around grpc_server_credentials, a way to authenticate a server. ">ServerCredentials</a>. </p>
  355. </div>
  356. </div>
  357. <a id="abf863776469f08e69e7ca6e82246fd7a"></a>
  358. <h2 class="memtitle"><span class="permalink"><a href="#abf863776469f08e69e7ca6e82246fd7a">&#9670;&nbsp;</a></span>RegisterGlobalClientInterceptorFactory()</h2>
  359. <div class="memitem">
  360. <div class="memproto">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">void grpc::experimental::RegisterGlobalClientInterceptorFactory </td>
  364. <td>(</td>
  365. <td class="paramtype"><a class="el" href="classgrpc_1_1experimental_1_1_client_interceptor_factory_interface.html">ClientInterceptorFactoryInterface</a> *&#160;</td>
  366. <td class="paramname"><em>factory</em></td><td>)</td>
  367. <td></td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. </div>
  372. </div>
  373. </div><!-- contents -->
  374. <!-- start footer part -->
  375. <hr class="footer"/><address class="footer"><small>
  376. Generated on Fri Jan 18 2019 16:38:52 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  377. <img class="footer" src="doxygen.png" alt="doxygen"/>
  378. </a> 1.8.13
  379. </small></address>
  380. </body>
  381. </html>