summaryrefslogtreecommitdiff
path: root/shared/inotify/doc/man/man3/InotifyException.3
blob: 57bc1bec95bc5711c6f1492a9ef58bb8fc92ac8f (plain)
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
.TH "InotifyException" 3 "9 Dec 2009" "Version 0.7.3" "inotify-cxx" \" -*- nroff -*-
.ad l
.nh
.SH NAME
InotifyException \- Class for inotify exceptions.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <inotify-cxx.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBInotifyException\fP (const std::string &rMsg='', int iErr=0, void *pSrc=NULL)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "const std::string & \fBGetMessage\fP () const "
.br
.RI "\fIReturns the exception message. \fP"
.ti -1c
.RI "int \fBGetErrorNumber\fP () const "
.br
.RI "\fIReturns the exception error number. \fP"
.ti -1c
.RI "void * \fBGetSource\fP () const "
.br
.RI "\fIReturns the exception source. \fP"
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "std::string \fBm_msg\fP"
.br
.RI "\fImessage \fP"
.ti -1c
.RI "int \fBm_err\fP"
.br
.RI "\fIerror number \fP"
.ti -1c
.RI "void * \fBm_pSrc\fP"
.br
.RI "\fIsource \fP"
.in -1c
.SH "Detailed Description"
.PP 
Class for inotify exceptions. 

This class allows to acquire information about exceptional events. It makes easier to log or display error messages and to identify problematic code locations.
.PP
Although this class is basically thread-safe it is not intended to be shared between threads. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "InotifyException::InotifyException (const std::string & rMsg = \fC''\fP, int iErr = \fC0\fP, void * pSrc = \fCNULL\fP)\fC [inline]\fP"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIrMsg\fP message 
.br
\fIiErr\fP error number (see errno.h) 
.br
\fIpSrc\fP source 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "int InotifyException::GetErrorNumber () const\fC [inline]\fP"
.PP
Returns the exception error number. 
.PP
If not applicable this value is 0 (zero).
.PP
\fBReturns:\fP
.RS 4
error number (standardized; see errno.h) 
.RE
.PP

.SS "const std::string& InotifyException::GetMessage () const\fC [inline]\fP"
.PP
Returns the exception message. 
.PP
\fBReturns:\fP
.RS 4
message 
.RE
.PP

.SS "void* InotifyException::GetSource () const\fC [inline]\fP"
.PP
Returns the exception source. 
.PP
\fBReturns:\fP
.RS 4
source 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "int \fBInotifyException::m_err\fP\fC [protected]\fP"
.PP
error number 
.PP
.SS "std::string \fBInotifyException::m_msg\fP\fC [protected]\fP"
.PP
message 
.PP
.SS "void* \fBInotifyException::m_pSrc\fP\fC [mutable, protected]\fP"
.PP
source 
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for inotify-cxx from the source code.
bgstack15