379 lines
14 KiB
HTML
379 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Struct Status
|
|
| gRPC C# </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Struct Status
|
|
| gRPC C# ">
|
|
<meta name="generator" content="docfx 2.36.0.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Grpc.Core.Status">
|
|
|
|
|
|
<h1 id="Grpc_Core_Status" data-uid="Grpc.Core.Status" class="text-break">Struct Status
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents RPC result, which consists of <a class="xref" href="Grpc.Core.Status.html#Grpc_Core_Status_StatusCode">StatusCode</a> and an optional detail string.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.ValueType.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.ValueType.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
|
|
<h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
|
|
<h5 id="Grpc_Core_Status_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public struct Status</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
<a id="Grpc_Core_Status__ctor_" data-uid="Grpc.Core.Status.#ctor*"></a>
|
|
<h4 id="Grpc_Core_Status__ctor_Grpc_Core_StatusCode_System_String_" data-uid="Grpc.Core.Status.#ctor(Grpc.Core.StatusCode,System.String)">Status(StatusCode, String)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new instance of <code>Status</code>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Status(StatusCode statusCode, string detail)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.StatusCode.html">StatusCode</a></td>
|
|
<td><span class="parametername">statusCode</span></td>
|
|
<td><p>Status code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">detail</span></td>
|
|
<td><p>Detail.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Core_Status__ctor_" data-uid="Grpc.Core.Status.#ctor*"></a>
|
|
<h4 id="Grpc_Core_Status__ctor_Grpc_Core_StatusCode_System_String_System_Nullable_System_Exception__" data-uid="Grpc.Core.Status.#ctor(Grpc.Core.StatusCode,System.String,System.Nullable{System.Exception})">Status(StatusCode, String, Nullable<Exception>)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new instance of <code>Status</code>.
|
|
Users should not use this constructor, except for creating instances for testing.
|
|
The debug error string should only be populated by gRPC internals.
|
|
Note: experimental API that can change or be removed without any prior notice.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Status(StatusCode statusCode, string detail, Exception? debugException)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.StatusCode.html">StatusCode</a></td>
|
|
<td><span class="parametername">statusCode</span></td>
|
|
<td><p>Status code.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">detail</span></td>
|
|
<td><p>Detail.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Exception</span>></td>
|
|
<td><span class="parametername">debugException</span></td>
|
|
<td><p>Optional internal error details.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="fields">Fields
|
|
</h3>
|
|
<h4 id="Grpc_Core_Status_DefaultCancelled" data-uid="Grpc.Core.Status.DefaultCancelled">DefaultCancelled</h4>
|
|
<div class="markdown level1 summary"><p>Default result of a cancelled RPC. StatusCode=Cancelled, empty details message.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static readonly Status DefaultCancelled</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h4 id="Grpc_Core_Status_DefaultSuccess" data-uid="Grpc.Core.Status.DefaultSuccess">DefaultSuccess</h4>
|
|
<div class="markdown level1 summary"><p>Default result of a successful RPC. StatusCode=OK, empty details message.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static readonly Status DefaultSuccess</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.Status.html">Status</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<a id="Grpc_Core_Status_DebugException_" data-uid="Grpc.Core.Status.DebugException*"></a>
|
|
<h4 id="Grpc_Core_Status_DebugException" data-uid="Grpc.Core.Status.DebugException">DebugException</h4>
|
|
<div class="markdown level1 summary"><p>In case of an error, this field may contain additional error details to help with debugging.
|
|
This field will be only populated on a client and its value is generated locally,
|
|
based on the internal state of the gRPC client stack (i.e. the value is never sent over the wire).
|
|
Note that this field is available only for debugging purposes, the application logic should
|
|
never rely on values of this field (it should use <code>StatusCode</code> and <code>Detail</code> instead).
|
|
Example: when a client fails to connect to a server, this field may provide additional details
|
|
why the connection to the server has failed.
|
|
Note: experimental API that can change or be removed without any prior notice.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Exception? DebugException { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">System.Exception</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Core_Status_Detail_" data-uid="Grpc.Core.Status.Detail*"></a>
|
|
<h4 id="Grpc_Core_Status_Detail" data-uid="Grpc.Core.Status.Detail">Detail</h4>
|
|
<div class="markdown level1 summary"><p>Gets the detail.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Detail { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<a id="Grpc_Core_Status_StatusCode_" data-uid="Grpc.Core.Status.StatusCode*"></a>
|
|
<h4 id="Grpc_Core_Status_StatusCode" data-uid="Grpc.Core.Status.StatusCode">StatusCode</h4>
|
|
<div class="markdown level1 summary"><p>Gets the gRPC status code. OK indicates success, all other values indicate an error.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public StatusCode StatusCode { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="Grpc.Core.StatusCode.html">StatusCode</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<a id="Grpc_Core_Status_ToString_" data-uid="Grpc.Core.Status.ToString*"></a>
|
|
<h4 id="Grpc_Core_Status_ToString" data-uid="Grpc.Core.Status.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"><p>Returns a <span class="xref">System.String</span> that represents the current <a class="xref" href="Grpc.Core.Status.html">Status</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><span class="xref">System.ValueType.ToString()</span></div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|