Grpc.Core.Utils.GrpcPreconditions.html 14 KB

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