structgrpc__auth__metadata__context.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc_auth_metadata_context Struct 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.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-attribs">Data Fields</a> </div>
  65. <div class="headertitle">
  66. <div class="title">grpc_auth_metadata_context Struct Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Context that can be used by metadata credentials plugin in order to create auth related metadata.
  70. <a href="structgrpc__auth__metadata__context.html#details">More...</a></p>
  71. <p><code>#include &lt;<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  74. Data Fields</h2></td></tr>
  75. <tr class="memitem:a67ff8c2ebf38b5511da3d3194d72e01d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html#a67ff8c2ebf38b5511da3d3194d72e01d">service_url</a></td></tr>
  76. <tr class="memdesc:a67ff8c2ebf38b5511da3d3194d72e01d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The fully qualifed service url. <a href="structgrpc__auth__metadata__context.html#a67ff8c2ebf38b5511da3d3194d72e01d">More...</a><br /></td></tr>
  77. <tr class="separator:a67ff8c2ebf38b5511da3d3194d72e01d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ad031faf41efeaae29c4f71d67a0d2cb3"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html#ad031faf41efeaae29c4f71d67a0d2cb3">method_name</a></td></tr>
  79. <tr class="memdesc:ad031faf41efeaae29c4f71d67a0d2cb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The method name of the RPC being called (not fully qualified). <a href="structgrpc__auth__metadata__context.html#ad031faf41efeaae29c4f71d67a0d2cb3">More...</a><br /></td></tr>
  80. <tr class="separator:ad031faf41efeaae29c4f71d67a0d2cb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a7cb596d3af7463816fdde64f3e18dbde"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html#a7cb596d3af7463816fdde64f3e18dbde">channel_auth_context</a></td></tr>
  82. <tr class="memdesc:a7cb596d3af7463816fdde64f3e18dbde"><td class="mdescLeft">&#160;</td><td class="mdescRight">The auth_context of the channel which gives the server's identity. <a href="structgrpc__auth__metadata__context.html#a7cb596d3af7463816fdde64f3e18dbde">More...</a><br /></td></tr>
  83. <tr class="separator:a7cb596d3af7463816fdde64f3e18dbde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a0ca2d1c0da619c1e50cef8437f1ef517"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__auth__metadata__context.html#a0ca2d1c0da619c1e50cef8437f1ef517">reserved</a></td></tr>
  85. <tr class="memdesc:a0ca2d1c0da619c1e50cef8437f1ef517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future use. <a href="structgrpc__auth__metadata__context.html#a0ca2d1c0da619c1e50cef8437f1ef517">More...</a><br /></td></tr>
  86. <tr class="separator:a0ca2d1c0da619c1e50cef8437f1ef517"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table>
  88. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  89. <div class="textblock"><p>Context that can be used by metadata credentials plugin in order to create auth related metadata. </p>
  90. </div><h2 class="groupheader">Field Documentation</h2>
  91. <a id="a7cb596d3af7463816fdde64f3e18dbde"></a>
  92. <h2 class="memtitle"><span class="permalink"><a href="#a7cb596d3af7463816fdde64f3e18dbde">&#9670;&nbsp;</a></span>channel_auth_context</h2>
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">const <a class="el" href="grpc__security_8h.html#aa13f0724cb7ff99995d7f0881c01d553">grpc_auth_context</a>* grpc_auth_metadata_context::channel_auth_context</td>
  98. </tr>
  99. </table>
  100. </div><div class="memdoc">
  101. <p>The auth_context of the channel which gives the server's identity. </p>
  102. </div>
  103. </div>
  104. <a id="ad031faf41efeaae29c4f71d67a0d2cb3"></a>
  105. <h2 class="memtitle"><span class="permalink"><a href="#ad031faf41efeaae29c4f71d67a0d2cb3">&#9670;&nbsp;</a></span>method_name</h2>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname">const char* grpc_auth_metadata_context::method_name</td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. <p>The method name of the RPC being called (not fully qualified). </p>
  115. <p>The fully qualified method name can be built from the service_url: full_qualified_method_name = ctx-&gt;service_url + '/' + ctx-&gt;method_name. </p>
  116. </div>
  117. </div>
  118. <a id="a0ca2d1c0da619c1e50cef8437f1ef517"></a>
  119. <h2 class="memtitle"><span class="permalink"><a href="#a0ca2d1c0da619c1e50cef8437f1ef517">&#9670;&nbsp;</a></span>reserved</h2>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">void* grpc_auth_metadata_context::reserved</td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Reserved for future use. </p>
  129. </div>
  130. </div>
  131. <a id="a67ff8c2ebf38b5511da3d3194d72e01d"></a>
  132. <h2 class="memtitle"><span class="permalink"><a href="#a67ff8c2ebf38b5511da3d3194d72e01d">&#9670;&nbsp;</a></span>service_url</h2>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">const char* grpc_auth_metadata_context::service_url</td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>The fully qualifed service url. </p>
  142. </div>
  143. </div>
  144. <hr/>The documentation for this struct was generated from the following file:<ul>
  145. <li>include/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
  146. </ul>
  147. </div><!-- contents -->
  148. <!-- start footer part -->
  149. <hr class="footer"/><address class="footer"><small>
  150. Generated on Wed Mar 3 2021 19:17:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  151. <img class="footer" src="doxygen.png" alt="doxygen"/>
  152. </a> 1.8.17
  153. </small></address>
  154. </body>
  155. </html>