structgrpc_1_1_ssl_credentials_options.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  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 C++: grpc::SslCredentialsOptions 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 C++
  26. &#160;<span id="projectnumber">0.11.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="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><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 id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html">SslCredentialsOptions</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-attribs">Data Fields</a> </div>
  90. <div class="headertitle">
  91. <div class="title">grpc::SslCredentialsOptions Struct Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <p>Options used to build SslCredentials.
  95. <a href="structgrpc_1_1_ssl_credentials_options.html#details">More...</a></p>
  96. <p><code>#include &lt;<a class="el" href="credentials_8h_source.html">credentials.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  99. Data Fields</h2></td></tr>
  100. <tr class="memitem:a0ce1730020e18d04b6af48c88e069869"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html#a0ce1730020e18d04b6af48c88e069869">pem_root_certs</a></td></tr>
  101. <tr class="memdesc:a0ce1730020e18d04b6af48c88e069869"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the server root certificates. <a href="#a0ce1730020e18d04b6af48c88e069869">More...</a><br/></td></tr>
  102. <tr class="separator:a0ce1730020e18d04b6af48c88e069869"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a5b661f8daf02db7283774e0fb9a8979e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html#a5b661f8daf02db7283774e0fb9a8979e">pem_private_key</a></td></tr>
  104. <tr class="memdesc:a5b661f8daf02db7283774e0fb9a8979e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the client's private key. <a href="#a5b661f8daf02db7283774e0fb9a8979e">More...</a><br/></td></tr>
  105. <tr class="separator:a5b661f8daf02db7283774e0fb9a8979e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a01015d8ec7dbf49f2ac3cd21f21d383b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc_1_1_ssl_credentials_options.html#a01015d8ec7dbf49f2ac3cd21f21d383b">pem_cert_chain</a></td></tr>
  107. <tr class="memdesc:a01015d8ec7dbf49f2ac3cd21f21d383b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer containing the PEM encoding of the client's certificate chain. <a href="#a01015d8ec7dbf49f2ac3cd21f21d383b">More...</a><br/></td></tr>
  108. <tr class="separator:a01015d8ec7dbf49f2ac3cd21f21d383b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table>
  110. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  111. <div class="textblock"><p>Options used to build SslCredentials. </p>
  112. </div><h2 class="groupheader">Field Documentation</h2>
  113. <a class="anchor" id="a01015d8ec7dbf49f2ac3cd21f21d383b"></a>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::SslCredentialsOptions::pem_cert_chain</td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>The buffer containing the PEM encoding of the client's certificate chain. </p>
  123. <p>This parameter can be empty if the client does not have a certificate chain. </p>
  124. </div>
  125. </div>
  126. <a class="anchor" id="a5b661f8daf02db7283774e0fb9a8979e"></a>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::SslCredentialsOptions::pem_private_key</td>
  132. </tr>
  133. </table>
  134. </div><div class="memdoc">
  135. <p>The buffer containing the PEM encoding of the client's private key. </p>
  136. <p>This parameter can be empty if the client does not have a private key. </p>
  137. </div>
  138. </div>
  139. <a class="anchor" id="a0ce1730020e18d04b6af48c88e069869"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::SslCredentialsOptions::pem_root_certs</td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>The buffer containing the PEM encoding of the server root certificates. </p>
  149. <p>If this parameter is empty, the default roots will be used. The default roots can be overridden using the <em>GRPC_DEFAULT_SSL_ROOTS_FILE_PATH</em> environment variable pointing to a file on the file system containing the roots. </p>
  150. </div>
  151. </div>
  152. <hr/>The documentation for this struct was generated from the following file:<ul>
  153. <li>include/grpc++/security/<a class="el" href="credentials_8h_source.html">credentials.h</a></li>
  154. </ul>
  155. </div><!-- contents -->
  156. <!-- start footer part -->
  157. <hr class="footer"/><address class="footer"><small>
  158. Generated on Tue Oct 27 2015 21:07:30 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  159. <img class="footer" src="doxygen.png" alt="doxygen"/>
  160. </a> 1.8.6
  161. </small></address>
  162. </body>
  163. </html>