structgrpc__auth__metadata__context.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  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.6"/>
  7. <title>GRPC Core: grpc_auth_metadata_context Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC Core
  26. &#160;<span id="projectnumber">4.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <div id="navrow2" class="tabs2">
  64. <ul class="tablist">
  65. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  66. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-attribs">Data Fields</a> </div>
  86. <div class="headertitle">
  87. <div class="title">grpc_auth_metadata_context Struct Reference</div> </div>
  88. </div><!--header-->
  89. <div class="contents">
  90. <p>Context that can be used by metadata credentials plugin in order to create auth related metadata.
  91. <a href="structgrpc__auth__metadata__context.html#details">More...</a></p>
  92. <p><code>#include &lt;<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a>&gt;</code></p>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  95. Data Fields</h2></td></tr>
  96. <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>
  97. <tr class="memdesc:a67ff8c2ebf38b5511da3d3194d72e01d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The fully qualifed service url. <a href="#a67ff8c2ebf38b5511da3d3194d72e01d">More...</a><br/></td></tr>
  98. <tr class="separator:a67ff8c2ebf38b5511da3d3194d72e01d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <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="#ad031faf41efeaae29c4f71d67a0d2cb3">More...</a><br/></td></tr>
  101. <tr class="separator:ad031faf41efeaae29c4f71d67a0d2cb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <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="#a7cb596d3af7463816fdde64f3e18dbde">More...</a><br/></td></tr>
  104. <tr class="separator:a7cb596d3af7463816fdde64f3e18dbde"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="memdesc:a0ca2d1c0da619c1e50cef8437f1ef517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved for future use. <a href="#a0ca2d1c0da619c1e50cef8437f1ef517">More...</a><br/></td></tr>
  107. <tr class="separator:a0ca2d1c0da619c1e50cef8437f1ef517"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table>
  109. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  110. <div class="textblock"><p>Context that can be used by metadata credentials plugin in order to create auth related metadata. </p>
  111. </div><h2 class="groupheader">Field Documentation</h2>
  112. <a class="anchor" id="a7cb596d3af7463816fdde64f3e18dbde"></a>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <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>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>The auth_context of the channel which gives the server's identity. </p>
  122. </div>
  123. </div>
  124. <a class="anchor" id="ad031faf41efeaae29c4f71d67a0d2cb3"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">const char* grpc_auth_metadata_context::method_name</td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>The method name of the RPC being called (not fully qualified). </p>
  134. <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>
  135. </div>
  136. </div>
  137. <a class="anchor" id="a0ca2d1c0da619c1e50cef8437f1ef517"></a>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">void* grpc_auth_metadata_context::reserved</td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Reserved for future use. </p>
  147. </div>
  148. </div>
  149. <a class="anchor" id="a67ff8c2ebf38b5511da3d3194d72e01d"></a>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">const char* grpc_auth_metadata_context::service_url</td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>The fully qualifed service url. </p>
  159. </div>
  160. </div>
  161. <hr/>The documentation for this struct was generated from the following file:<ul>
  162. <li>include/grpc/<a class="el" href="grpc__security_8h_source.html">grpc_security.h</a></li>
  163. </ul>
  164. </div><!-- contents -->
  165. <!-- start footer part -->
  166. <hr class="footer"/><address class="footer"><small>
  167. Generated on Wed Jun 21 2017 14:13:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  168. <img class="footer" src="doxygen.png" alt="doxygen"/>
  169. </a> 1.8.6
  170. </small></address>
  171. </body>
  172. </html>