carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::Status Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_status.html">Status</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">grpc::Status Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Did it work? If it didn't, why?  
 <a href="classgrpc_1_1_status.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2status_8h_source.html">status.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a46537b45349a95126a16dcd67b5cf54c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a46537b45349a95126a16dcd67b5cf54c">Status</a> ()</td></tr>
<tr class="memdesc:a46537b45349a95126a16dcd67b5cf54c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an OK instance.  <a href="classgrpc_1_1_status.html#a46537b45349a95126a16dcd67b5cf54c">More...</a><br /></td></tr>
<tr class="separator:a46537b45349a95126a16dcd67b5cf54c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5be6d5b99b07855a1458e0167b066038"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a5be6d5b99b07855a1458e0167b066038">Status</a> (<a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a> code, const std::string &amp;<a class="el" href="classgrpc_1_1_status.html#a284c2d58d09e2634996d6456645c473f">error_message</a>)</td></tr>
<tr class="memdesc:a5be6d5b99b07855a1458e0167b066038"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an instance with associated <em>code</em> and <em>error_message</em>.  <a href="classgrpc_1_1_status.html#a5be6d5b99b07855a1458e0167b066038">More...</a><br /></td></tr>
<tr class="separator:a5be6d5b99b07855a1458e0167b066038"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f717edd9625cb4886ce6a599e4d47b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a8f717edd9625cb4886ce6a599e4d47b4">Status</a> (<a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a> code, const std::string &amp;<a class="el" href="classgrpc_1_1_status.html#a284c2d58d09e2634996d6456645c473f">error_message</a>, const std::string &amp;<a class="el" href="classgrpc_1_1_status.html#a3eb2cecab0655d1f74c191847332824d">error_details</a>)</td></tr>
<tr class="memdesc:a8f717edd9625cb4886ce6a599e4d47b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an instance with <em>code</em>, <em>error_message</em> and <em>error_details</em>.  <a href="classgrpc_1_1_status.html#a8f717edd9625cb4886ce6a599e4d47b4">More...</a><br /></td></tr>
<tr class="separator:a8f717edd9625cb4886ce6a599e4d47b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28f68560a6810c553a1aed2506a581f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a28f68560a6810c553a1aed2506a581f1">error_code</a> () const</td></tr>
<tr class="memdesc:a28f68560a6810c553a1aed2506a581f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the instance's error code.  <a href="classgrpc_1_1_status.html#a28f68560a6810c553a1aed2506a581f1">More...</a><br /></td></tr>
<tr class="separator:a28f68560a6810c553a1aed2506a581f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a284c2d58d09e2634996d6456645c473f"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a284c2d58d09e2634996d6456645c473f">error_message</a> () const</td></tr>
<tr class="memdesc:a284c2d58d09e2634996d6456645c473f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the instance's error message.  <a href="classgrpc_1_1_status.html#a284c2d58d09e2634996d6456645c473f">More...</a><br /></td></tr>
<tr class="separator:a284c2d58d09e2634996d6456645c473f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3eb2cecab0655d1f74c191847332824d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a3eb2cecab0655d1f74c191847332824d">error_details</a> () const</td></tr>
<tr class="memdesc:a3eb2cecab0655d1f74c191847332824d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the (binary) error details.  <a href="classgrpc_1_1_status.html#a3eb2cecab0655d1f74c191847332824d">More...</a><br /></td></tr>
<tr class="separator:a3eb2cecab0655d1f74c191847332824d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab80672b5665c32dc0937a0d58a3ce192"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#ab80672b5665c32dc0937a0d58a3ce192">ok</a> () const</td></tr>
<tr class="memdesc:ab80672b5665c32dc0937a0d58a3ce192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the status OK?  <a href="classgrpc_1_1_status.html#ab80672b5665c32dc0937a0d58a3ce192">More...</a><br /></td></tr>
<tr class="separator:ab80672b5665c32dc0937a0d58a3ce192"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7bcfb5c361084879d3cd0ba2ee9dfa4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#ab7bcfb5c361084879d3cd0ba2ee9dfa4">IgnoreError</a> () const</td></tr>
<tr class="separator:ab7bcfb5c361084879d3cd0ba2ee9dfa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:acbac12f241ad08f449aa1b9086ec7acc"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#acbac12f241ad08f449aa1b9086ec7acc">OK</a></td></tr>
<tr class="memdesc:acbac12f241ad08f449aa1b9086ec7acc"><td class="mdescLeft">&#160;</td><td class="mdescRight">An OK pre-defined instance.  <a href="classgrpc_1_1_status.html#acbac12f241ad08f449aa1b9086ec7acc">More...</a><br /></td></tr>
<tr class="separator:acbac12f241ad08f449aa1b9086ec7acc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9994ffe95a0495915d82481c2ec594ab"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab">CANCELLED</a></td></tr>
<tr class="memdesc:a9994ffe95a0495915d82481c2ec594ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">A CANCELLED pre-defined instance.  <a href="classgrpc_1_1_status.html#a9994ffe95a0495915d82481c2ec594ab">More...</a><br /></td></tr>
<tr class="separator:a9994ffe95a0495915d82481c2ec594ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Did it work? If it didn't, why? </p>
<p>See <em><a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">grpc::StatusCode</a></em> for details on the available code and their meaning. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a46537b45349a95126a16dcd67b5cf54c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46537b45349a95126a16dcd67b5cf54c">&#9670;&nbsp;</a></span>Status() <span class="overload">[1/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Status::Status </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construct an OK instance. </p>

</div>
</div>
<a id="a5be6d5b99b07855a1458e0167b066038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5be6d5b99b07855a1458e0167b066038">&#9670;&nbsp;</a></span>Status() <span class="overload">[2/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Status::Status </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>error_message</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construct an instance with associated <em>code</em> and <em>error_message</em>. </p>
<p>It is an error to construct an OK status with non-empty <em>error_message</em>. </p>

</div>
</div>
<a id="a8f717edd9625cb4886ce6a599e4d47b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f717edd9625cb4886ce6a599e4d47b4">&#9670;&nbsp;</a></span>Status() <span class="overload">[3/3]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Status::Status </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>error_message</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>error_details</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Construct an instance with <em>code</em>, <em>error_message</em> and <em>error_details</em>. </p>
<p>It is an error to construct an OK status with non-empty <em>error_message</em> and/or <em>error_details</em>. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a28f68560a6810c553a1aed2506a581f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28f68560a6810c553a1aed2506a581f1">&#9670;&nbsp;</a></span>error_code()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacegrpc.html#aff1730578c90160528f6a8d67ef5c43b">StatusCode</a> grpc::Status::error_code </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the instance's error code. </p>

</div>
</div>
<a id="a3eb2cecab0655d1f74c191847332824d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eb2cecab0655d1f74c191847332824d">&#9670;&nbsp;</a></span>error_details()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string grpc::Status::error_details </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the (binary) error details. </p>

</div>
</div>
<a id="a284c2d58d09e2634996d6456645c473f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a284c2d58d09e2634996d6456645c473f">&#9670;&nbsp;</a></span>error_message()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::string grpc::Status::error_message </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Return the instance's error message. </p>

</div>
</div>
<a id="ab7bcfb5c361084879d3cd0ba2ee9dfa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7bcfb5c361084879d3cd0ba2ee9dfa4">&#9670;&nbsp;</a></span>IgnoreError()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void grpc::Status::IgnoreError </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab80672b5665c32dc0937a0d58a3ce192"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab80672b5665c32dc0937a0d58a3ce192">&#9670;&nbsp;</a></span>ok()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool grpc::Status::ok </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Is the status OK? </p>

</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="a9994ffe95a0495915d82481c2ec594ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9994ffe95a0495915d82481c2ec594ab">&#9670;&nbsp;</a></span>CANCELLED</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classgrpc_1_1_status.html">Status</a>&amp; grpc::Status::CANCELLED</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A CANCELLED pre-defined instance. </p>

</div>
</div>
<a id="acbac12f241ad08f449aa1b9086ec7acc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbac12f241ad08f449aa1b9086ec7acc">&#9670;&nbsp;</a></span>OK</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classgrpc_1_1_status.html">Status</a>&amp; grpc::Status::OK</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>An OK pre-defined instance. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2status_8h_source.html">status.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>