Grpc.Core.RpcException.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  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 RpcException
  8. | gRPC C# </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class RpcException
  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.RpcException">
  71. <h1 id="Grpc_Core_RpcException" data-uid="Grpc.Core.RpcException" class="text-break">Class RpcException
  72. </h1>
  73. <div class="markdown level0 summary"><p>Thrown when remote procedure call fails. Every <code>RpcException</code> is associated with a resulting <a class="xref" href="Grpc.Core.RpcException.html#Grpc_Core_RpcException_Status">Status</a> of the call.</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">System.Exception</span></div>
  80. <div class="level2"><span class="xref">RpcException</span></div>
  81. </div>
  82. <div class="inheritedMembers">
  83. <h5>Inherited Members</h5>
  84. <div>
  85. <span class="xref">System.Exception.GetBaseException()</span>
  86. </div>
  87. <div>
  88. <span class="xref">System.Exception.ToString()</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Exception.GetType()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Exception.Message</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Exception.Data</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Exception.InnerException</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Exception.TargetSite</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Exception.StackTrace</span>
  110. </div>
  111. <div>
  112. <span class="xref">System.Exception.HelpLink</span>
  113. </div>
  114. <div>
  115. <span class="xref">System.Exception.Source</span>
  116. </div>
  117. <div>
  118. <span class="xref">System.Exception.HResult</span>
  119. </div>
  120. <div>
  121. <span class="xref">System.Exception.SerializeObjectState</span>
  122. </div>
  123. <div>
  124. <span class="xref">System.Object.Equals(System.Object)</span>
  125. </div>
  126. <div>
  127. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  128. </div>
  129. <div>
  130. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  131. </div>
  132. <div>
  133. <span class="xref">System.Object.GetHashCode()</span>
  134. </div>
  135. <div>
  136. <span class="xref">System.Object.MemberwiseClone()</span>
  137. </div>
  138. </div>
  139. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  140. <h6><strong>Assembly</strong>: Grpc.Core.dll</h6>
  141. <h5 id="Grpc_Core_RpcException_syntax">Syntax</h5>
  142. <div class="codewrapper">
  143. <pre><code class="lang-csharp hljs">public class RpcException : Exception, ISerializable, _Exception</code></pre>
  144. </div>
  145. <h3 id="constructors">Constructors
  146. </h3>
  147. <a id="Grpc_Core_RpcException__ctor_" data-uid="Grpc.Core.RpcException.#ctor*"></a>
  148. <h4 id="Grpc_Core_RpcException__ctor_Grpc_Core_Status_" data-uid="Grpc.Core.RpcException.#ctor(Grpc.Core.Status)">RpcException(Status)</h4>
  149. <div class="markdown level1 summary"><p>Creates a new <code>RpcException</code> associated with given status.</p>
  150. </div>
  151. <div class="markdown level1 conceptual"></div>
  152. <h5 class="decalaration">Declaration</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public RpcException(Status status)</code></pre>
  155. </div>
  156. <h5 class="parameters">Parameters</h5>
  157. <table class="table table-bordered table-striped table-condensed">
  158. <thead>
  159. <tr>
  160. <th>Type</th>
  161. <th>Name</th>
  162. <th>Description</th>
  163. </tr>
  164. </thead>
  165. <tbody>
  166. <tr>
  167. <td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
  168. <td><span class="parametername">status</span></td>
  169. <td><p>Resulting status of a call.</p>
  170. </td>
  171. </tr>
  172. </tbody>
  173. </table>
  174. <a id="Grpc_Core_RpcException__ctor_" data-uid="Grpc.Core.RpcException.#ctor*"></a>
  175. <h4 id="Grpc_Core_RpcException__ctor_Grpc_Core_Status_Grpc_Core_Metadata_" data-uid="Grpc.Core.RpcException.#ctor(Grpc.Core.Status,Grpc.Core.Metadata)">RpcException(Status, Metadata)</h4>
  176. <div class="markdown level1 summary"><p>Creates a new <code>RpcException</code> associated with given status and trailing response metadata.</p>
  177. </div>
  178. <div class="markdown level1 conceptual"></div>
  179. <h5 class="decalaration">Declaration</h5>
  180. <div class="codewrapper">
  181. <pre><code class="lang-csharp hljs">public RpcException(Status status, Metadata trailers)</code></pre>
  182. </div>
  183. <h5 class="parameters">Parameters</h5>
  184. <table class="table table-bordered table-striped table-condensed">
  185. <thead>
  186. <tr>
  187. <th>Type</th>
  188. <th>Name</th>
  189. <th>Description</th>
  190. </tr>
  191. </thead>
  192. <tbody>
  193. <tr>
  194. <td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
  195. <td><span class="parametername">status</span></td>
  196. <td><p>Resulting status of a call.</p>
  197. </td>
  198. </tr>
  199. <tr>
  200. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  201. <td><span class="parametername">trailers</span></td>
  202. <td><p>Response trailing metadata.</p>
  203. </td>
  204. </tr>
  205. </tbody>
  206. </table>
  207. <a id="Grpc_Core_RpcException__ctor_" data-uid="Grpc.Core.RpcException.#ctor*"></a>
  208. <h4 id="Grpc_Core_RpcException__ctor_Grpc_Core_Status_System_String_" data-uid="Grpc.Core.RpcException.#ctor(Grpc.Core.Status,System.String)">RpcException(Status, String)</h4>
  209. <div class="markdown level1 summary"><p>Creates a new <code>RpcException</code> associated with given status and message.</p>
  210. </div>
  211. <div class="markdown level1 conceptual"></div>
  212. <h5 class="decalaration">Declaration</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">public RpcException(Status status, string message)</code></pre>
  215. </div>
  216. <h5 class="parameters">Parameters</h5>
  217. <table class="table table-bordered table-striped table-condensed">
  218. <thead>
  219. <tr>
  220. <th>Type</th>
  221. <th>Name</th>
  222. <th>Description</th>
  223. </tr>
  224. </thead>
  225. <tbody>
  226. <tr>
  227. <td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
  228. <td><span class="parametername">status</span></td>
  229. <td><p>Resulting status of a call.</p>
  230. </td>
  231. </tr>
  232. <tr>
  233. <td><span class="xref">System.String</span></td>
  234. <td><span class="parametername">message</span></td>
  235. <td><p>The exception message.</p>
  236. </td>
  237. </tr>
  238. </tbody>
  239. </table>
  240. <h3 id="properties">Properties
  241. </h3>
  242. <a id="Grpc_Core_RpcException_Status_" data-uid="Grpc.Core.RpcException.Status*"></a>
  243. <h4 id="Grpc_Core_RpcException_Status" data-uid="Grpc.Core.RpcException.Status">Status</h4>
  244. <div class="markdown level1 summary"><p>Resulting status of the call.</p>
  245. </div>
  246. <div class="markdown level1 conceptual"></div>
  247. <h5 class="decalaration">Declaration</h5>
  248. <div class="codewrapper">
  249. <pre><code class="lang-csharp hljs">public Status Status { get; }</code></pre>
  250. </div>
  251. <h5 class="propertyValue">Property Value</h5>
  252. <table class="table table-bordered table-striped table-condensed">
  253. <thead>
  254. <tr>
  255. <th>Type</th>
  256. <th>Description</th>
  257. </tr>
  258. </thead>
  259. <tbody>
  260. <tr>
  261. <td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
  262. <td></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <a id="Grpc_Core_RpcException_Trailers_" data-uid="Grpc.Core.RpcException.Trailers*"></a>
  267. <h4 id="Grpc_Core_RpcException_Trailers" data-uid="Grpc.Core.RpcException.Trailers">Trailers</h4>
  268. <div class="markdown level1 summary"><p>Gets the call trailing metadata.
  269. Trailers only have meaningful content for client-side calls (in which case they represent the trailing metadata sent by the server when closing the call).
  270. Instances of <code>RpcException</code> thrown by the server-side part of the stack will have trailers always set to empty.</p>
  271. </div>
  272. <div class="markdown level1 conceptual"></div>
  273. <h5 class="decalaration">Declaration</h5>
  274. <div class="codewrapper">
  275. <pre><code class="lang-csharp hljs">public Metadata Trailers { get; }</code></pre>
  276. </div>
  277. <h5 class="propertyValue">Property Value</h5>
  278. <table class="table table-bordered table-striped table-condensed">
  279. <thead>
  280. <tr>
  281. <th>Type</th>
  282. <th>Description</th>
  283. </tr>
  284. </thead>
  285. <tbody>
  286. <tr>
  287. <td><a class="xref" href="Grpc.Core.Metadata.html">Metadata</a></td>
  288. <td></td>
  289. </tr>
  290. </tbody>
  291. </table>
  292. </article>
  293. </div>
  294. <div class="hidden-sm col-md-2" role="complementary">
  295. <div class="sideaffix">
  296. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  297. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  298. </nav>
  299. </div>
  300. </div>
  301. </div>
  302. </div>
  303. <footer>
  304. <div class="grad-bottom"></div>
  305. <div class="footer">
  306. <div class="container">
  307. <span class="pull-right">
  308. <a href="#top">Back to top</a>
  309. </span>
  310. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  311. </div>
  312. </div>
  313. </footer>
  314. </div>
  315. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  316. <script type="text/javascript" src="../styles/docfx.js"></script>
  317. <script type="text/javascript" src="../styles/main.js"></script>
  318. </body>
  319. </html>