| <!-- This comment will put IE 6, 7 and 8 in quirks mode --> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/> |
| <title>Kudu C++ client API: include/kudu/util/status.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javaScript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body onload='searchBox.OnSelectItem(0);'> |
| <!-- Generated by Doxygen 1.6.1 --> |
| <script type="text/javascript"><!-- |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| --></script> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <img id="MSearchSelect" src="search/search.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div class="tabs"> |
| <ul> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| <h1>include/kudu/util/status.h</h1><a href="status_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2011 The LevelDB Authors. All rights reserved.</span> |
| <a name="l00002"></a>00002 <span class="comment">// Use of this source code is governed by a BSD-style license that can be</span> |
| <a name="l00003"></a>00003 <span class="comment">// found in the LICENSE file. See the AUTHORS file for names of contributors.</span> |
| <a name="l00004"></a>00004 <span class="comment">//</span> |
| <a name="l00005"></a>00005 <span class="comment">// A Status encapsulates the result of an operation. It may indicate success,</span> |
| <a name="l00006"></a>00006 <span class="comment">// or it may indicate an error with an associated error message.</span> |
| <a name="l00007"></a>00007 <span class="comment">//</span> |
| <a name="l00008"></a>00008 <span class="comment">// Multiple threads can invoke const methods on a Status without</span> |
| <a name="l00009"></a>00009 <span class="comment">// external synchronization, but if any of the threads may call a</span> |
| <a name="l00010"></a>00010 <span class="comment">// non-const method, all threads accessing the same Status must use</span> |
| <a name="l00011"></a>00011 <span class="comment">// external synchronization.</span> |
| <a name="l00012"></a>00012 |
| <a name="l00013"></a>00013 <span class="preprocessor">#ifndef KUDU_UTIL_STATUS_H_</span> |
| <a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define KUDU_UTIL_STATUS_H_</span> |
| <a name="l00015"></a>00015 <span class="preprocessor"></span> |
| <a name="l00016"></a>00016 <span class="preprocessor">#include <stdint.h></span> |
| <a name="l00017"></a>00017 <span class="preprocessor">#include <string></span> |
| <a name="l00018"></a>00018 |
| <a name="l00019"></a>00019 <span class="preprocessor">#ifdef KUDU_HEADERS_NO_STUBS</span> |
| <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#include "kudu/gutil/macros.h"</span> |
| <a name="l00021"></a>00021 <span class="preprocessor">#include "kudu/gutil/port.h"</span> |
| <a name="l00022"></a>00022 <span class="preprocessor">#else</span> |
| <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#include "kudu/client/stubs.h"</span> |
| <a name="l00024"></a>00024 <span class="preprocessor">#endif</span> |
| <a name="l00025"></a>00025 <span class="preprocessor"></span> |
| <a name="l00026"></a>00026 <span class="preprocessor">#include "kudu/util/kudu_export.h"</span> |
| <a name="l00027"></a>00027 <span class="preprocessor">#include "kudu/util/slice.h"</span> |
| <a name="l00028"></a>00028 |
| <a name="l00030"></a><a class="code" href="status_8h.html#a0de56a3f0e9d83b8ffdd63eac83c54ab">00030</a> <span class="preprocessor">#define KUDU_RETURN_NOT_OK(s) do { \</span> |
| <a name="l00031"></a>00031 <span class="preprocessor"> const ::kudu::Status& _s = (s); \</span> |
| <a name="l00032"></a>00032 <span class="preprocessor"> if (PREDICT_FALSE(!_s.ok())) return _s; \</span> |
| <a name="l00033"></a>00033 <span class="preprocessor"> } while (0);</span> |
| <a name="l00034"></a>00034 <span class="preprocessor"></span> |
| <a name="l00037"></a><a class="code" href="status_8h.html#af66b8458f1d3f1264c1da86744e29e46">00037</a> <span class="preprocessor">#define KUDU_RETURN_NOT_OK_PREPEND(s, msg) do { \</span> |
| <a name="l00038"></a>00038 <span class="preprocessor"> const ::kudu::Status& _s = (s); \</span> |
| <a name="l00039"></a>00039 <span class="preprocessor"> if (PREDICT_FALSE(!_s.ok())) return _s.CloneAndPrepend(msg); \</span> |
| <a name="l00040"></a>00040 <span class="preprocessor"> } while (0);</span> |
| <a name="l00041"></a>00041 <span class="preprocessor"></span> |
| <a name="l00045"></a><a class="code" href="status_8h.html#a58d31c81bf1101a3ead737e9a4a4f223">00045</a> <span class="preprocessor">#define KUDU_RETURN_NOT_OK_RET(to_call, to_return) do { \</span> |
| <a name="l00046"></a>00046 <span class="preprocessor"> const ::kudu::Status& s = (to_call); \</span> |
| <a name="l00047"></a>00047 <span class="preprocessor"> if (PREDICT_FALSE(!s.ok())) return (to_return); \</span> |
| <a name="l00048"></a>00048 <span class="preprocessor"> } while (0);</span> |
| <a name="l00049"></a>00049 <span class="preprocessor"></span> |
| <a name="l00051"></a><a class="code" href="status_8h.html#a1e64fec5ef85c0c738f6ac3f398f607e">00051</a> <span class="preprocessor">#define KUDU_WARN_NOT_OK(to_call, warning_prefix) do { \</span> |
| <a name="l00052"></a>00052 <span class="preprocessor"> const ::kudu::Status& _s = (to_call); \</span> |
| <a name="l00053"></a>00053 <span class="preprocessor"> if (PREDICT_FALSE(!_s.ok())) { \</span> |
| <a name="l00054"></a>00054 <span class="preprocessor"> KUDU_LOG(WARNING) << (warning_prefix) << ": " << _s.ToString(); \</span> |
| <a name="l00055"></a>00055 <span class="preprocessor"> } \</span> |
| <a name="l00056"></a>00056 <span class="preprocessor"> } while (0);</span> |
| <a name="l00057"></a>00057 <span class="preprocessor"></span> |
| <a name="l00059"></a><a class="code" href="status_8h.html#abbd85cc2c5535627091bb06a21918150">00059</a> <span class="preprocessor">#define KUDU_LOG_AND_RETURN(level, status) do { \</span> |
| <a name="l00060"></a>00060 <span class="preprocessor"> const ::kudu::Status& _s = (status); \</span> |
| <a name="l00061"></a>00061 <span class="preprocessor"> KUDU_LOG(level) << _s.ToString(); \</span> |
| <a name="l00062"></a>00062 <span class="preprocessor"> return _s; \</span> |
| <a name="l00063"></a>00063 <span class="preprocessor"> } while (0);</span> |
| <a name="l00064"></a>00064 <span class="preprocessor"></span> |
| <a name="l00067"></a><a class="code" href="status_8h.html#a706c9f6ef1715b8f7a9185fb3c247d3f">00067</a> <span class="preprocessor">#define KUDU_CHECK_OK_PREPEND(to_call, msg) do { \</span> |
| <a name="l00068"></a>00068 <span class="preprocessor"> const ::kudu::Status& _s = (to_call); \</span> |
| <a name="l00069"></a>00069 <span class="preprocessor"> KUDU_CHECK(_s.ok()) << (msg) << ": " << _s.ToString(); \</span> |
| <a name="l00070"></a>00070 <span class="preprocessor"> } while (0);</span> |
| <a name="l00071"></a>00071 <span class="preprocessor"></span> |
| <a name="l00074"></a><a class="code" href="status_8h.html#ac503ba85e942147294cdc82087da60f6">00074</a> <span class="preprocessor">#define KUDU_CHECK_OK(s) KUDU_CHECK_OK_PREPEND(s, "Bad status")</span> |
| <a name="l00075"></a>00075 <span class="preprocessor"></span> |
| <a name="l00089"></a>00089 <span class="preprocessor">#ifdef KUDU_HEADERS_USE_SHORT_STATUS_MACROS</span> |
| <a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define RETURN_NOT_OK KUDU_RETURN_NOT_OK</span> |
| <a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#define RETURN_NOT_OK_PREPEND KUDU_RETURN_NOT_OK_PREPEND</span> |
| <a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor">#define RETURN_NOT_OK_RET KUDU_RETURN_NOT_OK_RET</span> |
| <a name="l00093"></a>00093 <span class="preprocessor"></span><span class="preprocessor">#define WARN_NOT_OK KUDU_WARN_NOT_OK</span> |
| <a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">#define LOG_AND_RETURN KUDU_LOG_AND_RETURN</span> |
| <a name="l00095"></a>00095 <span class="preprocessor"></span><span class="preprocessor">#define CHECK_OK_PREPEND KUDU_CHECK_OK_PREPEND</span> |
| <a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define CHECK_OK KUDU_CHECK_OK</span> |
| <a name="l00097"></a>00097 <span class="preprocessor"></span> |
| <a name="l00098"></a>00098 <span class="comment">// These are standard glog macros.</span> |
| <a name="l00099"></a>00099 <span class="preprocessor">#define KUDU_LOG LOG</span> |
| <a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#define KUDU_CHECK CHECK</span> |
| <a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#endif</span> |
| <a name="l00102"></a>00102 <span class="preprocessor"></span> |
| <a name="l00103"></a>00103 <span class="keyword">namespace </span>kudu { |
| <a name="l00104"></a>00104 |
| <a name="l00106"></a><a class="code" href="classkudu_1_1Status.html">00106</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a> { |
| <a name="l00107"></a>00107 <span class="keyword">public</span>: |
| <a name="l00109"></a><a class="code" href="classkudu_1_1Status.html#ad14eb530b3449967ee976aaa1c0bcde0">00109</a> <a class="code" href="classkudu_1_1Status.html#ad14eb530b3449967ee976aaa1c0bcde0" title="Create an object representing success status.">Status</a>() : state_(NULL) { } |
| <a name="l00110"></a>00110 |
| <a name="l00111"></a>00111 ~<a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a>() { <span class="keyword">delete</span>[] state_; } |
| <a name="l00112"></a>00112 |
| <a name="l00117"></a>00117 Status(<span class="keyword">const</span> Status& s); |
| <a name="l00118"></a>00118 |
| <a name="l00123"></a>00123 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> Status& s); |
| <a name="l00124"></a>00124 |
| <a name="l00125"></a>00125 <span class="preprocessor">#if __cplusplus >= 201103L</span> |
| <a name="l00130"></a>00130 <span class="preprocessor"> Status(Status&& s);</span> |
| <a name="l00131"></a>00131 <span class="preprocessor"></span> |
| <a name="l00136"></a>00136 <span class="keywordtype">void</span> operator=(Status&& s); |
| <a name="l00137"></a>00137 <span class="preprocessor">#endif</span> |
| <a name="l00138"></a>00138 <span class="preprocessor"></span> |
| <a name="l00140"></a><a class="code" href="classkudu_1_1Status.html#adaff3248b2f66041d0a7dd59f118b7ac">00140</a> <span class="keyword">static</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a> <a class="code" href="classkudu_1_1Status.html#adaff3248b2f66041d0a7dd59f118b7ac">OK</a>() { <span class="keywordflow">return</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a>(); } |
| <a name="l00141"></a>00141 |
| <a name="l00142"></a>00142 |
| <a name="l00154"></a>00154 <span class="keyword">static</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a> NotFound(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a>& msg, <span class="keyword">const</span> <a class="code" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a>& msg2 = <a class="code" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a>(), |
| <a name="l00155"></a>00155 int16_t posix_code = -1) { |
| <a name="l00156"></a>00156 <span class="keywordflow">return</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a>(kNotFound, msg, msg2, posix_code); |
| <a name="l00157"></a>00157 } |
| <a name="l00158"></a>00158 <span class="keyword">static</span> Status Corruption(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00159"></a>00159 int16_t posix_code = -1) { |
| <a name="l00160"></a>00160 <span class="keywordflow">return</span> Status(kCorruption, msg, msg2, posix_code); |
| <a name="l00161"></a>00161 } |
| <a name="l00162"></a>00162 <span class="keyword">static</span> Status NotSupported(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00163"></a>00163 int16_t posix_code = -1) { |
| <a name="l00164"></a>00164 <span class="keywordflow">return</span> Status(kNotSupported, msg, msg2, posix_code); |
| <a name="l00165"></a>00165 } |
| <a name="l00166"></a>00166 <span class="keyword">static</span> Status InvalidArgument(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00167"></a>00167 int16_t posix_code = -1) { |
| <a name="l00168"></a>00168 <span class="keywordflow">return</span> Status(kInvalidArgument, msg, msg2, posix_code); |
| <a name="l00169"></a>00169 } |
| <a name="l00170"></a>00170 <span class="keyword">static</span> Status IOError(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00171"></a>00171 int16_t posix_code = -1) { |
| <a name="l00172"></a>00172 <span class="keywordflow">return</span> Status(kIOError, msg, msg2, posix_code); |
| <a name="l00173"></a>00173 } |
| <a name="l00174"></a>00174 <span class="keyword">static</span> Status AlreadyPresent(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00175"></a>00175 int16_t posix_code = -1) { |
| <a name="l00176"></a>00176 <span class="keywordflow">return</span> Status(kAlreadyPresent, msg, msg2, posix_code); |
| <a name="l00177"></a>00177 } |
| <a name="l00178"></a>00178 <span class="keyword">static</span> Status RuntimeError(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00179"></a>00179 int16_t posix_code = -1) { |
| <a name="l00180"></a>00180 <span class="keywordflow">return</span> Status(kRuntimeError, msg, msg2, posix_code); |
| <a name="l00181"></a>00181 } |
| <a name="l00182"></a>00182 <span class="keyword">static</span> Status NetworkError(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00183"></a>00183 int16_t posix_code = -1) { |
| <a name="l00184"></a>00184 <span class="keywordflow">return</span> Status(kNetworkError, msg, msg2, posix_code); |
| <a name="l00185"></a>00185 } |
| <a name="l00186"></a>00186 <span class="keyword">static</span> Status IllegalState(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00187"></a>00187 int16_t posix_code = -1) { |
| <a name="l00188"></a>00188 <span class="keywordflow">return</span> Status(kIllegalState, msg, msg2, posix_code); |
| <a name="l00189"></a>00189 } |
| <a name="l00190"></a>00190 <span class="keyword">static</span> Status NotAuthorized(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00191"></a>00191 int16_t posix_code = -1) { |
| <a name="l00192"></a>00192 <span class="keywordflow">return</span> Status(kNotAuthorized, msg, msg2, posix_code); |
| <a name="l00193"></a>00193 } |
| <a name="l00194"></a>00194 <span class="keyword">static</span> Status Aborted(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00195"></a>00195 int16_t posix_code = -1) { |
| <a name="l00196"></a>00196 <span class="keywordflow">return</span> Status(kAborted, msg, msg2, posix_code); |
| <a name="l00197"></a>00197 } |
| <a name="l00198"></a>00198 <span class="keyword">static</span> Status RemoteError(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00199"></a>00199 int16_t posix_code = -1) { |
| <a name="l00200"></a>00200 <span class="keywordflow">return</span> Status(kRemoteError, msg, msg2, posix_code); |
| <a name="l00201"></a>00201 } |
| <a name="l00202"></a>00202 <span class="keyword">static</span> Status ServiceUnavailable(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00203"></a>00203 int16_t posix_code = -1) { |
| <a name="l00204"></a>00204 <span class="keywordflow">return</span> Status(kServiceUnavailable, msg, msg2, posix_code); |
| <a name="l00205"></a>00205 } |
| <a name="l00206"></a>00206 <span class="keyword">static</span> Status TimedOut(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00207"></a>00207 int16_t posix_code = -1) { |
| <a name="l00208"></a>00208 <span class="keywordflow">return</span> Status(kTimedOut, msg, msg2, posix_code); |
| <a name="l00209"></a>00209 } |
| <a name="l00210"></a>00210 <span class="keyword">static</span> Status Uninitialized(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00211"></a>00211 int16_t posix_code = -1) { |
| <a name="l00212"></a>00212 <span class="keywordflow">return</span> Status(kUninitialized, msg, msg2, posix_code); |
| <a name="l00213"></a>00213 } |
| <a name="l00214"></a>00214 <span class="keyword">static</span> Status ConfigurationError(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00215"></a>00215 int16_t posix_code = -1) { |
| <a name="l00216"></a>00216 <span class="keywordflow">return</span> Status(kConfigurationError, msg, msg2, posix_code); |
| <a name="l00217"></a>00217 } |
| <a name="l00218"></a>00218 <span class="keyword">static</span> Status Incomplete(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00219"></a>00219 int64_t posix_code = -1) { |
| <a name="l00220"></a>00220 <span class="keywordflow">return</span> Status(kIncomplete, msg, msg2, posix_code); |
| <a name="l00221"></a>00221 } |
| <a name="l00222"></a>00222 <span class="keyword">static</span> Status EndOfFile(<span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2 = Slice(), |
| <a name="l00223"></a>00223 int64_t posix_code = -1) { |
| <a name="l00224"></a>00224 <span class="keywordflow">return</span> Status(kEndOfFile, msg, msg2, posix_code); |
| <a name="l00225"></a>00225 } |
| <a name="l00227"></a>00227 |
| <a name="l00229"></a><a class="code" href="classkudu_1_1Status.html#abf6454dcb72bfa92189a0595b5a858a7">00229</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#abf6454dcb72bfa92189a0595b5a858a7">ok</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (state_ == NULL); } |
| <a name="l00230"></a>00230 |
| <a name="l00232"></a><a class="code" href="classkudu_1_1Status.html#a38e1a8eb7b23092569cb61983ebb671d">00232</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a38e1a8eb7b23092569cb61983ebb671d">IsNotFound</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kNotFound; } |
| <a name="l00233"></a>00233 |
| <a name="l00235"></a><a class="code" href="classkudu_1_1Status.html#a36fa7d6fc0cd9ab1f9ad48e4a7614bc9">00235</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a36fa7d6fc0cd9ab1f9ad48e4a7614bc9">IsCorruption</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kCorruption; } |
| <a name="l00236"></a>00236 |
| <a name="l00238"></a><a class="code" href="classkudu_1_1Status.html#a2b1672aba7ec84133cd086186b27821b">00238</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a2b1672aba7ec84133cd086186b27821b">IsNotSupported</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kNotSupported; } |
| <a name="l00239"></a>00239 |
| <a name="l00241"></a><a class="code" href="classkudu_1_1Status.html#a991a91d7c07ffa41e6802a12f34d1acf">00241</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a991a91d7c07ffa41e6802a12f34d1acf">IsIOError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kIOError; } |
| <a name="l00242"></a>00242 |
| <a name="l00244"></a><a class="code" href="classkudu_1_1Status.html#a56e991c78f5a4aed32b97fbeccf13c2c">00244</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a56e991c78f5a4aed32b97fbeccf13c2c">IsInvalidArgument</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kInvalidArgument; } |
| <a name="l00245"></a>00245 |
| <a name="l00247"></a><a class="code" href="classkudu_1_1Status.html#ab9e4ddf4c48889f365c6d359ae560e1c">00247</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#ab9e4ddf4c48889f365c6d359ae560e1c">IsAlreadyPresent</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kAlreadyPresent; } |
| <a name="l00248"></a>00248 |
| <a name="l00250"></a><a class="code" href="classkudu_1_1Status.html#abc68e44f825df4e221e9fcce419a90cf">00250</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#abc68e44f825df4e221e9fcce419a90cf">IsRuntimeError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kRuntimeError; } |
| <a name="l00251"></a>00251 |
| <a name="l00253"></a><a class="code" href="classkudu_1_1Status.html#a70c83ddb5b234e814db84dfbbb751d0c">00253</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a70c83ddb5b234e814db84dfbbb751d0c">IsNetworkError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kNetworkError; } |
| <a name="l00254"></a>00254 |
| <a name="l00256"></a><a class="code" href="classkudu_1_1Status.html#a75e5cf90718eea9654c7e58546ea1aa2">00256</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a75e5cf90718eea9654c7e58546ea1aa2">IsIllegalState</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kIllegalState; } |
| <a name="l00257"></a>00257 |
| <a name="l00259"></a><a class="code" href="classkudu_1_1Status.html#aef9c22bc13669be3e2289844ec916244">00259</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#aef9c22bc13669be3e2289844ec916244">IsNotAuthorized</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kNotAuthorized; } |
| <a name="l00260"></a>00260 |
| <a name="l00262"></a><a class="code" href="classkudu_1_1Status.html#ad4fe06882fdfb2a040e4d7d10363ca0a">00262</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#ad4fe06882fdfb2a040e4d7d10363ca0a">IsAborted</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kAborted; } |
| <a name="l00263"></a>00263 |
| <a name="l00265"></a><a class="code" href="classkudu_1_1Status.html#a96a35401df4ecd6420c86c65bc3e05f9">00265</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a96a35401df4ecd6420c86c65bc3e05f9">IsRemoteError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kRemoteError; } |
| <a name="l00266"></a>00266 |
| <a name="l00268"></a><a class="code" href="classkudu_1_1Status.html#a7bce15fc7b4d95b0bdffce963972cce8">00268</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a7bce15fc7b4d95b0bdffce963972cce8">IsServiceUnavailable</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kServiceUnavailable; } |
| <a name="l00269"></a>00269 |
| <a name="l00271"></a><a class="code" href="classkudu_1_1Status.html#a80fe0286d8e3ac011a611afbac4edb11">00271</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a80fe0286d8e3ac011a611afbac4edb11">IsTimedOut</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kTimedOut; } |
| <a name="l00272"></a>00272 |
| <a name="l00274"></a><a class="code" href="classkudu_1_1Status.html#a325666f396d7f9900403765cecbaecbf">00274</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a325666f396d7f9900403765cecbaecbf">IsUninitialized</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kUninitialized; } |
| <a name="l00275"></a>00275 |
| <a name="l00277"></a><a class="code" href="classkudu_1_1Status.html#a8d31d26943101023125666bbbea002e3">00277</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#a8d31d26943101023125666bbbea002e3">IsConfigurationError</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kConfigurationError; } |
| <a name="l00278"></a>00278 |
| <a name="l00280"></a><a class="code" href="classkudu_1_1Status.html#af68a02f8069b1a8670fcc1b7acd869b9">00280</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#af68a02f8069b1a8670fcc1b7acd869b9">IsIncomplete</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kIncomplete; } |
| <a name="l00281"></a>00281 |
| <a name="l00283"></a><a class="code" href="classkudu_1_1Status.html#adead843ea27f50252f561c995c97b2e6">00283</a> <span class="keywordtype">bool</span> <a class="code" href="classkudu_1_1Status.html#adead843ea27f50252f561c995c97b2e6">IsEndOfFile</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> code() == kEndOfFile; } |
| <a name="l00284"></a>00284 |
| <a name="l00287"></a>00287 std::string ToString() <span class="keyword">const</span>; |
| <a name="l00288"></a>00288 |
| <a name="l00291"></a>00291 std::string CodeAsString() <span class="keyword">const</span>; |
| <a name="l00292"></a>00292 |
| <a name="l00301"></a>00301 <a class="code" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a> message() <span class="keyword">const</span>; |
| <a name="l00302"></a>00302 |
| <a name="l00305"></a>00305 int16_t posix_code() <span class="keyword">const</span>; |
| <a name="l00306"></a>00306 |
| <a name="l00313"></a>00313 <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a> CloneAndPrepend(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a>& msg) <span class="keyword">const</span>; |
| <a name="l00314"></a>00314 |
| <a name="l00321"></a>00321 <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a> CloneAndAppend(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Slice.html" title="A wrapper around externally allocated data.">Slice</a>& msg) <span class="keyword">const</span>; |
| <a name="l00322"></a>00322 |
| <a name="l00325"></a>00325 <span class="keywordtype">size_t</span> memory_footprint_excluding_this() <span class="keyword">const</span>; |
| <a name="l00326"></a>00326 |
| <a name="l00329"></a>00329 <span class="keywordtype">size_t</span> memory_footprint_including_this() <span class="keyword">const</span>; |
| <a name="l00330"></a>00330 |
| <a name="l00331"></a>00331 <span class="keyword">private</span>: |
| <a name="l00332"></a>00332 <span class="comment">// OK status has a NULL state_. Otherwise, state_ is a new[] array</span> |
| <a name="l00333"></a>00333 <span class="comment">// of the following form:</span> |
| <a name="l00334"></a>00334 <span class="comment">// state_[0..3] == length of message</span> |
| <a name="l00335"></a>00335 <span class="comment">// state_[4] == code</span> |
| <a name="l00336"></a>00336 <span class="comment">// state_[5..6] == posix_code</span> |
| <a name="l00337"></a>00337 <span class="comment">// state_[7..] == message</span> |
| <a name="l00338"></a>00338 <span class="keyword">const</span> <span class="keywordtype">char</span>* state_; |
| <a name="l00339"></a>00339 |
| <a name="l00340"></a>00340 <span class="keyword">enum</span> Code { |
| <a name="l00341"></a>00341 kOk = 0, |
| <a name="l00342"></a>00342 kNotFound = 1, |
| <a name="l00343"></a>00343 kCorruption = 2, |
| <a name="l00344"></a>00344 kNotSupported = 3, |
| <a name="l00345"></a>00345 kInvalidArgument = 4, |
| <a name="l00346"></a>00346 kIOError = 5, |
| <a name="l00347"></a>00347 kAlreadyPresent = 6, |
| <a name="l00348"></a>00348 kRuntimeError = 7, |
| <a name="l00349"></a>00349 kNetworkError = 8, |
| <a name="l00350"></a>00350 kIllegalState = 9, |
| <a name="l00351"></a>00351 kNotAuthorized = 10, |
| <a name="l00352"></a>00352 kAborted = 11, |
| <a name="l00353"></a>00353 kRemoteError = 12, |
| <a name="l00354"></a>00354 kServiceUnavailable = 13, |
| <a name="l00355"></a>00355 kTimedOut = 14, |
| <a name="l00356"></a>00356 kUninitialized = 15, |
| <a name="l00357"></a>00357 kConfigurationError = 16, |
| <a name="l00358"></a>00358 kIncomplete = 17, |
| <a name="l00359"></a>00359 kEndOfFile = 18, |
| <a name="l00360"></a>00360 <span class="comment">// NOTE: Remember to duplicate these constants into wire_protocol.proto and</span> |
| <a name="l00361"></a>00361 <span class="comment">// and to add StatusTo/FromPB ser/deser cases in wire_protocol.cc !</span> |
| <a name="l00362"></a>00362 <span class="comment">// Also remember to make the same changes to the java client in Status.java.</span> |
| <a name="l00363"></a>00363 <span class="comment">//</span> |
| <a name="l00364"></a>00364 <span class="comment">// TODO: Move error codes into an error_code.proto or something similar.</span> |
| <a name="l00365"></a>00365 }; |
| <a name="l00366"></a>00366 COMPILE_ASSERT(<span class="keyword">sizeof</span>(Code) == 4, code_enum_size_is_part_of_abi); |
| <a name="l00367"></a>00367 |
| <a name="l00368"></a>00368 Code code()<span class="keyword"> const </span>{ |
| <a name="l00369"></a>00369 <span class="keywordflow">return</span> (state_ == NULL) ? kOk : <span class="keyword">static_cast<</span>Code<span class="keyword">></span>(state_[4]); |
| <a name="l00370"></a>00370 } |
| <a name="l00371"></a>00371 |
| <a name="l00372"></a>00372 Status(Code code, <span class="keyword">const</span> Slice& msg, <span class="keyword">const</span> Slice& msg2, int16_t posix_code); |
| <a name="l00373"></a>00373 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* CopyState(<span class="keyword">const</span> <span class="keywordtype">char</span>* s); |
| <a name="l00374"></a>00374 }; |
| <a name="l00375"></a>00375 |
| <a name="l00376"></a><a class="code" href="classkudu_1_1Status.html#affca5639a3341212bb23ae7f5c701803">00376</a> <span class="keyword">inline</span> <a class="code" href="classkudu_1_1Status.html#ad14eb530b3449967ee976aaa1c0bcde0" title="Create an object representing success status.">Status::Status</a>(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a>& s) { |
| <a name="l00377"></a>00377 state_ = (s.state_ == NULL) ? NULL : CopyState(s.state_); |
| <a name="l00378"></a>00378 } |
| <a name="l00379"></a><a class="code" href="classkudu_1_1Status.html#ae63eecd6e48fa007b2334b6459972c39">00379</a> <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classkudu_1_1Status.html#ae63eecd6e48fa007b2334b6459972c39">Status::operator=</a>(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a>& s) { |
| <a name="l00380"></a>00380 <span class="comment">// The following condition catches both aliasing (when this == &s),</span> |
| <a name="l00381"></a>00381 <span class="comment">// and the common case where both s and *this are ok.</span> |
| <a name="l00382"></a>00382 <span class="keywordflow">if</span> (state_ != s.state_) { |
| <a name="l00383"></a>00383 <span class="keyword">delete</span>[] state_; |
| <a name="l00384"></a>00384 state_ = (s.state_ == NULL) ? NULL : CopyState(s.state_); |
| <a name="l00385"></a>00385 } |
| <a name="l00386"></a>00386 } |
| <a name="l00387"></a>00387 |
| <a name="l00388"></a>00388 <span class="preprocessor">#if __cplusplus >= 201103L</span> |
| <a name="l00389"></a>00389 <span class="preprocessor"></span><span class="keyword">inline</span> <a class="code" href="classkudu_1_1Status.html#ad14eb530b3449967ee976aaa1c0bcde0" title="Create an object representing success status.">Status::Status</a>(<a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&#39;s outcome.">Status</a>&& s) : state_(s.state_) { |
| <a name="l00390"></a>00390 s.state_ = <span class="keyword">nullptr</span>; |
| <a name="l00391"></a>00391 } |
| <a name="l00392"></a>00392 |
| <a name="l00393"></a>00393 <span class="keyword">inline</span> <span class="keywordtype">void</span> <a class="code" href="classkudu_1_1Status.html#ae63eecd6e48fa007b2334b6459972c39">Status::operator=</a>(Status&& s) { |
| <a name="l00394"></a>00394 <span class="keywordflow">if</span> (state_ != s.state_) { |
| <a name="l00395"></a>00395 <span class="keyword">delete</span>[] state_; |
| <a name="l00396"></a>00396 state_ = s.state_; |
| <a name="l00397"></a>00397 s.state_ = <span class="keyword">nullptr</span>; |
| <a name="l00398"></a>00398 } |
| <a name="l00399"></a>00399 } |
| <a name="l00400"></a>00400 <span class="preprocessor">#endif</span> |
| <a name="l00401"></a>00401 <span class="preprocessor"></span> |
| <a name="l00402"></a>00402 } <span class="comment">// namespace kudu</span> |
| <a name="l00403"></a>00403 |
| <a name="l00404"></a>00404 <span class="preprocessor">#endif // KUDU_UTIL_STATUS_H_</span> |
| </pre></div></div> |
| <!--- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <!-- start footer part --> |
| <hr class="footer"/> |
| <address class="footer"> |
| <small>Generated for Kudu version 1.0.1 on Tue Oct 11 08:52:01 2016 by Doxygen 1.6.1</small> |
| <br> |
| <small>Copyright © 2016 The Apache Software Foundation.</small> |
| </address> |
| </body> |
| </html> |
