carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
							<!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 Core: include/grpc/impl/codegen/status.h File 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 Core
   &#160;<span id="projectnumber">15.0.0</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li><li class="navelem"><a class="el" href="dir_4b3e2ed696753daba329e2683e0f6479.html">impl</a></li><li class="navelem"><a class="el" href="dir_7a167954ab48275cc692d783196d1f28.html">codegen</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">status.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a href="impl_2codegen_2status_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a35ab2a68917eb836de84cb23253108eb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a> { <br />
&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba9da5601150b267ab5509d151fa7df201">GRPC_STATUS_OK</a> = 0, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba30e6e0c37df1389dd4c460a53f831038">GRPC_STATUS_CANCELLED</a> = 1, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba5f02c0e431162618ab422d27fd39dd08">GRPC_STATUS_UNKNOWN</a> = 2, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba3dd64296110db7e7fafb1062b5587731">GRPC_STATUS_INVALID_ARGUMENT</a> = 3, 
<br />
&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba5451711361db6b8d8e80be30cbb1a208">GRPC_STATUS_DEADLINE_EXCEEDED</a> = 4, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebafdf14cb6f2da868d76b209ac490c14e2">GRPC_STATUS_NOT_FOUND</a> = 5, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebad357565db8655b6635fae96a11c4009b">GRPC_STATUS_ALREADY_EXISTS</a> = 6, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba4149925007957bf1a04184d88e8293f4">GRPC_STATUS_PERMISSION_DENIED</a> = 7, 
<br />
&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba1a6fd47361ad9298879dd8760ca1a0cb">GRPC_STATUS_UNAUTHENTICATED</a> = 16, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebab1a76cb91e6992f6f7a31a7fe862e0e9">GRPC_STATUS_RESOURCE_EXHAUSTED</a> = 8, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba503abd183544b43a83bc01d999adda5f">GRPC_STATUS_FAILED_PRECONDITION</a> = 9, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba3570bc43d5eb08c95a7f4c24c13010d9">GRPC_STATUS_ABORTED</a> = 10, 
<br />
&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebacd0d05ab2f0af48b0f535c3dd0816d9b">GRPC_STATUS_OUT_OF_RANGE</a> = 11, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba6912537b4dfd1030f50ff2f5448f1bc2">GRPC_STATUS_UNIMPLEMENTED</a> = 12, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebae648dab84c58ef5b1cfeea35867c4520">GRPC_STATUS_INTERNAL</a> = 13, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebaad91b67998cb5df7bc6821e362189e79">GRPC_STATUS_UNAVAILABLE</a> = 14, 
<br />
&#160;&#160;<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eba275db05856f4af884c48e86440414db7">GRPC_STATUS_DATA_LOSS</a> = 15, 
<a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108ebab924d4c4c646bdb3130162b8e359dd96">GRPC_STATUS__DO_NOT_USE</a> = -1
<br />
 }</td></tr>
<tr class="separator:a35ab2a68917eb836de84cb23253108eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a35ab2a68917eb836de84cb23253108eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35ab2a68917eb836de84cb23253108eb">&#9670;&nbsp;</a></span>grpc_status_code</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="impl_2codegen_2status_8h.html#a35ab2a68917eb836de84cb23253108eb">grpc_status_code</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba9da5601150b267ab5509d151fa7df201"></a>GRPC_STATUS_OK&#160;</td><td class="fielddoc"><p>Not an error; returned on success. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba30e6e0c37df1389dd4c460a53f831038"></a>GRPC_STATUS_CANCELLED&#160;</td><td class="fielddoc"><p>The operation was cancelled (typically by the caller). </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba5f02c0e431162618ab422d27fd39dd08"></a>GRPC_STATUS_UNKNOWN&#160;</td><td class="fielddoc"><p>Unknown error. </p>
<p>An example of where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba3dd64296110db7e7fafb1062b5587731"></a>GRPC_STATUS_INVALID_ARGUMENT&#160;</td><td class="fielddoc"><p>Client specified an invalid argument. </p>
<p>Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba5451711361db6b8d8e80be30cbb1a208"></a>GRPC_STATUS_DEADLINE_EXCEEDED&#160;</td><td class="fielddoc"><p>Deadline expired before operation could complete. </p>
<p>For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebafdf14cb6f2da868d76b209ac490c14e2"></a>GRPC_STATUS_NOT_FOUND&#160;</td><td class="fielddoc"><p>Some requested entity (e.g., file or directory) was not found. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebad357565db8655b6635fae96a11c4009b"></a>GRPC_STATUS_ALREADY_EXISTS&#160;</td><td class="fielddoc"><p>Some entity that we attempted to create (e.g., file or directory) already exists. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba4149925007957bf1a04184d88e8293f4"></a>GRPC_STATUS_PERMISSION_DENIED&#160;</td><td class="fielddoc"><p>The caller does not have permission to execute the specified operation. </p>
<p>PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba1a6fd47361ad9298879dd8760ca1a0cb"></a>GRPC_STATUS_UNAUTHENTICATED&#160;</td><td class="fielddoc"><p>The request does not have valid authentication credentials for the operation. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebab1a76cb91e6992f6f7a31a7fe862e0e9"></a>GRPC_STATUS_RESOURCE_EXHAUSTED&#160;</td><td class="fielddoc"><p>Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba503abd183544b43a83bc01d999adda5f"></a>GRPC_STATUS_FAILED_PRECONDITION&#160;</td><td class="fielddoc"><p>Operation was rejected because the system is not in a state required for the operation's execution. </p>
<p>For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.</p>
<p>A litmus test that may help a service implementor in deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless they have first fixed up the directory by deleting files from it. (d) Use FAILED_PRECONDITION if the client performs conditional REST Get/Update/Delete on a resource and the resource on the server does not match the condition. E.g., conflicting read-modify-write on the same resource. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba3570bc43d5eb08c95a7f4c24c13010d9"></a>GRPC_STATUS_ABORTED&#160;</td><td class="fielddoc"><p>The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. </p>
<p>See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebacd0d05ab2f0af48b0f535c3dd0816d9b"></a>GRPC_STATUS_OUT_OF_RANGE&#160;</td><td class="fielddoc"><p>Operation was attempted past the valid range. </p>
<p>E.g., seeking or reading past end of file.</p>
<p>Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size.</p>
<p>There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba6912537b4dfd1030f50ff2f5448f1bc2"></a>GRPC_STATUS_UNIMPLEMENTED&#160;</td><td class="fielddoc"><p>Operation is not implemented or not supported/enabled in this service. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebae648dab84c58ef5b1cfeea35867c4520"></a>GRPC_STATUS_INTERNAL&#160;</td><td class="fielddoc"><p>Internal errors. </p>
<p>Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebaad91b67998cb5df7bc6821e362189e79"></a>GRPC_STATUS_UNAVAILABLE&#160;</td><td class="fielddoc"><p>The service is currently unavailable. </p>
<p>This is a most likely a transient condition and may be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.</p>
<p>WARNING: Although data MIGHT not have been transmitted when this status occurs, there is NOT A GUARANTEE that the server has not seen anything. So in general it is unsafe to retry on this status code if the call is non-idempotent.</p>
<p>See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108eba275db05856f4af884c48e86440414db7"></a>GRPC_STATUS_DATA_LOSS&#160;</td><td class="fielddoc"><p>Unrecoverable data loss or corruption. </p>
</td></tr>
<tr><td class="fieldname"><a id="a35ab2a68917eb836de84cb23253108ebab924d4c4c646bdb3130162b8e359dd96"></a>GRPC_STATUS__DO_NOT_USE&#160;</td><td class="fielddoc"><p>Force users to include a default branch: </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:10 for GRPC Core 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>