1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: Passenger::SystemException Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1SystemException.html">SystemException</a>
</div>
</div>
<div class="contents">
<h1>Passenger::SystemException Class Reference<br>
<small>
[<a class="el" href="group__Exceptions.html">Exceptions</a>]</small>
</h1><!-- doxytag: class="Passenger::SystemException" -->Represents an error returned by a system call or a standard library call.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Exceptions_8h-source.html">Exceptions.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for Passenger::SystemException:</div>
<div class="dynsection">
<p><center><img src="classPassenger_1_1SystemException__inherit__graph.png" border="0" usemap="#Passenger_1_1SystemException__inherit__map" alt="Inheritance graph"></center>
<map name="Passenger_1_1SystemException__inherit__map">
<area shape="rect" href="classPassenger_1_1FileSystemException.html" title="A filesystem error, as returned by the operating system." alt="" coords="5,80,227,107"><area shape="rect" href="classPassenger_1_1TimeRetrievalException.html" title="Unable to retrieve the system time using time()." alt="" coords="251,80,488,107"></map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classPassenger_1_1SystemException-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1SystemException.html#1f0f33c63934ee40c5cd9c338c8aa04b">SystemException</a> (const string &briefMessage, int errorCode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>. <a href="#1f0f33c63934ee40c5cd9c338c8aa04b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ee7a6672bf79b72a4c3ee70c57d6a47c"></a><!-- doxytag: member="Passenger::SystemException::code" ref="ee7a6672bf79b72a4c3ee70c57d6a47c" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c">code</a> () const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The value of <code>errno</code> at the time the error occured. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1SystemException.html#84fa2ab4f5b7b96704734fcdfdaa0269">brief</a> () const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a brief version of the exception message. <a href="#84fa2ab4f5b7b96704734fcdfdaa0269"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1SystemException.html#0ef41d755fea2c9b1db2252e7c418dc8">sys</a> () const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the system's error message. <a href="#0ef41d755fea2c9b1db2252e7c418dc8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents an error returned by a system call or a standard library call.
<p>
Use the <a class="el" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code()</a> method to find out the value of <code>errno</code> at the time the error occured. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="1f0f33c63934ee40c5cd9c338c8aa04b"></a><!-- doxytag: member="Passenger::SystemException::SystemException" ref="1f0f33c63934ee40c5cd9c338c8aa04b" args="(const string &briefMessage, int errorCode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Passenger::SystemException::SystemException </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>briefMessage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>errorCode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new <a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>briefMessage</em> </td><td>A brief message describing the error. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>errorCode</em> </td><td>The error code, i.e. the value of errno right after the error occured. </td></tr>
</table>
</dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>A system description of the error will be appended to the given message. For example, if <code>errorCode</code> is <code>EBADF</code>, and <code>briefMessage</code> is <em>"Something happened"</em>, then what() will return <em>"Something happened: Bad file descriptor (10)"</em> (if 10 is the number for EBADF). </dd></dl>
<dl class="post" compact><dt><b>Postcondition:</b></dt><dd><a class="el" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code()</a> == errorCode <p>
<a class="el" href="classPassenger_1_1SystemException.html#84fa2ab4f5b7b96704734fcdfdaa0269" title="Returns a brief version of the exception message.">brief()</a> == briefMessage </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="84fa2ab4f5b7b96704734fcdfdaa0269"></a><!-- doxytag: member="Passenger::SystemException::brief" ref="84fa2ab4f5b7b96704734fcdfdaa0269" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Passenger::SystemException::brief </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a brief version of the exception message.
<p>
This message does not include the system error description, and is equivalent to the value of the <code>message</code> parameter as passed to the constructor.
</div>
</div><p>
<a class="anchor" name="0ef41d755fea2c9b1db2252e7c418dc8"></a><!-- doxytag: member="Passenger::SystemException::sys" ref="0ef41d755fea2c9b1db2252e7c418dc8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Passenger::SystemException::sys </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const throw ()<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the system's error message.
<p>
This message contains both the content of <code>strerror(errno)</code> and the errno number itself.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Exceptions_8h-source.html">Exceptions.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:48 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
