diff options
Diffstat (limited to 'shared/inotify/doc/man/man3/InotifyEvent.3')
| -rw-r--r-- | shared/inotify/doc/man/man3/InotifyEvent.3 | 172 |
1 files changed, 105 insertions, 67 deletions
diff --git a/shared/inotify/doc/man/man3/InotifyEvent.3 b/shared/inotify/doc/man/man3/InotifyEvent.3 index 51899460..c45eaba9 100644 --- a/shared/inotify/doc/man/man3/InotifyEvent.3 +++ b/shared/inotify/doc/man/man3/InotifyEvent.3 @@ -1,4 +1,4 @@ -.TH "InotifyEvent" 3 "18 Apr 2007" "Version 0.7.2" "inotify-cxx" \" -*- nroff -*- +.TH "InotifyEvent" 3 "9 Dec 2009" "Version 0.7.3" "inotify-cxx" \" -*- nroff -*- .ad l .nh .SH NAME @@ -26,31 +26,31 @@ InotifyEvent \- inotify event class .br .RI "\fIDestructor. \fP" .ti -1c -.RI "int32_t \fBGetDescriptor\fP () const" +.RI "int32_t \fBGetDescriptor\fP () const " .br .RI "\fIReturns the event watch descriptor. \fP" .ti -1c -.RI "uint32_t \fBGetMask\fP () const" +.RI "uint32_t \fBGetMask\fP () const " .br .RI "\fIReturns the event mask. \fP" .ti -1c -.RI "bool \fBIsType\fP (uint32_t uType) const" +.RI "bool \fBIsType\fP (uint32_t uType) const " .br .RI "\fIChecks for the event type. \fP" .ti -1c -.RI "uint32_t \fBGetCookie\fP () const" +.RI "uint32_t \fBGetCookie\fP () const " .br .RI "\fIReturns the event cookie. \fP" .ti -1c -.RI "uint32_t \fBGetLength\fP () const" +.RI "uint32_t \fBGetLength\fP () const " .br .RI "\fIReturns the event name length. \fP" .ti -1c -.RI "const std::string & \fBGetName\fP () const" +.RI "const std::string & \fBGetName\fP () const " .br .RI "\fIReturns the event name. \fP" .ti -1c -.RI "void \fBGetName\fP (std::string &rName) const" +.RI "void \fBGetName\fP (std::string &rName) const " .br .RI "\fIExtracts the event name. \fP" .ti -1c @@ -58,7 +58,7 @@ InotifyEvent \- inotify event class .br .RI "\fIReturns the source watch. \fP" .ti -1c -.RI "void \fBDumpTypes\fP (std::string &rStr) const" +.RI "void \fBDumpTypes\fP (std::string &rStr) const " .br .RI "\fIFills the string with all types contained in the event mask. \fP" .in -1c @@ -78,6 +78,26 @@ InotifyEvent \- inotify event class .br .RI "\fIFills the string with all types contained in an event mask value. \fP" .in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "uint32_t \fBm_uMask\fP" +.br +.RI "\fImask \fP" +.ti -1c +.RI "uint32_t \fBm_uCookie\fP" +.br +.RI "\fIcookie \fP" +.ti -1c +.RI "std::string \fBm_name\fP" +.br +.RI "\fIname \fP" +.ti -1c +.RI "\fBInotifyWatch\fP * \fBm_pWatch\fP" +.br +.RI "\fIsource watch \fP" +.in -1c .SH "Detailed Description" .PP inotify event class @@ -85,7 +105,6 @@ inotify event class It holds all information about inotify event and provides access to its particular values. .PP This class is not (and is not intended to be) thread-safe and therefore it must not be used concurrently in multiple threads. -.PP .SH "Constructor & Destructor Documentation" .PP .SS "InotifyEvent::InotifyEvent ()\fC [inline]\fP" @@ -113,95 +132,90 @@ Destructor. .PP .SH "Member Function Documentation" .PP -.SS "int32_t InotifyEvent::GetDescriptor () const" -.PP -Returns the event watch descriptor. +.SS "void InotifyEvent::DumpTypes (std::string & rStr) const" .PP -\fBReturns:\fP -.RS 4 -watch descriptor -.RE +Fills the string with all types contained in the event mask. .PP -\fBSee also:\fP +\fBParameters:\fP .RS 4 -\fBInotifyWatch::GetDescriptor()\fP +\fIrStr\fP dumped event types .RE .PP -.SS "uint32_t InotifyEvent::GetMask () const\fC [inline]\fP" -.PP -Returns the event mask. +.SS "void InotifyEvent::DumpTypes (uint32_t uValue, std::string & rStr)\fC [static]\fP" .PP -\fBReturns:\fP -.RS 4 -event mask -.RE +Fills the string with all types contained in an event mask value. .PP -\fBSee also:\fP +\fBParameters:\fP .RS 4 -\fBInotifyWatch::GetMask()\fP +\fIuValue\fP event mask value +.br +\fIrStr\fP dumped event types .RE .PP -.SS "static bool InotifyEvent::IsType (uint32_t uValue, uint32_t uType)\fC [inline, static]\fP" -.PP -Checks a value for the event type. +.SS "uint32_t InotifyEvent::GetCookie () const\fC [inline]\fP" .PP -\fBParameters:\fP -.RS 4 -\fIuValue\fP checked value -.br -\fIuType\fP type which is checked for -.RE +Returns the event cookie. .PP \fBReturns:\fP .RS 4 -true = the value contains the given type, false = otherwise +event cookie .RE .PP -.SS "bool InotifyEvent::IsType (uint32_t uType) const\fC [inline]\fP" +.SS "int32_t InotifyEvent::GetDescriptor () const" .PP -Checks for the event type. +Returns the event watch descriptor. .PP -\fBParameters:\fP +\fBReturns:\fP .RS 4 -\fIuType\fP type which is checked for +watch descriptor .RE .PP -\fBReturns:\fP +\fBSee also:\fP .RS 4 -true = event mask contains the given type, false = otherwise +\fBInotifyWatch::GetDescriptor()\fP .RE .PP -.SS "uint32_t InotifyEvent::GetCookie () const\fC [inline]\fP" +.SS "uint32_t InotifyEvent::GetLength () const\fC [inline]\fP" .PP -Returns the event cookie. +Returns the event name length. .PP \fBReturns:\fP .RS 4 -event cookie +event name length .RE .PP -.SS "uint32_t InotifyEvent::GetLength () const\fC [inline]\fP" +.SS "uint32_t InotifyEvent::GetMask () const\fC [inline]\fP" .PP -Returns the event name length. +Returns the event mask. .PP \fBReturns:\fP .RS 4 -event name length +event mask +.RE +.PP +\fBSee also:\fP +.RS 4 +\fBInotifyWatch::GetMask()\fP .RE .PP -.SS "const std::string& InotifyEvent::GetName () const\fC [inline]\fP" +.SS "uint32_t InotifyEvent::GetMaskByName (const std::string & rName)\fC [static]\fP" .PP -Returns the event name. +Finds the appropriate mask for a name. +.PP +\fBParameters:\fP +.RS 4 +\fIrName\fP mask name +.RE .PP \fBReturns:\fP .RS 4 -event name +mask for name; 0 on failure .RE .PP @@ -215,6 +229,16 @@ Extracts the event name. .RE .PP +.SS "const std::string& InotifyEvent::GetName () const\fC [inline]\fP" +.PP +Returns the event name. +.PP +\fBReturns:\fP +.RS 4 +event name +.RE +.PP + .SS "\fBInotifyWatch\fP* InotifyEvent::GetWatch ()\fC [inline]\fP" .PP Returns the source watch. @@ -225,41 +249,55 @@ source watch .RE .PP -.SS "uint32_t InotifyEvent::GetMaskByName (const std::string & rName)\fC [static]\fP" +.SS "bool InotifyEvent::IsType (uint32_t uType) const\fC [inline]\fP" .PP -Finds the appropriate mask for a name. +Checks for the event type. .PP \fBParameters:\fP .RS 4 -\fIrName\fP mask name +\fIuType\fP type which is checked for .RE .PP \fBReturns:\fP .RS 4 -mask for name; 0 on failure +true = event mask contains the given type, false = otherwise .RE .PP -.SS "void InotifyEvent::DumpTypes (uint32_t uValue, std::string & rStr)\fC [static]\fP" +.SS "static bool InotifyEvent::IsType (uint32_t uValue, uint32_t uType)\fC [inline, static]\fP" .PP -Fills the string with all types contained in an event mask value. +Checks a value for the event type. .PP \fBParameters:\fP .RS 4 -\fIuValue\fP event mask value +\fIuValue\fP checked value .br -\fIrStr\fP dumped event types +\fIuType\fP type which is checked for +.RE +.PP +\fBReturns:\fP +.RS 4 +true = the value contains the given type, false = otherwise .RE .PP -.SS "void InotifyEvent::DumpTypes (std::string & rStr) const" +.SH "Member Data Documentation" +.PP +.SS "std::string \fBInotifyEvent::m_name\fP\fC [private]\fP" .PP -Fills the string with all types contained in the event mask. +name .PP -\fBParameters:\fP -.RS 4 -\fIrStr\fP dumped event types -.RE +.SS "\fBInotifyWatch\fP* \fBInotifyEvent::m_pWatch\fP\fC [private]\fP" +.PP +source watch +.PP +.SS "uint32_t \fBInotifyEvent::m_uCookie\fP\fC [private]\fP" +.PP +cookie +.PP +.SS "uint32_t \fBInotifyEvent::m_uMask\fP\fC [private]\fP" +.PP +mask .PP |