namespacegrpc__impl.html 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712
  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 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.22.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><!-- top -->
  59. <div class="header">
  60. <div class="summary">
  61. <a href="#namespaces">Namespaces</a> &#124;
  62. <a href="#nested-classes">Data Structures</a> &#124;
  63. <a href="#func-members">Functions</a> &#124;
  64. <a href="#var-members">Variables</a> </div>
  65. <div class="headertitle">
  66. <div class="title">grpc_impl Namespace Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>An <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> posts the user-provided tag to its associated completion queue or invokes the user-provided function on expiry or cancellation.
  70. <a href="#details">More...</a></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
  73. Namespaces</h2></td></tr>
  74. <tr class="memitem:namespacegrpc__impl_1_1experimental"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html">experimental</a></td></tr>
  75. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. </table><table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  78. Data Structures</h2></td></tr>
  79. <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_1_alarm.html">Alarm</a></td></tr>
  80. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <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_1_auth_metadata_processor.html">AuthMetadataProcessor</a></td></tr>
  82. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface allowing custom server-side authorization based on credentials encoded in metadata. <a href="classgrpc__impl_1_1_auth_metadata_processor.html#details">More...</a><br /></td></tr>
  83. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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_1_call_credentials.html">CallCredentials</a></td></tr>
  85. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A call credentials object encapsulates the state needed by a client to authenticate with a server for a given call on a channel. <a href="classgrpc__impl_1_1_call_credentials.html#details">More...</a><br /></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_1_channel.html">Channel</a></td></tr>
  88. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Channels represent a connection to an endpoint. Created by <em>CreateChannel</em>. <a href="classgrpc__impl_1_1_channel.html#details">More...</a><br /></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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_1_channel_arguments.html">ChannelArguments</a></td></tr>
  91. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options for channel creation. <a href="classgrpc__impl_1_1_channel_arguments.html#details">More...</a><br /></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__impl_1_1_channel_credentials.html">ChannelCredentials</a></td></tr>
  94. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A channel credentials object encapsulates all the state needed by a client to authenticate with a server for a given channel. <a href="classgrpc__impl_1_1_channel_credentials.html#details">More...</a><br /></td></tr>
  95. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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_1_client_context.html">ClientContext</a></td></tr>
  97. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classgrpc__impl_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to: ">ClientContext</a> allows the person implementing a service client to: <a href="classgrpc__impl_1_1_client_context.html#details">More...</a><br /></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__impl_1_1_completion_queue.html">CompletionQueue</a></td></tr>
  100. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A thin wrapper around <a class="el" href="grpc__types_8h.html#a895faab0e6035445750e43482651ba2f">grpc_completion_queue</a> (see src/core/lib/surface/completion_queue.h). <a href="classgrpc__impl_1_1_completion_queue.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__impl_1_1_generic_stub.html">GenericStub</a></td></tr>
  103. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic stubs provide a type-unsafe interface to call gRPC methods by name. <a href="classgrpc__impl_1_1_generic_stub.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__impl_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a></td></tr>
  106. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The gRPC server uses this interface to expose the health checking service without depending on protobuf. <a href="classgrpc__impl_1_1_health_check_service_interface.html#details">More...</a><br /></td></tr>
  107. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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_1_metadata_credentials_plugin.html">MetadataCredentialsPlugin</a></td></tr>
  109. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">User defined metadata credentials. <a href="classgrpc__impl_1_1_metadata_credentials_plugin.html#details">More...</a><br /></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_1_propagation_options.html">PropagationOptions</a></td></tr>
  112. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options for <em><a class="el" href="classgrpc__impl_1_1_client_context.html#afa03c13342f73bd135ad72214451c5b6" title="Create a new ClientContext as a child of an incoming server call, according to options (...">ClientContext::FromServerContext</a></em> specifying which traits from the <em><a class="el" href="classgrpc__impl_1_1_server_context.html" title="A ServerContext allows the person implementing a service handler to: ">ServerContext</a></em> to propagate (copy) from it into a new <em><a class="el" href="classgrpc__impl_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to: ">ClientContext</a></em>. <a href="classgrpc__impl_1_1_propagation_options.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_1_resource_quota.html">ResourceQuota</a></td></tr>
  115. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classgrpc__impl_1_1_resource_quota.html" title="ResourceQuota represents a bound on memory and thread usage by the gRPC library. ">ResourceQuota</a> represents a bound on memory and thread usage by the gRPC library. <a href="classgrpc__impl_1_1_resource_quota.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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server.html">Server</a></td></tr>
  118. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a gRPC server. <a href="classgrpc__impl_1_1_server.html#details">More...</a><br /></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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_1_server_builder.html">ServerBuilder</a></td></tr>
  121. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A builder class for the creation and startup of <em><a class="el" href="namespacegrpc.html#a28c99eb4f62e460502c80cf1e10a8fb4">grpc::Server</a></em> instances. <a href="classgrpc__impl_1_1_server_builder.html#details">More...</a><br /></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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_1_server_builder_option.html">ServerBuilderOption</a></td></tr>
  124. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to pass an option to a <em><a class="el" href="classgrpc__impl_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances. ">ServerBuilder</a></em>. <a href="classgrpc__impl_1_1_server_builder_option.html#details">More...</a><br /></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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_1_server_completion_queue.html">ServerCompletionQueue</a></td></tr>
  127. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A specific type of completion queue used by the processing of notifications by servers. <a href="classgrpc__impl_1_1_server_completion_queue.html#details">More...</a><br /></td></tr>
  128. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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_1_server_context.html">ServerContext</a></td></tr>
  130. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="classgrpc__impl_1_1_server_context.html" title="A ServerContext allows the person implementing a service handler to: ">ServerContext</a> allows the person implementing a service handler to: <a href="classgrpc__impl_1_1_server_context.html#details">More...</a><br /></td></tr>
  131. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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_1_server_credentials.html">ServerCredentials</a></td></tr>
  133. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wrapper around <em>grpc_server_credentials</em>, a way to authenticate a server. <a href="classgrpc__impl_1_1_server_credentials.html#details">More...</a><br /></td></tr>
  134. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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_1_server_initializer.html">ServerInitializer</a></td></tr>
  136. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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_1_ssl_credentials_options.html">SslCredentialsOptions</a></td></tr>
  138. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options used to build SslCredentials. <a href="structgrpc__impl_1_1_ssl_credentials_options.html#details">More...</a><br /></td></tr>
  139. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table><table class="memberdecls">
  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  142. Functions</h2></td></tr>
  143. <tr class="memitem:abee8d7d8aa88bb130b9d490dcff30bd9"><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.html#abee8d7d8aa88bb130b9d490dcff30bd9">CreateChannelImpl</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)</td></tr>
  144. <tr class="memdesc:abee8d7d8aa88bb130b9d490dcff30bd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a new <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>. <a href="#abee8d7d8aa88bb130b9d490dcff30bd9">More...</a><br /></td></tr>
  145. <tr class="separator:abee8d7d8aa88bb130b9d490dcff30bd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a0af0e855f421fdb8fb657aec0e6afdfd"><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.html#a0af0e855f421fdb8fb657aec0e6afdfd">CreateCustomChannelImpl</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)</td></tr>
  147. <tr class="memdesc:a0af0e855f421fdb8fb657aec0e6afdfd"><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>. <a href="#a0af0e855f421fdb8fb657aec0e6afdfd">More...</a><br /></td></tr>
  148. <tr class="separator:a0af0e855f421fdb8fb657aec0e6afdfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ae6811bf8d52ca9da1a93f7d0f9b9da5f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#ae6811bf8d52ca9da1a93f7d0f9b9da5f">EnableDefaultHealthCheckService</a> (bool enable)</td></tr>
  150. <tr class="memdesc:ae6811bf8d52ca9da1a93f7d0f9b9da5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/disable the default health checking service. <a href="#ae6811bf8d52ca9da1a93f7d0f9b9da5f">More...</a><br /></td></tr>
  151. <tr class="separator:ae6811bf8d52ca9da1a93f7d0f9b9da5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:affbc0f17235ded15e85a52ea9c55d2c6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#affbc0f17235ded15e85a52ea9c55d2c6">DefaultHealthCheckServiceEnabled</a> ()</td></tr>
  153. <tr class="memdesc:affbc0f17235ded15e85a52ea9c55d2c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the default health checking service is enabled. <a href="#affbc0f17235ded15e85a52ea9c55d2c6">More...</a><br /></td></tr>
  154. <tr class="separator:affbc0f17235ded15e85a52ea9c55d2c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a57a3b3a97e5511c5fb17a43ac0fe8a39"><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.html#a57a3b3a97e5511c5fb17a43ac0fe8a39">CreateCustomChannelImpl</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="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &amp;args)</td></tr>
  156. <tr class="separator:a57a3b3a97e5511c5fb17a43ac0fe8a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a716b62a52c430203845d1cb842937941"><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.html#a716b62a52c430203845d1cb842937941">GoogleDefaultCredentials</a> ()</td></tr>
  158. <tr class="memdesc:a716b62a52c430203845d1cb842937941"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds credentials with reasonable defaults. <a href="#a716b62a52c430203845d1cb842937941">More...</a><br /></td></tr>
  159. <tr class="separator:a716b62a52c430203845d1cb842937941"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:aa295989df52aba9b0ec29f1a7cb95855"><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.html#aa295989df52aba9b0ec29f1a7cb95855">SslCredentials</a> (const <a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html">SslCredentialsOptions</a> &amp;options)</td></tr>
  161. <tr class="memdesc:aa295989df52aba9b0ec29f1a7cb95855"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds SSL Credentials given SSL specific options. <a href="#aa295989df52aba9b0ec29f1a7cb95855">More...</a><br /></td></tr>
  162. <tr class="separator:aa295989df52aba9b0ec29f1a7cb95855"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a98cb7bf6726d52affdc6cdea7575de09"><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.html#a98cb7bf6726d52affdc6cdea7575de09">GoogleComputeEngineCredentials</a> ()</td></tr>
  164. <tr class="memdesc:a98cb7bf6726d52affdc6cdea7575de09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds credentials for use when running in GCE. <a href="#a98cb7bf6726d52affdc6cdea7575de09">More...</a><br /></td></tr>
  165. <tr class="separator:a98cb7bf6726d52affdc6cdea7575de09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:ac0597900fb34b4b05c81d64222f977ab"><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.html#ac0597900fb34b4b05c81d64222f977ab">ServiceAccountJWTAccessCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;json_key, long token_lifetime_seconds=<a class="el" href="namespacegrpc__impl.html#a592337ba7d1818fee23b00ac6a92997f">grpc_impl::kMaxAuthTokenLifetimeSecs</a>)</td></tr>
  167. <tr class="memdesc:ac0597900fb34b4b05c81d64222f977ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds Service Account JWT Access credentials. <a href="#ac0597900fb34b4b05c81d64222f977ab">More...</a><br /></td></tr>
  168. <tr class="separator:ac0597900fb34b4b05c81d64222f977ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:abdcdf926a18f351efe4fb138be22118e"><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.html#abdcdf926a18f351efe4fb138be22118e">GoogleRefreshTokenCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;json_refresh_token)</td></tr>
  170. <tr class="memdesc:abdcdf926a18f351efe4fb138be22118e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds refresh token credentials. <a href="#abdcdf926a18f351efe4fb138be22118e">More...</a><br /></td></tr>
  171. <tr class="separator:abdcdf926a18f351efe4fb138be22118e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a39845f5afa1f3a323186489673e35930"><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.html#a39845f5afa1f3a323186489673e35930">AccessTokenCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;access_token)</td></tr>
  173. <tr class="memdesc:a39845f5afa1f3a323186489673e35930"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds access token credentials. <a href="#a39845f5afa1f3a323186489673e35930">More...</a><br /></td></tr>
  174. <tr class="separator:a39845f5afa1f3a323186489673e35930"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:aa00f53af2d448ba0fc29b232fa870b6a"><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.html#aa00f53af2d448ba0fc29b232fa870b6a">GoogleIAMCredentials</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;authorization_token, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;authority_selector)</td></tr>
  176. <tr class="memdesc:aa00f53af2d448ba0fc29b232fa870b6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds IAM credentials. <a href="#aa00f53af2d448ba0fc29b232fa870b6a">More...</a><br /></td></tr>
  177. <tr class="separator:aa00f53af2d448ba0fc29b232fa870b6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a59409a2853f39bd444964a886a836e17"><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.html#a59409a2853f39bd444964a886a836e17">CompositeChannelCredentials</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> &gt; &amp;channel_creds, const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;call_creds)</td></tr>
  179. <tr class="memdesc:a59409a2853f39bd444964a886a836e17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines a channel credentials and a call credentials into a composite channel credentials. <a href="#a59409a2853f39bd444964a886a836e17">More...</a><br /></td></tr>
  180. <tr class="separator:a59409a2853f39bd444964a886a836e17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a326eea880361ad2aa40dd87af6d64812"><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.html#a326eea880361ad2aa40dd87af6d64812">CompositeCallCredentials</a> (const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;creds1, const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;creds2)</td></tr>
  182. <tr class="memdesc:a326eea880361ad2aa40dd87af6d64812"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines two call credentials objects into a composite call credentials. <a href="#a326eea880361ad2aa40dd87af6d64812">More...</a><br /></td></tr>
  183. <tr class="separator:a326eea880361ad2aa40dd87af6d64812"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:a13d23f83df13be5c4d3a81387478c4e4"><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.html#a13d23f83df13be5c4d3a81387478c4e4">InsecureChannelCredentials</a> ()</td></tr>
  185. <tr class="memdesc:a13d23f83df13be5c4d3a81387478c4e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Credentials for an unencrypted, unauthenticated channel. <a href="#a13d23f83df13be5c4d3a81387478c4e4">More...</a><br /></td></tr>
  186. <tr class="separator:a13d23f83df13be5c4d3a81387478c4e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a36c2f6fc21ea4a58c4d238135a8ddaeb"><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.html#a36c2f6fc21ea4a58c4d238135a8ddaeb">CronetChannelCredentials</a> (void *engine)</td></tr>
  188. <tr class="memdesc:a36c2f6fc21ea4a58c4d238135a8ddaeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Credentials for a channel using Cronet. <a href="#a36c2f6fc21ea4a58c4d238135a8ddaeb">More...</a><br /></td></tr>
  189. <tr class="separator:a36c2f6fc21ea4a58c4d238135a8ddaeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:af7f03cbfa6ec94c67c2cb9676f4841b6"><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.html#af7f03cbfa6ec94c67c2cb9676f4841b6">MetadataCredentialsFromPlugin</a> (std::unique_ptr&lt; <a class="el" href="classgrpc__impl_1_1_metadata_credentials_plugin.html">MetadataCredentialsPlugin</a> &gt; plugin)</td></tr>
  191. <tr class="separator:af7f03cbfa6ec94c67c2cb9676f4841b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a70396ff9cd00198734d857d2e446ab52"><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.html#a70396ff9cd00198734d857d2e446ab52">SslServerCredentials</a> (const <a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html">grpc::SslServerCredentialsOptions</a> &amp;options)</td></tr>
  193. <tr class="memdesc:a70396ff9cd00198734d857d2e446ab52"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds SSL <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 SSL specific options. <a href="#a70396ff9cd00198734d857d2e446ab52">More...</a><br /></td></tr>
  194. <tr class="separator:a70396ff9cd00198734d857d2e446ab52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:ae796a13e34558b944cb5c71c76bbe62e"><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.html#ae796a13e34558b944cb5c71c76bbe62e">InsecureServerCredentials</a> ()</td></tr>
  196. <tr class="memdesc:ae796a13e34558b944cb5c71c76bbe62e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds insecure server credentials. <a href="#ae796a13e34558b944cb5c71c76bbe62e">More...</a><br /></td></tr>
  197. <tr class="separator:ae796a13e34558b944cb5c71c76bbe62e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. </table><table class="memberdecls">
  199. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  200. Variables</h2></td></tr>
  201. <tr class="memitem:a592337ba7d1818fee23b00ac6a92997f"><td class="memItemLeft" align="right" valign="top">constexpr long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a592337ba7d1818fee23b00ac6a92997f">kMaxAuthTokenLifetimeSecs</a> = 3600</td></tr>
  202. <tr class="separator:a592337ba7d1818fee23b00ac6a92997f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. </table>
  204. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  205. <div class="textblock"><p>An <a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a> posts the user-provided tag to its associated completion queue or invokes the user-provided function on expiry or cancellation. </p>
  206. </div><h2 class="groupheader">Function Documentation</h2>
  207. <a id="a39845f5afa1f3a323186489673e35930"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#a39845f5afa1f3a323186489673e35930">&#9670;&nbsp;</a></span>AccessTokenCredentials()</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::AccessTokenCredentials </td>
  214. <td>(</td>
  215. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  216. <td class="paramname"><em>access_token</em></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Builds access token credentials. </p>
  222. <p>access_token is an oauth2 access token that was fetched using an out of band mechanism.</p>
  223. <dl class="section warning"><dt>Warning</dt><dd>Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services. </dd></dl>
  224. </div>
  225. </div>
  226. <a id="a326eea880361ad2aa40dd87af6d64812"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#a326eea880361ad2aa40dd87af6d64812">&#9670;&nbsp;</a></span>CompositeCallCredentials()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::CompositeCallCredentials </td>
  233. <td>(</td>
  234. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;&#160;</td>
  235. <td class="paramname"><em>creds1</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;&#160;</td>
  241. <td class="paramname"><em>creds2</em>&#160;</td>
  242. </tr>
  243. <tr>
  244. <td></td>
  245. <td>)</td>
  246. <td></td><td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Combines two call credentials objects into a composite call credentials. </p>
  251. </div>
  252. </div>
  253. <a id="a59409a2853f39bd444964a886a836e17"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#a59409a2853f39bd444964a886a836e17">&#9670;&nbsp;</a></span>CompositeChannelCredentials()</h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::CompositeChannelCredentials </td>
  260. <td>(</td>
  261. <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>
  262. <td class="paramname"><em>channel_creds</em>, </td>
  263. </tr>
  264. <tr>
  265. <td class="paramkey"></td>
  266. <td></td>
  267. <td class="paramtype">const std::shared_ptr&lt; <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> &gt; &amp;&#160;</td>
  268. <td class="paramname"><em>call_creds</em>&#160;</td>
  269. </tr>
  270. <tr>
  271. <td></td>
  272. <td>)</td>
  273. <td></td><td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Combines a channel credentials and a call credentials into a composite channel credentials. </p>
  278. </div>
  279. </div>
  280. <a id="abee8d7d8aa88bb130b9d490dcff30bd9"></a>
  281. <h2 class="memtitle"><span class="permalink"><a href="#abee8d7d8aa88bb130b9d490dcff30bd9">&#9670;&nbsp;</a></span>CreateChannelImpl()</h2>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>&gt; grpc_impl::CreateChannelImpl </td>
  287. <td>(</td>
  288. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  289. <td class="paramname"><em>target</em>, </td>
  290. </tr>
  291. <tr>
  292. <td class="paramkey"></td>
  293. <td></td>
  294. <td class="paramtype">const std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> &gt; &amp;&#160;</td>
  295. <td class="paramname"><em>creds</em>&#160;</td>
  296. </tr>
  297. <tr>
  298. <td></td>
  299. <td>)</td>
  300. <td></td><td></td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>Create a new <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>. </p>
  305. <dl class="params"><dt>Parameters</dt><dd>
  306. <table class="params">
  307. <tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
  308. <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>
  309. </table>
  310. </dd>
  311. </dl>
  312. </div>
  313. </div>
  314. <a id="a57a3b3a97e5511c5fb17a43ac0fe8a39"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#a57a3b3a97e5511c5fb17a43ac0fe8a39">&#9670;&nbsp;</a></span>CreateCustomChannelImpl() <span class="overload">[1/2]</span></h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname">std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>&gt; grpc_impl::CreateCustomChannelImpl </td>
  321. <td>(</td>
  322. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  323. <td class="paramname"><em>target</em>, </td>
  324. </tr>
  325. <tr>
  326. <td class="paramkey"></td>
  327. <td></td>
  328. <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>
  329. <td class="paramname"><em>creds</em>, </td>
  330. </tr>
  331. <tr>
  332. <td class="paramkey"></td>
  333. <td></td>
  334. <td class="paramtype">const <a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &amp;&#160;</td>
  335. <td class="paramname"><em>args</em>&#160;</td>
  336. </tr>
  337. <tr>
  338. <td></td>
  339. <td>)</td>
  340. <td></td><td></td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. </div>
  345. </div>
  346. <a id="a0af0e855f421fdb8fb657aec0e6afdfd"></a>
  347. <h2 class="memtitle"><span class="permalink"><a href="#a0af0e855f421fdb8fb657aec0e6afdfd">&#9670;&nbsp;</a></span>CreateCustomChannelImpl() <span class="overload">[2/2]</span></h2>
  348. <div class="memitem">
  349. <div class="memproto">
  350. <table class="memname">
  351. <tr>
  352. <td class="memname">std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>&gt; grpc_impl::CreateCustomChannelImpl </td>
  353. <td>(</td>
  354. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  355. <td class="paramname"><em>target</em>, </td>
  356. </tr>
  357. <tr>
  358. <td class="paramkey"></td>
  359. <td></td>
  360. <td class="paramtype">const std::shared_ptr&lt;::<a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> &gt; &amp;&#160;</td>
  361. <td class="paramname"><em>creds</em>, </td>
  362. </tr>
  363. <tr>
  364. <td class="paramkey"></td>
  365. <td></td>
  366. <td class="paramtype">const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &amp;&#160;</td>
  367. <td class="paramname"><em>args</em>&#160;</td>
  368. </tr>
  369. <tr>
  370. <td></td>
  371. <td>)</td>
  372. <td></td><td></td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <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>. </p>
  377. <dl class="section warning"><dt>Warning</dt><dd>For advanced use and testing ONLY. Override default channel arguments only if necessary.</dd></dl>
  378. <dl class="params"><dt>Parameters</dt><dd>
  379. <table class="params">
  380. <tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
  381. <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>
  382. <tr><td class="paramname">args</td><td>Options for channel creation. </td></tr>
  383. </table>
  384. </dd>
  385. </dl>
  386. </div>
  387. </div>
  388. <a id="a36c2f6fc21ea4a58c4d238135a8ddaeb"></a>
  389. <h2 class="memtitle"><span class="permalink"><a href="#a36c2f6fc21ea4a58c4d238135a8ddaeb">&#9670;&nbsp;</a></span>CronetChannelCredentials()</h2>
  390. <div class="memitem">
  391. <div class="memproto">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::CronetChannelCredentials </td>
  395. <td>(</td>
  396. <td class="paramtype">void *&#160;</td>
  397. <td class="paramname"><em>engine</em></td><td>)</td>
  398. <td></td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Credentials for a channel using Cronet. </p>
  403. </div>
  404. </div>
  405. <a id="affbc0f17235ded15e85a52ea9c55d2c6"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#affbc0f17235ded15e85a52ea9c55d2c6">&#9670;&nbsp;</a></span>DefaultHealthCheckServiceEnabled()</h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">bool grpc_impl::DefaultHealthCheckServiceEnabled </td>
  412. <td>(</td>
  413. <td class="paramname"></td><td>)</td>
  414. <td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Returns whether the default health checking service is enabled. </p>
  419. <p>NOT thread safe. </p>
  420. </div>
  421. </div>
  422. <a id="ae6811bf8d52ca9da1a93f7d0f9b9da5f"></a>
  423. <h2 class="memtitle"><span class="permalink"><a href="#ae6811bf8d52ca9da1a93f7d0f9b9da5f">&#9670;&nbsp;</a></span>EnableDefaultHealthCheckService()</h2>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">void grpc_impl::EnableDefaultHealthCheckService </td>
  429. <td>(</td>
  430. <td class="paramtype">bool&#160;</td>
  431. <td class="paramname"><em>enable</em></td><td>)</td>
  432. <td></td>
  433. </tr>
  434. </table>
  435. </div><div class="memdoc">
  436. <p>Enable/disable the default health checking service. </p>
  437. <p>This applies to all C++ servers created afterwards. For each server, user can override the default with a HealthCheckServiceServerBuilderOption. NOT thread safe. </p>
  438. </div>
  439. </div>
  440. <a id="a98cb7bf6726d52affdc6cdea7575de09"></a>
  441. <h2 class="memtitle"><span class="permalink"><a href="#a98cb7bf6726d52affdc6cdea7575de09">&#9670;&nbsp;</a></span>GoogleComputeEngineCredentials()</h2>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::GoogleComputeEngineCredentials </td>
  447. <td>(</td>
  448. <td class="paramname"></td><td>)</td>
  449. <td></td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Builds credentials for use when running in GCE. </p>
  454. <dl class="section warning"><dt>Warning</dt><dd>Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services. </dd></dl>
  455. </div>
  456. </div>
  457. <a id="a716b62a52c430203845d1cb842937941"></a>
  458. <h2 class="memtitle"><span class="permalink"><a href="#a716b62a52c430203845d1cb842937941">&#9670;&nbsp;</a></span>GoogleDefaultCredentials()</h2>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::GoogleDefaultCredentials </td>
  464. <td>(</td>
  465. <td class="paramname"></td><td>)</td>
  466. <td></td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Builds credentials with reasonable defaults. </p>
  471. <dl class="section warning"><dt>Warning</dt><dd>Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services. </dd></dl>
  472. </div>
  473. </div>
  474. <a id="aa00f53af2d448ba0fc29b232fa870b6a"></a>
  475. <h2 class="memtitle"><span class="permalink"><a href="#aa00f53af2d448ba0fc29b232fa870b6a">&#9670;&nbsp;</a></span>GoogleIAMCredentials()</h2>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="memname">
  479. <tr>
  480. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::GoogleIAMCredentials </td>
  481. <td>(</td>
  482. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  483. <td class="paramname"><em>authorization_token</em>, </td>
  484. </tr>
  485. <tr>
  486. <td class="paramkey"></td>
  487. <td></td>
  488. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  489. <td class="paramname"><em>authority_selector</em>&#160;</td>
  490. </tr>
  491. <tr>
  492. <td></td>
  493. <td>)</td>
  494. <td></td><td></td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>Builds IAM credentials. </p>
  499. <dl class="section warning"><dt>Warning</dt><dd>Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services. </dd></dl>
  500. </div>
  501. </div>
  502. <a id="abdcdf926a18f351efe4fb138be22118e"></a>
  503. <h2 class="memtitle"><span class="permalink"><a href="#abdcdf926a18f351efe4fb138be22118e">&#9670;&nbsp;</a></span>GoogleRefreshTokenCredentials()</h2>
  504. <div class="memitem">
  505. <div class="memproto">
  506. <table class="memname">
  507. <tr>
  508. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::GoogleRefreshTokenCredentials </td>
  509. <td>(</td>
  510. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  511. <td class="paramname"><em>json_refresh_token</em></td><td>)</td>
  512. <td></td>
  513. </tr>
  514. </table>
  515. </div><div class="memdoc">
  516. <p>Builds refresh token credentials. </p>
  517. <p>json_refresh_token is the JSON string containing the refresh token along with a client_id and client_secret.</p>
  518. <dl class="section warning"><dt>Warning</dt><dd>Only use these credentials when connecting to a Google endpoint. Using these credentials to connect to any other service may result in this service being able to impersonate your client for requests to Google services. </dd></dl>
  519. </div>
  520. </div>
  521. <a id="a13d23f83df13be5c4d3a81387478c4e4"></a>
  522. <h2 class="memtitle"><span class="permalink"><a href="#a13d23f83df13be5c4d3a81387478c4e4">&#9670;&nbsp;</a></span>InsecureChannelCredentials()</h2>
  523. <div class="memitem">
  524. <div class="memproto">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::InsecureChannelCredentials </td>
  528. <td>(</td>
  529. <td class="paramname"></td><td>)</td>
  530. <td></td>
  531. </tr>
  532. </table>
  533. </div><div class="memdoc">
  534. <p>Credentials for an unencrypted, unauthenticated channel. </p>
  535. </div>
  536. </div>
  537. <a id="ae796a13e34558b944cb5c71c76bbe62e"></a>
  538. <h2 class="memtitle"><span class="permalink"><a href="#ae796a13e34558b944cb5c71c76bbe62e">&#9670;&nbsp;</a></span>InsecureServerCredentials()</h2>
  539. <div class="memitem">
  540. <div class="memproto">
  541. <table class="memname">
  542. <tr>
  543. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>&gt; grpc_impl::InsecureServerCredentials </td>
  544. <td>(</td>
  545. <td class="paramname"></td><td>)</td>
  546. <td></td>
  547. </tr>
  548. </table>
  549. </div><div class="memdoc">
  550. <p>Builds insecure server credentials. </p>
  551. </div>
  552. </div>
  553. <a id="af7f03cbfa6ec94c67c2cb9676f4841b6"></a>
  554. <h2 class="memtitle"><span class="permalink"><a href="#af7f03cbfa6ec94c67c2cb9676f4841b6">&#9670;&nbsp;</a></span>MetadataCredentialsFromPlugin()</h2>
  555. <div class="memitem">
  556. <div class="memproto">
  557. <table class="memname">
  558. <tr>
  559. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::MetadataCredentialsFromPlugin </td>
  560. <td>(</td>
  561. <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classgrpc__impl_1_1_metadata_credentials_plugin.html">MetadataCredentialsPlugin</a> &gt;&#160;</td>
  562. <td class="paramname"><em>plugin</em></td><td>)</td>
  563. <td></td>
  564. </tr>
  565. </table>
  566. </div><div class="memdoc">
  567. </div>
  568. </div>
  569. <a id="ac0597900fb34b4b05c81d64222f977ab"></a>
  570. <h2 class="memtitle"><span class="permalink"><a href="#ac0597900fb34b4b05c81d64222f977ab">&#9670;&nbsp;</a></span>ServiceAccountJWTAccessCredentials()</h2>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="memname">
  574. <tr>
  575. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>&gt; grpc_impl::ServiceAccountJWTAccessCredentials </td>
  576. <td>(</td>
  577. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  578. <td class="paramname"><em>json_key</em>, </td>
  579. </tr>
  580. <tr>
  581. <td class="paramkey"></td>
  582. <td></td>
  583. <td class="paramtype">long&#160;</td>
  584. <td class="paramname"><em>token_lifetime_seconds</em> = <code><a class="el" href="namespacegrpc__impl.html#a592337ba7d1818fee23b00ac6a92997f">grpc_impl::kMaxAuthTokenLifetimeSecs</a></code>&#160;</td>
  585. </tr>
  586. <tr>
  587. <td></td>
  588. <td>)</td>
  589. <td></td><td></td>
  590. </tr>
  591. </table>
  592. </div><div class="memdoc">
  593. <p>Builds Service Account JWT Access credentials. </p>
  594. <p>json_key is the JSON key string containing the client's private key. token_lifetime_seconds is the lifetime in seconds of each Json Web Token (JWT) created with this credentials. It should not exceed <em>kMaxAuthTokenLifetimeSecs</em> or will be cropped to this value. </p>
  595. </div>
  596. </div>
  597. <a id="aa295989df52aba9b0ec29f1a7cb95855"></a>
  598. <h2 class="memtitle"><span class="permalink"><a href="#aa295989df52aba9b0ec29f1a7cb95855">&#9670;&nbsp;</a></span>SslCredentials()</h2>
  599. <div class="memitem">
  600. <div class="memproto">
  601. <table class="memname">
  602. <tr>
  603. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>&gt; grpc_impl::SslCredentials </td>
  604. <td>(</td>
  605. <td class="paramtype">const <a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html">SslCredentialsOptions</a> &amp;&#160;</td>
  606. <td class="paramname"><em>options</em></td><td>)</td>
  607. <td></td>
  608. </tr>
  609. </table>
  610. </div><div class="memdoc">
  611. <p>Builds SSL Credentials given SSL specific options. </p>
  612. </div>
  613. </div>
  614. <a id="a70396ff9cd00198734d857d2e446ab52"></a>
  615. <h2 class="memtitle"><span class="permalink"><a href="#a70396ff9cd00198734d857d2e446ab52">&#9670;&nbsp;</a></span>SslServerCredentials()</h2>
  616. <div class="memitem">
  617. <div class="memproto">
  618. <table class="memname">
  619. <tr>
  620. <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>&gt; grpc_impl::SslServerCredentials </td>
  621. <td>(</td>
  622. <td class="paramtype">const <a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html">grpc::SslServerCredentialsOptions</a> &amp;&#160;</td>
  623. <td class="paramname"><em>options</em></td><td>)</td>
  624. <td></td>
  625. </tr>
  626. </table>
  627. </div><div class="memdoc">
  628. <p>Builds SSL <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 SSL specific options. </p>
  629. </div>
  630. </div>
  631. <h2 class="groupheader">Variable Documentation</h2>
  632. <a id="a592337ba7d1818fee23b00ac6a92997f"></a>
  633. <h2 class="memtitle"><span class="permalink"><a href="#a592337ba7d1818fee23b00ac6a92997f">&#9670;&nbsp;</a></span>kMaxAuthTokenLifetimeSecs</h2>
  634. <div class="memitem">
  635. <div class="memproto">
  636. <table class="memname">
  637. <tr>
  638. <td class="memname">constexpr long grpc_impl::kMaxAuthTokenLifetimeSecs = 3600</td>
  639. </tr>
  640. </table>
  641. </div><div class="memdoc">
  642. </div>
  643. </div>
  644. </div><!-- contents -->
  645. <!-- start footer part -->
  646. <hr class="footer"/><address class="footer"><small>
  647. Generated on Wed Jul 3 2019 14:51:27 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  648. <img class="footer" src="doxygen.png" alt="doxygen"/>
  649. </a> 1.8.13
  650. </small></address>
  651. </body>
  652. </html>