blob: 204c19eea265f565404fc8777da5d9329bcfe545 [file] [log] [blame]
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Mesos: 3rdparty/stout/include/stout/errorbase.hpp Source File</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="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 style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_aa547de1d719d14adccfca1dfb1735b3.html">stout</a></li><li class="navelem"><a class="el" href="dir_1a1b923d951dd999d43396870333fc33.html">include</a></li><li class="navelem"><a class="el" href="dir_dbd52553d038069c1ed93e3477ea333d.html">stout</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">errorbase.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="errorbase_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// limitations under the License.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __STOUT_ERROR_BASE_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __STOUT_ERROR_BASE_HPP__</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;errno.h&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="strerror_8hpp.html">stout/os/strerror.hpp</a>&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// A useful type that can be used to represent a Try that has</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// failed. You can also use &#39;ErrnoError&#39; to append the error message</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// associated with the current &#39;errno&#39; to your own error message.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// Examples:</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">// Result&lt;int&gt; result = Error(&quot;uninitialized&quot;);</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">// Try&lt;std::string&gt; = Error(&quot;uninitialized&quot;);</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// void foo(Try&lt;std::string&gt; t) {}</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment">// foo(Error(&quot;some error here&quot;));</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classError.html"> 35</a></span>&#160;<span class="keyword">class </span><a class="code" href="classError.html">Error</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classError.html#a8e2d6ac199136b5c2d58b4879c0c80f5"> 38</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classError.html#a8e2d6ac199136b5c2d58b4879c0c80f5">Error</a>(<span class="keyword">const</span> std::string&amp; _message) : <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>(_message) {}</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f"> 40</a></span>&#160; <span class="keyword">const</span> std::string <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;};</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classErrnoError.html"> 44</a></span>&#160;<span class="keyword">class </span><a class="code" href="classErrnoError.html">ErrnoError</a> : <span class="keyword">public</span> <a class="code" href="classError.html">Error</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;{</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classErrnoError.html#a4f09179e3135d75e2fec6cc27738b850"> 47</a></span>&#160; <a class="code" href="classErrnoError.html#a4f09179e3135d75e2fec6cc27738b850">ErrnoError</a>() : <a class="code" href="classErrnoError.html">ErrnoError</a>(errno) {}</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classErrnoError.html#a776ccad895cf5e485e50b7e9b4314a58"> 49</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classErrnoError.html#a776ccad895cf5e485e50b7e9b4314a58">ErrnoError</a>(<span class="keywordtype">int</span> _code) : <a class="code" href="classError.html">Error</a>(os::<a class="code" href="namespaceos.html#aa9ac22b4028f187826a9861373006abf">strerror</a>(_code)), <a class="code" href="classErrnoError.html#ae512d4301c6ef39767a39a5636810ff6">code</a>(_code) {}</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classErrnoError.html#a89f63f911e2a6fc8b830e69085283ee3"> 51</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classErrnoError.html#a89f63f911e2a6fc8b830e69085283ee3">ErrnoError</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; : <a class="code" href="classErrnoError.html">ErrnoError</a>(errno, message) {}</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classErrnoError.html#aa971258da649d454025c8cb89fc97ef6"> 54</a></span>&#160; <a class="code" href="classErrnoError.html#aa971258da649d454025c8cb89fc97ef6">ErrnoError</a>(<span class="keywordtype">int</span> _code, <span class="keyword">const</span> std::string&amp; <a class="code" href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">message</a>)</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; : <a class="code" href="classError.html">Error</a>(message + <span class="stringliteral">&quot;: &quot;</span> + os::<a class="code" href="namespaceos.html#aa9ac22b4028f187826a9861373006abf">strerror</a>(_code)), <a class="code" href="classErrnoError.html#ae512d4301c6ef39767a39a5636810ff6">code</a>(_code) {}</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classErrnoError.html#ae512d4301c6ef39767a39a5636810ff6"> 57</a></span>&#160; <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classErrnoError.html#ae512d4301c6ef39767a39a5636810ff6">code</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;};</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="preprocessor">#endif // __STOUT_ERROR_BASE_HPP__</span></div>
<div class="ttc" id="namespaceos_html_aa9ac22b4028f187826a9861373006abf"><div class="ttname"><a href="namespaceos.html#aa9ac22b4028f187826a9861373006abf">os::strerror</a></div><div class="ttdeci">std::string strerror(int errno_)</div><div class="ttdoc">A thread-safe version of strerror. </div><div class="ttdef"><b>Definition:</b> strerror.hpp:30</div></div>
<div class="ttc" id="classError_html"><div class="ttname"><a href="classError.html">Error</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:35</div></div>
<div class="ttc" id="classError_html_a8e2d6ac199136b5c2d58b4879c0c80f5"><div class="ttname"><a href="classError.html#a8e2d6ac199136b5c2d58b4879c0c80f5">Error::Error</a></div><div class="ttdeci">Error(const std::string &amp;_message)</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:38</div></div>
<div class="ttc" id="classErrnoError_html_aa971258da649d454025c8cb89fc97ef6"><div class="ttname"><a href="classErrnoError.html#aa971258da649d454025c8cb89fc97ef6">ErrnoError::ErrnoError</a></div><div class="ttdeci">ErrnoError(int _code, const std::string &amp;message)</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:54</div></div>
<div class="ttc" id="classErrnoError_html"><div class="ttname"><a href="classErrnoError.html">ErrnoError</a></div><div class="ttdef"><b>Definition:</b> errorbase.hpp:44</div></div>
<div class="ttc" id="classErrnoError_html_a89f63f911e2a6fc8b830e69085283ee3"><div class="ttname"><a href="classErrnoError.html#a89f63f911e2a6fc8b830e69085283ee3">ErrnoError::ErrnoError</a></div><div class="ttdeci">ErrnoError(const std::string &amp;message)</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:51</div></div>
<div class="ttc" id="strerror_8hpp_html"><div class="ttname"><a href="strerror_8hpp.html">strerror.hpp</a></div></div>
<div class="ttc" id="classErrnoError_html_a4f09179e3135d75e2fec6cc27738b850"><div class="ttname"><a href="classErrnoError.html#a4f09179e3135d75e2fec6cc27738b850">ErrnoError::ErrnoError</a></div><div class="ttdeci">ErrnoError()</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:47</div></div>
<div class="ttc" id="classError_html_a2d13609e80acd2a2a473a26f273b1c4f"><div class="ttname"><a href="classError.html#a2d13609e80acd2a2a473a26f273b1c4f">Error::message</a></div><div class="ttdeci">const std::string message</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:40</div></div>
<div class="ttc" id="classErrnoError_html_ae512d4301c6ef39767a39a5636810ff6"><div class="ttname"><a href="classErrnoError.html#ae512d4301c6ef39767a39a5636810ff6">ErrnoError::code</a></div><div class="ttdeci">const int code</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:57</div></div>
<div class="ttc" id="classErrnoError_html_a776ccad895cf5e485e50b7e9b4314a58"><div class="ttname"><a href="classErrnoError.html#a776ccad895cf5e485e50b7e9b4314a58">ErrnoError::ErrnoError</a></div><div class="ttdeci">ErrnoError(int _code)</div><div class="ttdef"><b>Definition:</b> errorbase.hpp:49</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>