Grpc.Core.Utils.GrpcPreconditions.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394
  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 GrpcPreconditions
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class GrpcPreconditions
  11. | gRPC C# ">
  12. <meta name="generator" content="docfx 2.23.1.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">
  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"></div>
  58. <ul id="pagination"></ul>
  59. </div>
  60. </div>
  61. <div role="main" class="container body-content hide-when-search">
  62. <div class="sidenav hide-when-search">
  63. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  64. <div class="sidetoggle collapse" id="sidetoggle">
  65. <div id="sidetoc"></div>
  66. </div>
  67. </div>
  68. <div class="article row grid-right">
  69. <div class="col-md-10">
  70. <article class="content wrap" id="_content" data-uid="Grpc.Core.Utils.GrpcPreconditions">
  71. <h1 id="Grpc_Core_Utils_GrpcPreconditions" data-uid="Grpc.Core.Utils.GrpcPreconditions" class="text-break">Class GrpcPreconditions
  72. </h1>
  73. <div class="markdown level0 summary"><p>Utility methods to simplify checking preconditions in the code.</p>
  74. </div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="inheritance">
  77. <h5>Inheritance</h5>
  78. <div class="level0"><span class="xref">System.Object</span></div>
  79. <div class="level1"><span class="xref">GrpcPreconditions</span></div>
  80. </div>
  81. <div class="inheritedMembers">
  82. <h5>Inherited Members</h5>
  83. <div>
  84. <span class="xref">System.Object.ToString()</span>
  85. </div>
  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.ReferenceEquals(System.Object, System.Object)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Object.GetHashCode()</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Object.GetType()</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Object.MemberwiseClone()</span>
  103. </div>
  104. </div>
  105. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.Utils.html">Grpc.Core.Utils</a></h6>
  106. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  107. <h5 id="Grpc_Core_Utils_GrpcPreconditions_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public static class GrpcPreconditions</code></pre>
  110. </div>
  111. <h3 id="methods">Methods
  112. </h3>
  113. <a id="Grpc_Core_Utils_GrpcPreconditions_CheckArgument_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckArgument*"></a>
  114. <h4 id="Grpc_Core_Utils_GrpcPreconditions_CheckArgument_System_Boolean_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckArgument(System.Boolean)">CheckArgument(Boolean)</h4>
  115. <div class="markdown level1 summary"><p>Throws <span class="xref">System.ArgumentException</span> if condition is false.</p>
  116. </div>
  117. <div class="markdown level1 conceptual"></div>
  118. <h5 class="decalaration">Declaration</h5>
  119. <div class="codewrapper">
  120. <pre><code class="lang-csharp hljs">public static void CheckArgument(bool condition)</code></pre>
  121. </div>
  122. <h5 class="parameters">Parameters</h5>
  123. <table class="table table-bordered table-striped table-condensed">
  124. <thead>
  125. <tr>
  126. <th>Type</th>
  127. <th>Name</th>
  128. <th>Description</th>
  129. </tr>
  130. </thead>
  131. <tbody>
  132. <tr>
  133. <td><span class="xref">System.Boolean</span></td>
  134. <td><span class="parametername">condition</span></td>
  135. <td><p>The condition.</p>
  136. </td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. <a id="Grpc_Core_Utils_GrpcPreconditions_CheckArgument_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckArgument*"></a>
  141. <h4 id="Grpc_Core_Utils_GrpcPreconditions_CheckArgument_System_Boolean_System_String_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckArgument(System.Boolean,System.String)">CheckArgument(Boolean, String)</h4>
  142. <div class="markdown level1 summary"><p>Throws <span class="xref">System.ArgumentException</span> with given message if condition is false.</p>
  143. </div>
  144. <div class="markdown level1 conceptual"></div>
  145. <h5 class="decalaration">Declaration</h5>
  146. <div class="codewrapper">
  147. <pre><code class="lang-csharp hljs">public static void CheckArgument(bool condition, string errorMessage)</code></pre>
  148. </div>
  149. <h5 class="parameters">Parameters</h5>
  150. <table class="table table-bordered table-striped table-condensed">
  151. <thead>
  152. <tr>
  153. <th>Type</th>
  154. <th>Name</th>
  155. <th>Description</th>
  156. </tr>
  157. </thead>
  158. <tbody>
  159. <tr>
  160. <td><span class="xref">System.Boolean</span></td>
  161. <td><span class="parametername">condition</span></td>
  162. <td><p>The condition.</p>
  163. </td>
  164. </tr>
  165. <tr>
  166. <td><span class="xref">System.String</span></td>
  167. <td><span class="parametername">errorMessage</span></td>
  168. <td><p>The error message.</p>
  169. </td>
  170. </tr>
  171. </tbody>
  172. </table>
  173. <a id="Grpc_Core_Utils_GrpcPreconditions_CheckNotNull_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckNotNull*"></a>
  174. <h4 id="Grpc_Core_Utils_GrpcPreconditions_CheckNotNull__1___0_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckNotNull``1(``0)">CheckNotNull&lt;T&gt;(T)</h4>
  175. <div class="markdown level1 summary"><p>Throws <span class="xref">System.ArgumentNullException</span> if reference is null.</p>
  176. </div>
  177. <div class="markdown level1 conceptual"></div>
  178. <h5 class="decalaration">Declaration</h5>
  179. <div class="codewrapper">
  180. <pre><code class="lang-csharp hljs">public static T CheckNotNull&lt;T&gt;(T reference)</code></pre>
  181. </div>
  182. <h5 class="parameters">Parameters</h5>
  183. <table class="table table-bordered table-striped table-condensed">
  184. <thead>
  185. <tr>
  186. <th>Type</th>
  187. <th>Name</th>
  188. <th>Description</th>
  189. </tr>
  190. </thead>
  191. <tbody>
  192. <tr>
  193. <td><span class="xref">T</span></td>
  194. <td><span class="parametername">reference</span></td>
  195. <td><p>The reference.</p>
  196. </td>
  197. </tr>
  198. </tbody>
  199. </table>
  200. <h5 class="returns">Returns</h5>
  201. <table class="table table-bordered table-striped table-condensed">
  202. <thead>
  203. <tr>
  204. <th>Type</th>
  205. <th>Description</th>
  206. </tr>
  207. </thead>
  208. <tbody>
  209. <tr>
  210. <td><span class="xref">T</span></td>
  211. <td></td>
  212. </tr>
  213. </tbody>
  214. </table>
  215. <h5 class="typeParameters">Type Parameters</h5>
  216. <table class="table table-bordered table-striped table-condensed">
  217. <thead>
  218. <tr>
  219. <th>Name</th>
  220. <th>Description</th>
  221. </tr>
  222. </thead>
  223. <tbody>
  224. <tr>
  225. <td><span class="parametername">T</span></td>
  226. <td></td>
  227. </tr>
  228. </tbody>
  229. </table>
  230. <a id="Grpc_Core_Utils_GrpcPreconditions_CheckNotNull_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckNotNull*"></a>
  231. <h4 id="Grpc_Core_Utils_GrpcPreconditions_CheckNotNull__1___0_System_String_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckNotNull``1(``0,System.String)">CheckNotNull&lt;T&gt;(T, String)</h4>
  232. <div class="markdown level1 summary"><p>Throws <span class="xref">System.ArgumentNullException</span> if reference is null.</p>
  233. </div>
  234. <div class="markdown level1 conceptual"></div>
  235. <h5 class="decalaration">Declaration</h5>
  236. <div class="codewrapper">
  237. <pre><code class="lang-csharp hljs">public static T CheckNotNull&lt;T&gt;(T reference, string paramName)</code></pre>
  238. </div>
  239. <h5 class="parameters">Parameters</h5>
  240. <table class="table table-bordered table-striped table-condensed">
  241. <thead>
  242. <tr>
  243. <th>Type</th>
  244. <th>Name</th>
  245. <th>Description</th>
  246. </tr>
  247. </thead>
  248. <tbody>
  249. <tr>
  250. <td><span class="xref">T</span></td>
  251. <td><span class="parametername">reference</span></td>
  252. <td><p>The reference.</p>
  253. </td>
  254. </tr>
  255. <tr>
  256. <td><span class="xref">System.String</span></td>
  257. <td><span class="parametername">paramName</span></td>
  258. <td><p>The parameter name.</p>
  259. </td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <h5 class="returns">Returns</h5>
  264. <table class="table table-bordered table-striped table-condensed">
  265. <thead>
  266. <tr>
  267. <th>Type</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><span class="xref">T</span></td>
  274. <td></td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. <h5 class="typeParameters">Type Parameters</h5>
  279. <table class="table table-bordered table-striped table-condensed">
  280. <thead>
  281. <tr>
  282. <th>Name</th>
  283. <th>Description</th>
  284. </tr>
  285. </thead>
  286. <tbody>
  287. <tr>
  288. <td><span class="parametername">T</span></td>
  289. <td></td>
  290. </tr>
  291. </tbody>
  292. </table>
  293. <a id="Grpc_Core_Utils_GrpcPreconditions_CheckState_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckState*"></a>
  294. <h4 id="Grpc_Core_Utils_GrpcPreconditions_CheckState_System_Boolean_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckState(System.Boolean)">CheckState(Boolean)</h4>
  295. <div class="markdown level1 summary"><p>Throws <span class="xref">System.InvalidOperationException</span> if condition is false.</p>
  296. </div>
  297. <div class="markdown level1 conceptual"></div>
  298. <h5 class="decalaration">Declaration</h5>
  299. <div class="codewrapper">
  300. <pre><code class="lang-csharp hljs">public static void CheckState(bool condition)</code></pre>
  301. </div>
  302. <h5 class="parameters">Parameters</h5>
  303. <table class="table table-bordered table-striped table-condensed">
  304. <thead>
  305. <tr>
  306. <th>Type</th>
  307. <th>Name</th>
  308. <th>Description</th>
  309. </tr>
  310. </thead>
  311. <tbody>
  312. <tr>
  313. <td><span class="xref">System.Boolean</span></td>
  314. <td><span class="parametername">condition</span></td>
  315. <td><p>The condition.</p>
  316. </td>
  317. </tr>
  318. </tbody>
  319. </table>
  320. <a id="Grpc_Core_Utils_GrpcPreconditions_CheckState_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckState*"></a>
  321. <h4 id="Grpc_Core_Utils_GrpcPreconditions_CheckState_System_Boolean_System_String_" data-uid="Grpc.Core.Utils.GrpcPreconditions.CheckState(System.Boolean,System.String)">CheckState(Boolean, String)</h4>
  322. <div class="markdown level1 summary"><p>Throws <span class="xref">System.InvalidOperationException</span> with given message if condition is false.</p>
  323. </div>
  324. <div class="markdown level1 conceptual"></div>
  325. <h5 class="decalaration">Declaration</h5>
  326. <div class="codewrapper">
  327. <pre><code class="lang-csharp hljs">public static void CheckState(bool condition, string errorMessage)</code></pre>
  328. </div>
  329. <h5 class="parameters">Parameters</h5>
  330. <table class="table table-bordered table-striped table-condensed">
  331. <thead>
  332. <tr>
  333. <th>Type</th>
  334. <th>Name</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><span class="xref">System.Boolean</span></td>
  341. <td><span class="parametername">condition</span></td>
  342. <td><p>The condition.</p>
  343. </td>
  344. </tr>
  345. <tr>
  346. <td><span class="xref">System.String</span></td>
  347. <td><span class="parametername">errorMessage</span></td>
  348. <td><p>The error message.</p>
  349. </td>
  350. </tr>
  351. </tbody>
  352. </table>
  353. </article>
  354. </div>
  355. <div class="hidden-sm col-md-2" role="complementary">
  356. <div class="sideaffix">
  357. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  358. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  359. </nav>
  360. </div>
  361. </div>
  362. </div>
  363. </div>
  364. <footer>
  365. <div class="grad-bottom"></div>
  366. <div class="footer">
  367. <div class="container">
  368. <span class="pull-right">
  369. <a href="#top">Back to top</a>
  370. </span>
  371. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  372. </div>
  373. </div>
  374. </footer>
  375. </div>
  376. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  377. <script type="text/javascript" src="../styles/docfx.js"></script>
  378. <script type="text/javascript" src="../styles/main.js"></script>
  379. </body>
  380. </html>