diff options
| author |  Craig Tiller <ctiller@google.com> | 2015-09-24 10:56:38 -0700 |
|---|---|---|
| committer | Craig Tiller <ctiller@google.com> | 2015-09-24 10:56:38 -0700 |
| commit | 5c329efca8fbacb7e8801092ae6d15e8ede339ec (patch) | |
| tree | d4cb9d24244dceec1be2d0db6497bffb8c94c450 /doc/ref/c++/html/classgrpc_1_1_credentials.html | |
| parent | 9e71674ab942c748f24e945327424163c15b5e66 (diff) | |
Remove docs from master
Diffstat (limited to 'doc/ref/c++/html/classgrpc_1_1_credentials.html')
| -rw-r--r-- | doc/ref/c++/html/classgrpc_1_1_credentials.html | 299 |
1 files changed, 0 insertions, 299 deletions
diff --git a/doc/ref/c++/html/classgrpc_1_1_credentials.html b/doc/ref/c++/html/classgrpc_1_1_credentials.html deleted file mode 100644 index 780d18eab7..0000000000 --- a/doc/ref/c++/html/classgrpc_1_1_credentials.html +++ /dev/null @@ -1,299 +0,0 @@ -<!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.6"/> -<title>GRPC C++: grpc::Credentials Class 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/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); -</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 style="padding-left: 0.5em;"> - <div id="projectname">GRPC C++ -  <span id="projectnumber">0.11.0.0</span> - </div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="namespaces.html"><span>Namespaces</span></a></li> - <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> - <li><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="annotated.html"><span>Data Structures</span></a></li> - <li><a href="classes.html"><span>Data Structure Index</span></a></li> - <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> - <li><a href="functions.html"><span>Data Fields</span></a></li> - </ul> - </div> -<!-- window showing the filter options --> -<div id="MSearchSelectWindow" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - onkeydown="return searchBox.OnSearchSelectKey(event)"> -<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a></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 id="nav-path" class="navpath"> - <ul> -<li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_credentials.html">Credentials</a></li> </ul> -</div> -</div><!-- top --> -<div class="header"> - <div class="summary"> -<a href="#pub-methods">Public Member Functions</a> | -<a href="#pro-methods">Protected Member Functions</a> | -<a href="#friends">Friends</a> </div> - <div class="headertitle"> -<div class="title">grpc::Credentials Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> -</div><!--header--> -<div class="contents"> - -<p>A credentials object encapsulates all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client’s identity, role, or whether it is authorized to make a particular call. - <a href="classgrpc_1_1_credentials.html#details">More...</a></p> - -<p><code>#include <<a class="el" href="credentials_8h_source.html">credentials.h</a>></code></p> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> -Public Member Functions</h2></td></tr> -<tr class="memitem:af4e8a65a6cee2b847e11134671c213f2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_credentials.html#af4e8a65a6cee2b847e11134671c213f2">~Credentials</a> () <a class="el" href="config_8h.html#a9a884d706be26697c9c892365a3402a9">GRPC_OVERRIDE</a></td></tr> -<tr class="separator:af4e8a65a6cee2b847e11134671c213f2"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2b3162e0dbb4530ac1c4b81a0339b1e1"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_credentials.html#a2b3162e0dbb4530ac1c4b81a0339b1e1">ApplyToCall</a> (grpc_call *call)=0</td></tr> -<tr class="memdesc:a2b3162e0dbb4530ac1c4b81a0339b1e1"><td class="mdescLeft"> </td><td class="mdescRight">Apply this instance's credentials to <em>call</em>. <a href="#a2b3162e0dbb4530ac1c4b81a0339b1e1">More...</a><br/></td></tr> -<tr class="separator:a2b3162e0dbb4530ac1c4b81a0339b1e1"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="inherit_header pub_methods_classgrpc_1_1_grpc_library"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_grpc_library')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1_grpc_library.html">grpc::GrpcLibrary</a></td></tr> -<tr class="memitem:af026f86430cf235d7eaf532231a44528 inherit pub_methods_classgrpc_1_1_grpc_library"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_grpc_library.html#af026f86430cf235d7eaf532231a44528">GrpcLibrary</a> ()</td></tr> -<tr class="separator:af026f86430cf235d7eaf532231a44528 inherit pub_methods_classgrpc_1_1_grpc_library"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:adadb2fbc794175c8c4578bf283b009a8 inherit pub_methods_classgrpc_1_1_grpc_library"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_grpc_library.html#adadb2fbc794175c8c4578bf283b009a8">~GrpcLibrary</a> ()</td></tr> -<tr class="separator:adadb2fbc794175c8c4578bf283b009a8 inherit pub_methods_classgrpc_1_1_grpc_library"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> -Protected Member Functions</h2></td></tr> -<tr class="memitem:aefc960d2b52b15f2561946e0f840874f"><td class="memItemLeft" align="right" valign="top">virtual SecureCredentials * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_credentials.html#aefc960d2b52b15f2561946e0f840874f">AsSecureCredentials</a> ()=0</td></tr> -<tr class="separator:aefc960d2b52b15f2561946e0f840874f"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> -Friends</h2></td></tr> -<tr class="memitem:a319db47fafb1868e66fd34b8bc084f3f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc_1_1_credentials.html">Credentials</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_credentials.html#a319db47fafb1868e66fd34b8bc084f3f">CompositeCredentials</a> (const std::shared_ptr< <a class="el" href="classgrpc_1_1_credentials.html">Credentials</a> > &creds1, const std::shared_ptr< <a class="el" href="classgrpc_1_1_credentials.html">Credentials</a> > &creds2)</td></tr> -<tr class="memdesc:a319db47fafb1868e66fd34b8bc084f3f"><td class="mdescLeft"> </td><td class="mdescRight">Combines two credentials objects into a composite credentials. <a href="#a319db47fafb1868e66fd34b8bc084f3f">More...</a><br/></td></tr> -<tr class="separator:a319db47fafb1868e66fd34b8bc084f3f"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afb30314a85772af23b1b6c8f34c0be65"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classgrpc_1_1_channel.html">Channel</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_credentials.html#afb30314a85772af23b1b6c8f34c0be65">CreateCustomChannel</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &target, const std::shared_ptr< <a class="el" href="classgrpc_1_1_credentials.html">Credentials</a> > &creds, const <a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> &args)</td></tr> -<tr class="memdesc:afb30314a85772af23b1b6c8f34c0be65"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <em>custom</em> <em><a class="el" href="classgrpc_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a></em> pointing to <em>target</em>. <a href="#afb30314a85772af23b1b6c8f34c0be65">More...</a><br/></td></tr> -<tr class="separator:afb30314a85772af23b1b6c8f34c0be65"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>A credentials object encapsulates all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client’s identity, role, or whether it is authorized to make a particular call. </p> -<dl class="section see"><dt>See Also</dt><dd><a href="https://github.com/grpc/grpc/blob/master/doc/grpc-auth-support.md">https://github.com/grpc/grpc/blob/master/doc/grpc-auth-support.md</a> </dd></dl> -</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a class="anchor" id="af4e8a65a6cee2b847e11134671c213f2"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">grpc::Credentials::~Credentials </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -</div> -</div> -<h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="a2b3162e0dbb4530ac1c4b81a0339b1e1"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">virtual bool grpc::Credentials::ApplyToCall </td> - <td>(</td> - <td class="paramtype">grpc_call * </td> - <td class="paramname"><em>call</em></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Apply this instance's credentials to <em>call</em>. </p> - -</div> -</div> -<a class="anchor" id="aefc960d2b52b15f2561946e0f840874f"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">virtual SecureCredentials* grpc::Credentials::AsSecureCredentials </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -</div> -</div> -<h2 class="groupheader">Friends And Related Function Documentation</h2> -<a class="anchor" id="a319db47fafb1868e66fd34b8bc084f3f"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">std::shared_ptr<<a class="el" href="classgrpc_1_1_credentials.html">Credentials</a>> CompositeCredentials </td> - <td>(</td> - <td class="paramtype">const std::shared_ptr< <a class="el" href="classgrpc_1_1_credentials.html">Credentials</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_1_1_credentials.html">Credentials</a> > & </td> - <td class="paramname"><em>creds2</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">friend</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Combines two credentials objects into a composite credentials. </p> - -</div> -</div> -<a class="anchor" id="afb30314a85772af23b1b6c8f34c0be65"></a> -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">std::shared_ptr<<a class="el" href="classgrpc_1_1_channel.html">Channel</a>> CreateCustomChannel </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_1_1_credentials.html">Credentials</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="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> & </td> - <td class="paramname"><em>args</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">friend</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Create a new <em>custom</em> <em><a class="el" href="classgrpc_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel. ">Channel</a></em> pointing to <em>target</em>. </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><a class="el" href="classgrpc_1_1_credentials.html" title="A credentials object encapsulates all the state needed by a client to authenticate with a server and ...">Credentials</a> to use for the created channel. If it does not hold an object or is invalid, a lame channel is returned. </td></tr> - <tr><td class="paramname">args</td><td>Options for channel creation. </td></tr> - </table> - </dd> -</dl> - -</div> -</div> -<hr/>The documentation for this class was generated from the following file:<ul> -<li>include/grpc++/security/<a class="el" href="credentials_8h_source.html">credentials.h</a></li> -</ul> -</div><!-- contents --> -<!-- start footer part --> -<hr class="footer"/><address class="footer"><small> -Generated on Thu Sep 3 2015 09:44:12 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.6 -</small></address> -</body> -</html> |