Grpc.Core.ChannelCredentials.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class ChannelCredentials
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ChannelCredentials
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.ChannelCredentials">
  73. <h1 id="Grpc_Core_ChannelCredentials" data-uid="Grpc.Core.ChannelCredentials" class="text-break">Class ChannelCredentials
  74. </h1>
  75. <div class="markdown level0 summary"><p>Client-side channel credentials. Used for creation of a secure channel.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">ChannelCredentials</span></div>
  82. <div class="level2"><a class="xref" href="Grpc.Core.SslCredentials.html">SslCredentials</a></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <span class="xref">System.Object.Equals(System.Object)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Object.GetHashCode()</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetType()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.MemberwiseClone()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Object.ToString()</span>
  106. </div>
  107. </div>
  108. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  109. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  110. <h5 id="Grpc_Core_ChannelCredentials_syntax">Syntax</h5>
  111. <div class="codewrapper">
  112. <pre><code class="lang-csharp hljs">public abstract class ChannelCredentials</code></pre>
  113. </div>
  114. <h3 id="constructors">Constructors
  115. </h3>
  116. <a id="Grpc_Core_ChannelCredentials__ctor_" data-uid="Grpc.Core.ChannelCredentials.#ctor*"></a>
  117. <h4 id="Grpc_Core_ChannelCredentials__ctor" data-uid="Grpc.Core.ChannelCredentials.#ctor">ChannelCredentials()</h4>
  118. <div class="markdown level1 summary"><p>Creates a new instance of channel credentials</p>
  119. </div>
  120. <div class="markdown level1 conceptual"></div>
  121. <h5 class="decalaration">Declaration</h5>
  122. <div class="codewrapper">
  123. <pre><code class="lang-csharp hljs">public ChannelCredentials()</code></pre>
  124. </div>
  125. <h3 id="properties">Properties
  126. </h3>
  127. <a id="Grpc_Core_ChannelCredentials_Insecure_" data-uid="Grpc.Core.ChannelCredentials.Insecure*"></a>
  128. <h4 id="Grpc_Core_ChannelCredentials_Insecure" data-uid="Grpc.Core.ChannelCredentials.Insecure">Insecure</h4>
  129. <div class="markdown level1 summary"><p>Returns instance of credentials that provides no security and
  130. will result in creating an unsecure channel with no encryption whatsoever.</p>
  131. </div>
  132. <div class="markdown level1 conceptual"></div>
  133. <h5 class="decalaration">Declaration</h5>
  134. <div class="codewrapper">
  135. <pre><code class="lang-csharp hljs">public static ChannelCredentials Insecure { get; }</code></pre>
  136. </div>
  137. <h5 class="propertyValue">Property Value</h5>
  138. <table class="table table-bordered table-striped table-condensed">
  139. <thead>
  140. <tr>
  141. <th>Type</th>
  142. <th>Description</th>
  143. </tr>
  144. </thead>
  145. <tbody>
  146. <tr>
  147. <td><a class="xref" href="Grpc.Core.ChannelCredentials.html">ChannelCredentials</a></td>
  148. <td></td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <h3 id="methods">Methods
  153. </h3>
  154. <a id="Grpc_Core_ChannelCredentials_Create_" data-uid="Grpc.Core.ChannelCredentials.Create*"></a>
  155. <h4 id="Grpc_Core_ChannelCredentials_Create_Grpc_Core_ChannelCredentials_Grpc_Core_CallCredentials_" data-uid="Grpc.Core.ChannelCredentials.Create(Grpc.Core.ChannelCredentials,Grpc.Core.CallCredentials)">Create(ChannelCredentials, CallCredentials)</h4>
  156. <div class="markdown level1 summary"><p>Creates a new instance of <code>ChannelCredentials</code> class by composing
  157. given channel credentials with call credentials.</p>
  158. </div>
  159. <div class="markdown level1 conceptual"></div>
  160. <h5 class="decalaration">Declaration</h5>
  161. <div class="codewrapper">
  162. <pre><code class="lang-csharp hljs">public static ChannelCredentials Create(ChannelCredentials channelCredentials, CallCredentials callCredentials)</code></pre>
  163. </div>
  164. <h5 class="parameters">Parameters</h5>
  165. <table class="table table-bordered table-striped table-condensed">
  166. <thead>
  167. <tr>
  168. <th>Type</th>
  169. <th>Name</th>
  170. <th>Description</th>
  171. </tr>
  172. </thead>
  173. <tbody>
  174. <tr>
  175. <td><a class="xref" href="Grpc.Core.ChannelCredentials.html">ChannelCredentials</a></td>
  176. <td><span class="parametername">channelCredentials</span></td>
  177. <td><p>Channel credentials.</p>
  178. </td>
  179. </tr>
  180. <tr>
  181. <td><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a></td>
  182. <td><span class="parametername">callCredentials</span></td>
  183. <td><p>Call credentials.</p>
  184. </td>
  185. </tr>
  186. </tbody>
  187. </table>
  188. <h5 class="returns">Returns</h5>
  189. <table class="table table-bordered table-striped table-condensed">
  190. <thead>
  191. <tr>
  192. <th>Type</th>
  193. <th>Description</th>
  194. </tr>
  195. </thead>
  196. <tbody>
  197. <tr>
  198. <td><a class="xref" href="Grpc.Core.ChannelCredentials.html">ChannelCredentials</a></td>
  199. <td><p>The new composite <code>ChannelCredentials</code></p>
  200. </td>
  201. </tr>
  202. </tbody>
  203. </table>
  204. <a id="Grpc_Core_ChannelCredentials_InternalPopulateConfiguration_" data-uid="Grpc.Core.ChannelCredentials.InternalPopulateConfiguration*"></a>
  205. <h4 id="Grpc_Core_ChannelCredentials_InternalPopulateConfiguration_Grpc_Core_ChannelCredentialsConfiguratorBase_System_Object_" data-uid="Grpc.Core.ChannelCredentials.InternalPopulateConfiguration(Grpc.Core.ChannelCredentialsConfiguratorBase,System.Object)">InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase, Object)</h4>
  206. <div class="markdown level1 summary"><p>Populates channel credentials configurator with this instance&apos;s configuration.
  207. End users never need to invoke this method as it is part of internal implementation.</p>
  208. </div>
  209. <div class="markdown level1 conceptual"></div>
  210. <h5 class="decalaration">Declaration</h5>
  211. <div class="codewrapper">
  212. <pre><code class="lang-csharp hljs">public abstract void InternalPopulateConfiguration(ChannelCredentialsConfiguratorBase configurator, object state)</code></pre>
  213. </div>
  214. <h5 class="parameters">Parameters</h5>
  215. <table class="table table-bordered table-striped table-condensed">
  216. <thead>
  217. <tr>
  218. <th>Type</th>
  219. <th>Name</th>
  220. <th>Description</th>
  221. </tr>
  222. </thead>
  223. <tbody>
  224. <tr>
  225. <td><a class="xref" href="Grpc.Core.ChannelCredentialsConfiguratorBase.html">ChannelCredentialsConfiguratorBase</a></td>
  226. <td><span class="parametername">configurator</span></td>
  227. <td></td>
  228. </tr>
  229. <tr>
  230. <td><span class="xref">System.Object</span></td>
  231. <td><span class="parametername">state</span></td>
  232. <td></td>
  233. </tr>
  234. </tbody>
  235. </table>
  236. </article>
  237. </div>
  238. <div class="hidden-sm col-md-2" role="complementary">
  239. <div class="sideaffix">
  240. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  241. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  242. </nav>
  243. </div>
  244. </div>
  245. </div>
  246. </div>
  247. <footer>
  248. <div class="grad-bottom"></div>
  249. <div class="footer">
  250. <div class="container">
  251. <span class="pull-right">
  252. <a href="#top">Back to top</a>
  253. </span>
  254. <span>Generated by <strong>DocFX</strong></span>
  255. </div>
  256. </div>
  257. </footer>
  258. </div>
  259. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  260. <script type="text/javascript" src="../styles/docfx.js"></script>
  261. <script type="text/javascript" src="../styles/main.js"></script>
  262. </body>
  263. </html>