713 lines
54 KiB
HTML
713 lines
54 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GRPC C++: grpc_impl Namespace Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">GRPC C++
|
|
 <span id="projectnumber">1.22.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">grpc_impl Namespace Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<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.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespacegrpc__impl_1_1experimental"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl_1_1experimental.html">experimental</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_alarm.html">Alarm</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_auth_metadata_processor.html">AuthMetadataProcessor</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel.html">Channel</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_arguments.html">ChannelArguments</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Options for channel creation. <a href="classgrpc__impl_1_1_channel_arguments.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_context.html">ClientContext</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_completion_queue.html">CompletionQueue</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_generic_stub.html">GenericStub</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_metadata_credentials_plugin.html">MetadataCredentialsPlugin</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">User defined metadata credentials. <a href="classgrpc__impl_1_1_metadata_credentials_plugin.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_propagation_options.html">PropagationOptions</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_resource_quota.html">ResourceQuota</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server.html">Server</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Represents a gRPC server. <a href="classgrpc__impl_1_1_server.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_builder.html">ServerBuilder</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_builder_option.html">ServerBuilderOption</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_completion_queue.html">ServerCompletionQueue</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_context.html">ServerContext</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_server_initializer.html">ServerInitializer</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html">SslCredentialsOptions</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </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>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:abee8d7d8aa88bb130b9d490dcff30bd9"><td class="memItemLeft" align="right" valign="top">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a> > </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> &target, const std::shared_ptr<::<a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> > &creds)</td></tr>
|
|
<tr class="memdesc:abee8d7d8aa88bb130b9d490dcff30bd9"><td class="mdescLeft"> </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>
|
|
<tr class="separator:abee8d7d8aa88bb130b9d490dcff30bd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0af0e855f421fdb8fb657aec0e6afdfd"><td class="memItemLeft" align="right" valign="top">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a> > </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> &target, const std::shared_ptr<::<a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> > &creds, const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &args)</td></tr>
|
|
<tr class="memdesc:a0af0e855f421fdb8fb657aec0e6afdfd"><td class="mdescLeft"> </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>
|
|
<tr class="separator:a0af0e855f421fdb8fb657aec0e6afdfd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6811bf8d52ca9da1a93f7d0f9b9da5f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#ae6811bf8d52ca9da1a93f7d0f9b9da5f">EnableDefaultHealthCheckService</a> (bool enable)</td></tr>
|
|
<tr class="memdesc:ae6811bf8d52ca9da1a93f7d0f9b9da5f"><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable the default health checking service. <a href="#ae6811bf8d52ca9da1a93f7d0f9b9da5f">More...</a><br /></td></tr>
|
|
<tr class="separator:ae6811bf8d52ca9da1a93f7d0f9b9da5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affbc0f17235ded15e85a52ea9c55d2c6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#affbc0f17235ded15e85a52ea9c55d2c6">DefaultHealthCheckServiceEnabled</a> ()</td></tr>
|
|
<tr class="memdesc:affbc0f17235ded15e85a52ea9c55d2c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the default health checking service is enabled. <a href="#affbc0f17235ded15e85a52ea9c55d2c6">More...</a><br /></td></tr>
|
|
<tr class="separator:affbc0f17235ded15e85a52ea9c55d2c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a57a3b3a97e5511c5fb17a43ac0fe8a39"><td class="memItemLeft" align="right" valign="top">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a> > </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> &target, const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > &creds, const <a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> &args)</td></tr>
|
|
<tr class="separator:a57a3b3a97e5511c5fb17a43ac0fe8a39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a716b62a52c430203845d1cb842937941"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a716b62a52c430203845d1cb842937941">GoogleDefaultCredentials</a> ()</td></tr>
|
|
<tr class="memdesc:a716b62a52c430203845d1cb842937941"><td class="mdescLeft"> </td><td class="mdescRight">Builds credentials with reasonable defaults. <a href="#a716b62a52c430203845d1cb842937941">More...</a><br /></td></tr>
|
|
<tr class="separator:a716b62a52c430203845d1cb842937941"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa295989df52aba9b0ec29f1a7cb95855"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </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> &options)</td></tr>
|
|
<tr class="memdesc:aa295989df52aba9b0ec29f1a7cb95855"><td class="mdescLeft"> </td><td class="mdescRight">Builds SSL Credentials given SSL specific options. <a href="#aa295989df52aba9b0ec29f1a7cb95855">More...</a><br /></td></tr>
|
|
<tr class="separator:aa295989df52aba9b0ec29f1a7cb95855"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98cb7bf6726d52affdc6cdea7575de09"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a98cb7bf6726d52affdc6cdea7575de09">GoogleComputeEngineCredentials</a> ()</td></tr>
|
|
<tr class="memdesc:a98cb7bf6726d52affdc6cdea7575de09"><td class="mdescLeft"> </td><td class="mdescRight">Builds credentials for use when running in GCE. <a href="#a98cb7bf6726d52affdc6cdea7575de09">More...</a><br /></td></tr>
|
|
<tr class="separator:a98cb7bf6726d52affdc6cdea7575de09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac0597900fb34b4b05c81d64222f977ab"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </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> &json_key, long token_lifetime_seconds=<a class="el" href="namespacegrpc__impl.html#a592337ba7d1818fee23b00ac6a92997f">grpc_impl::kMaxAuthTokenLifetimeSecs</a>)</td></tr>
|
|
<tr class="memdesc:ac0597900fb34b4b05c81d64222f977ab"><td class="mdescLeft"> </td><td class="mdescRight">Builds Service Account JWT Access credentials. <a href="#ac0597900fb34b4b05c81d64222f977ab">More...</a><br /></td></tr>
|
|
<tr class="separator:ac0597900fb34b4b05c81d64222f977ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abdcdf926a18f351efe4fb138be22118e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </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> &json_refresh_token)</td></tr>
|
|
<tr class="memdesc:abdcdf926a18f351efe4fb138be22118e"><td class="mdescLeft"> </td><td class="mdescRight">Builds refresh token credentials. <a href="#abdcdf926a18f351efe4fb138be22118e">More...</a><br /></td></tr>
|
|
<tr class="separator:abdcdf926a18f351efe4fb138be22118e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39845f5afa1f3a323186489673e35930"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </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> &access_token)</td></tr>
|
|
<tr class="memdesc:a39845f5afa1f3a323186489673e35930"><td class="mdescLeft"> </td><td class="mdescRight">Builds access token credentials. <a href="#a39845f5afa1f3a323186489673e35930">More...</a><br /></td></tr>
|
|
<tr class="separator:a39845f5afa1f3a323186489673e35930"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa00f53af2d448ba0fc29b232fa870b6a"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </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> &authorization_token, const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &authority_selector)</td></tr>
|
|
<tr class="memdesc:aa00f53af2d448ba0fc29b232fa870b6a"><td class="mdescLeft"> </td><td class="mdescRight">Builds IAM credentials. <a href="#aa00f53af2d448ba0fc29b232fa870b6a">More...</a><br /></td></tr>
|
|
<tr class="separator:aa00f53af2d448ba0fc29b232fa870b6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59409a2853f39bd444964a886a836e17"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a59409a2853f39bd444964a886a836e17">CompositeChannelCredentials</a> (const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > &channel_creds, const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > &call_creds)</td></tr>
|
|
<tr class="memdesc:a59409a2853f39bd444964a886a836e17"><td class="mdescLeft"> </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>
|
|
<tr class="separator:a59409a2853f39bd444964a886a836e17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a326eea880361ad2aa40dd87af6d64812"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a326eea880361ad2aa40dd87af6d64812">CompositeCallCredentials</a> (const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > &creds1, const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > &creds2)</td></tr>
|
|
<tr class="memdesc:a326eea880361ad2aa40dd87af6d64812"><td class="mdescLeft"> </td><td class="mdescRight">Combines two call credentials objects into a composite call credentials. <a href="#a326eea880361ad2aa40dd87af6d64812">More...</a><br /></td></tr>
|
|
<tr class="separator:a326eea880361ad2aa40dd87af6d64812"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13d23f83df13be5c4d3a81387478c4e4"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a13d23f83df13be5c4d3a81387478c4e4">InsecureChannelCredentials</a> ()</td></tr>
|
|
<tr class="memdesc:a13d23f83df13be5c4d3a81387478c4e4"><td class="mdescLeft"> </td><td class="mdescRight">Credentials for an unencrypted, unauthenticated channel. <a href="#a13d23f83df13be5c4d3a81387478c4e4">More...</a><br /></td></tr>
|
|
<tr class="separator:a13d23f83df13be5c4d3a81387478c4e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36c2f6fc21ea4a58c4d238135a8ddaeb"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a36c2f6fc21ea4a58c4d238135a8ddaeb">CronetChannelCredentials</a> (void *engine)</td></tr>
|
|
<tr class="memdesc:a36c2f6fc21ea4a58c4d238135a8ddaeb"><td class="mdescLeft"> </td><td class="mdescRight">Credentials for a channel using Cronet. <a href="#a36c2f6fc21ea4a58c4d238135a8ddaeb">More...</a><br /></td></tr>
|
|
<tr class="separator:a36c2f6fc21ea4a58c4d238135a8ddaeb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7f03cbfa6ec94c67c2cb9676f4841b6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#af7f03cbfa6ec94c67c2cb9676f4841b6">MetadataCredentialsFromPlugin</a> (std::unique_ptr< <a class="el" href="classgrpc__impl_1_1_metadata_credentials_plugin.html">MetadataCredentialsPlugin</a> > plugin)</td></tr>
|
|
<tr class="separator:af7f03cbfa6ec94c67c2cb9676f4841b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70396ff9cd00198734d857d2e446ab52"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a> > </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> &options)</td></tr>
|
|
<tr class="memdesc:a70396ff9cd00198734d857d2e446ab52"><td class="mdescLeft"> </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>
|
|
<tr class="separator:a70396ff9cd00198734d857d2e446ab52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae796a13e34558b944cb5c71c76bbe62e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#ae796a13e34558b944cb5c71c76bbe62e">InsecureServerCredentials</a> ()</td></tr>
|
|
<tr class="memdesc:ae796a13e34558b944cb5c71c76bbe62e"><td class="mdescLeft"> </td><td class="mdescRight">Builds insecure server credentials. <a href="#ae796a13e34558b944cb5c71c76bbe62e">More...</a><br /></td></tr>
|
|
<tr class="separator:ae796a13e34558b944cb5c71c76bbe62e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a592337ba7d1818fee23b00ac6a92997f"><td class="memItemLeft" align="right" valign="top">constexpr long </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegrpc__impl.html#a592337ba7d1818fee23b00ac6a92997f">kMaxAuthTokenLifetimeSecs</a> = 3600</td></tr>
|
|
<tr class="separator:a592337ba7d1818fee23b00ac6a92997f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<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>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a39845f5afa1f3a323186489673e35930"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39845f5afa1f3a323186489673e35930">◆ </a></span>AccessTokenCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::AccessTokenCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>access_token</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds access token credentials. </p>
|
|
<p>access_token is an oauth2 access token that was fetched using an out of band mechanism.</p>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a326eea880361ad2aa40dd87af6d64812"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a326eea880361ad2aa40dd87af6d64812">◆ </a></span>CompositeCallCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::CompositeCallCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > & </td>
|
|
<td class="paramname"><em>creds1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > & </td>
|
|
<td class="paramname"><em>creds2</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Combines two call credentials objects into a composite call credentials. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59409a2853f39bd444964a886a836e17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59409a2853f39bd444964a886a836e17">◆ </a></span>CompositeChannelCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::CompositeChannelCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > & </td>
|
|
<td class="paramname"><em>channel_creds</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a> > & </td>
|
|
<td class="paramname"><em>call_creds</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Combines a channel credentials and a call credentials into a composite channel credentials. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abee8d7d8aa88bb130b9d490dcff30bd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abee8d7d8aa88bb130b9d490dcff30bd9">◆ </a></span>CreateChannelImpl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> grpc_impl::CreateChannelImpl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::shared_ptr<::<a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> > & </td>
|
|
<td class="paramname"><em>creds</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
|
|
<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>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a57a3b3a97e5511c5fb17a43ac0fe8a39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57a3b3a97e5511c5fb17a43ac0fe8a39">◆ </a></span>CreateCustomChannelImpl() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> grpc_impl::CreateCustomChannelImpl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a> > & </td>
|
|
<td class="paramname"><em>creds</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> & </td>
|
|
<td class="paramname"><em>args</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0af0e855f421fdb8fb657aec0e6afdfd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0af0e855f421fdb8fb657aec0e6afdfd">◆ </a></span>CreateCustomChannelImpl() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<::<a class="el" href="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">grpc::Channel</a>> grpc_impl::CreateCustomChannelImpl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::shared_ptr<::<a class="el" href="namespacegrpc.html#aaf2939b1b4a48aa00606f8e986bf21de">grpc::ChannelCredentials</a> > & </td>
|
|
<td class="paramname"><em>creds</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const ::<a class="el" href="namespacegrpc.html#a0fb985b4797b9d239bc8164ed1bad223">grpc::ChannelArguments</a> & </td>
|
|
<td class="paramname"><em>args</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
<dl class="section warning"><dt>Warning</dt><dd>For advanced use and testing ONLY. Override default channel arguments only if necessary.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">target</td><td>The URI of the endpoint to connect to. </td></tr>
|
|
<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>
|
|
<tr><td class="paramname">args</td><td>Options for channel creation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36c2f6fc21ea4a58c4d238135a8ddaeb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36c2f6fc21ea4a58c4d238135a8ddaeb">◆ </a></span>CronetChannelCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::CronetChannelCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>engine</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Credentials for a channel using Cronet. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="affbc0f17235ded15e85a52ea9c55d2c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#affbc0f17235ded15e85a52ea9c55d2c6">◆ </a></span>DefaultHealthCheckServiceEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool grpc_impl::DefaultHealthCheckServiceEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns whether the default health checking service is enabled. </p>
|
|
<p>NOT thread safe. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae6811bf8d52ca9da1a93f7d0f9b9da5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6811bf8d52ca9da1a93f7d0f9b9da5f">◆ </a></span>EnableDefaultHealthCheckService()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void grpc_impl::EnableDefaultHealthCheckService </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable/disable the default health checking service. </p>
|
|
<p>This applies to all C++ servers created afterwards. For each server, user can override the default with a HealthCheckServiceServerBuilderOption. NOT thread safe. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a98cb7bf6726d52affdc6cdea7575de09"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a98cb7bf6726d52affdc6cdea7575de09">◆ </a></span>GoogleComputeEngineCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::GoogleComputeEngineCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds credentials for use when running in GCE. </p>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a716b62a52c430203845d1cb842937941"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a716b62a52c430203845d1cb842937941">◆ </a></span>GoogleDefaultCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::GoogleDefaultCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds credentials with reasonable defaults. </p>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa00f53af2d448ba0fc29b232fa870b6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa00f53af2d448ba0fc29b232fa870b6a">◆ </a></span>GoogleIAMCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::GoogleIAMCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>authorization_token</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>authority_selector</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds IAM credentials. </p>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abdcdf926a18f351efe4fb138be22118e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abdcdf926a18f351efe4fb138be22118e">◆ </a></span>GoogleRefreshTokenCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::GoogleRefreshTokenCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>json_refresh_token</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds refresh token credentials. </p>
|
|
<p>json_refresh_token is the JSON string containing the refresh token along with a client_id and client_secret.</p>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a13d23f83df13be5c4d3a81387478c4e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13d23f83df13be5c4d3a81387478c4e4">◆ </a></span>InsecureChannelCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::InsecureChannelCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Credentials for an unencrypted, unauthenticated channel. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae796a13e34558b944cb5c71c76bbe62e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae796a13e34558b944cb5c71c76bbe62e">◆ </a></span>InsecureServerCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>> grpc_impl::InsecureServerCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds insecure server credentials. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7f03cbfa6ec94c67c2cb9676f4841b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7f03cbfa6ec94c67c2cb9676f4841b6">◆ </a></span>MetadataCredentialsFromPlugin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::MetadataCredentialsFromPlugin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::unique_ptr< <a class="el" href="classgrpc__impl_1_1_metadata_credentials_plugin.html">MetadataCredentialsPlugin</a> > </td>
|
|
<td class="paramname"><em>plugin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac0597900fb34b4b05c81d64222f977ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac0597900fb34b4b05c81d64222f977ab">◆ </a></span>ServiceAccountJWTAccessCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_call_credentials.html">CallCredentials</a>> grpc_impl::ServiceAccountJWTAccessCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> & </td>
|
|
<td class="paramname"><em>json_key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>token_lifetime_seconds</em> = <code><a class="el" href="namespacegrpc__impl.html#a592337ba7d1818fee23b00ac6a92997f">grpc_impl::kMaxAuthTokenLifetimeSecs</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds Service Account JWT Access credentials. </p>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa295989df52aba9b0ec29f1a7cb95855"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa295989df52aba9b0ec29f1a7cb95855">◆ </a></span>SslCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_channel_credentials.html">ChannelCredentials</a>> grpc_impl::SslCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structgrpc__impl_1_1_ssl_credentials_options.html">SslCredentialsOptions</a> & </td>
|
|
<td class="paramname"><em>options</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Builds SSL Credentials given SSL specific options. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a70396ff9cd00198734d857d2e446ab52"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a70396ff9cd00198734d857d2e446ab52">◆ </a></span>SslServerCredentials()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<<a class="el" href="classgrpc__impl_1_1_server_credentials.html">ServerCredentials</a>> grpc_impl::SslServerCredentials </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structgrpc_1_1_ssl_server_credentials_options.html">grpc::SslServerCredentialsOptions</a> & </td>
|
|
<td class="paramname"><em>options</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a592337ba7d1818fee23b00ac6a92997f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a592337ba7d1818fee23b00ac6a92997f">◆ </a></span>kMaxAuthTokenLifetimeSecs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">constexpr long grpc_impl::kMaxAuthTokenLifetimeSecs = 3600</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Jul 3 2019 14:51:27 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|