diff options
Diffstat (limited to 'shared/inotify/doc/man/man3/InotifyWatch.3')
| -rw-r--r-- | shared/inotify/doc/man/man3/InotifyWatch.3 | 134 |
1 files changed, 96 insertions, 38 deletions
diff --git a/shared/inotify/doc/man/man3/InotifyWatch.3 b/shared/inotify/doc/man/man3/InotifyWatch.3 index ea352997..cac74012 100644 --- a/shared/inotify/doc/man/man3/InotifyWatch.3 +++ b/shared/inotify/doc/man/man3/InotifyWatch.3 @@ -1,4 +1,4 @@ -.TH "InotifyWatch" 3 "18 Apr 2007" "Version 0.7.2" "inotify-cxx" \" -*- nroff -*- +.TH "InotifyWatch" 3 "9 Dec 2009" "Version 0.7.3" "inotify-cxx" \" -*- nroff -*- .ad l .nh .SH NAME @@ -22,15 +22,15 @@ InotifyWatch \- inotify watch class .br .RI "\fIDestructor. \fP" .ti -1c -.RI "int32_t \fBGetDescriptor\fP () const" +.RI "int32_t \fBGetDescriptor\fP () const " .br .RI "\fIReturns the watch descriptor. \fP" .ti -1c -.RI "const std::string & \fBGetPath\fP () const" +.RI "const std::string & \fBGetPath\fP () const " .br .RI "\fIReturns the watched file path. \fP" .ti -1c -.RI "uint32_t \fBGetMask\fP () const" +.RI "uint32_t \fBGetMask\fP () const " .br .RI "\fIReturns the watch event mask. \fP" .ti -1c @@ -46,14 +46,46 @@ InotifyWatch \- inotify watch class .br .RI "\fIEnables/disables the watch. \fP" .ti -1c -.RI "bool \fBIsEnabled\fP () const" +.RI "bool \fBIsEnabled\fP () const " .br .RI "\fIChecks whether the watch is enabled. \fP" .ti -1c -.RI "bool \fBIsRecursive\fP () const" +.RI "bool \fBIsRecursive\fP () const " .br .RI "\fIChecks whether the watch is recursive. \fP" .in -1c +.SS "Private Member Functions" + +.in +1c +.ti -1c +.RI "IN_LOCK_DECL void \fB__Disable\fP ()" +.br +.RI "\fIDisables the watch (due to removing by the kernel). \fP" +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "std::string \fBm_path\fP" +.br +.RI "\fIwatched file path \fP" +.ti -1c +.RI "uint32_t \fBm_uMask\fP" +.br +.RI "\fIevent mask \fP" +.ti -1c +.RI "int32_t \fBm_wd\fP" +.br +.RI "\fIwatch descriptor \fP" +.ti -1c +.RI "\fBInotify\fP * \fBm_pInotify\fP" +.br +.RI "\fIinotify object \fP" +.ti -1c +.RI "bool \fBm_fEnabled\fP" +.br +.RI "\fIevents enabled yes/no \fP" +.in -1c .SS "Friends" .in +1c @@ -68,7 +100,6 @@ inotify watch class It holds information about the inotify watch on a particular inode. .PP If the INOTIFY_THREAD_SAFE is defined this class is thread-safe. -.PP .SH "Constructor & Destructor Documentation" .PP .SS "InotifyWatch::InotifyWatch (const std::string & rPath, int32_t uMask, bool fEnabled = \fCtrue\fP)\fC [inline]\fP" @@ -93,6 +124,11 @@ Destructor. .PP .SH "Member Function Documentation" .PP +.SS "void InotifyWatch::__Disable ()\fC [private]\fP" +.PP +Disables the watch (due to removing by the kernel). +.PP +This method must be called after receiving an event. It ensures the watch object is consistent with the kernel data. .SS "int32_t InotifyWatch::GetDescriptor () const\fC [inline]\fP" .PP Returns the watch descriptor. @@ -103,13 +139,13 @@ watch descriptor; -1 for inactive watch .RE .PP -.SS "const std::string& InotifyWatch::GetPath () const\fC [inline]\fP" +.SS "\fBInotify\fP* InotifyWatch::GetInotify ()\fC [inline]\fP" .PP -Returns the watched file path. +Returns the appropriate inotify class instance. .PP \fBReturns:\fP .RS 4 -file path +inotify instance .RE .PP @@ -123,30 +159,40 @@ event mask .RE .PP -.SS "void InotifyWatch::SetMask (uint32_t uMask) throw (\fBInotifyException\fP)" -.PP -Sets the watch event mask. +.SS "const std::string& InotifyWatch::GetPath () const\fC [inline]\fP" .PP -If the watch is active (added to an instance of \fBInotify\fP) this method may fail due to unsuccessful re-setting the watch in the kernel. +Returns the watched file path. .PP -\fBParameters:\fP +\fBReturns:\fP .RS 4 -\fIuMask\fP event mask +file path .RE .PP -\fBExceptions:\fP + +.SS "bool InotifyWatch::IsEnabled () const\fC [inline]\fP" +.PP +Checks whether the watch is enabled. +.PP +\fBReturns:\fP .RS 4 -\fI\fBInotifyException\fP\fP thrown if changing fails +true = enables, false = disabled .RE .PP -.SS "\fBInotify\fP* InotifyWatch::GetInotify ()\fC [inline]\fP" +.SS "bool InotifyWatch::IsRecursive () const\fC [inline]\fP" .PP -Returns the appropriate inotify class instance. +Checks whether the watch is recursive. +.PP +A recursive watch monitors a directory itself and all its subdirectories. This watch is a logical object which may have many underlying kernel watches. .PP \fBReturns:\fP .RS 4 -inotify instance +currently always false (recursive watches not yet supported) +.RE +.PP +\fBAttention:\fP +.RS 4 +Recursive watches are currently NOT supported. They are planned for future versions. .RE .PP @@ -169,30 +215,20 @@ Re-setting the current state has no effect. .RE .PP -.SS "bool InotifyWatch::IsEnabled () const\fC [inline]\fP" -.PP -Checks whether the watch is enabled. -.PP -\fBReturns:\fP -.RS 4 -true = enables, false = disabled -.RE -.PP - -.SS "bool InotifyWatch::IsRecursive () const\fC [inline]\fP" +.SS "void InotifyWatch::SetMask (uint32_t uMask) throw (\fBInotifyException\fP)" .PP -Checks whether the watch is recursive. +Sets the watch event mask. .PP -A recursive watch monitors a directory itself and all its subdirectories. This watch is a logical object which may have many underlying kernel watches. +If the watch is active (added to an instance of \fBInotify\fP) this method may fail due to unsuccessful re-setting the watch in the kernel. .PP -\fBReturns:\fP +\fBParameters:\fP .RS 4 -currently always false (recursive watches not yet supported) +\fIuMask\fP event mask .RE .PP -\fBAttention:\fP +\fBExceptions:\fP .RS 4 -Recursive watches are currently NOT supported. They are planned for future versions. +\fI\fBInotifyException\fP\fP thrown if changing fails .RE .PP @@ -200,6 +236,28 @@ Recursive watches are currently NOT supported. They are planned for future versi .PP .SS "friend class \fBInotify\fP\fC [friend]\fP" .PP +.SH "Member Data Documentation" +.PP +.SS "bool \fBInotifyWatch::m_fEnabled\fP\fC [private]\fP" +.PP +events enabled yes/no +.PP +.SS "std::string \fBInotifyWatch::m_path\fP\fC [private]\fP" +.PP +watched file path +.PP +.SS "\fBInotify\fP* \fBInotifyWatch::m_pInotify\fP\fC [private]\fP" +.PP +inotify object +.PP +.SS "uint32_t \fBInotifyWatch::m_uMask\fP\fC [private]\fP" +.PP +event mask +.PP +.SS "int32_t \fBInotifyWatch::m_wd\fP\fC [private]\fP" +.PP +watch descriptor +.PP .SH "Author" |