From c0fce877c478ddbf71a1b651c789e5ea00a00144 Mon Sep 17 00:00:00 2001 From: Daniel Wilhelm Date: Fri, 18 Apr 2014 17:05:30 +0200 Subject: 3.4 --- shared/inotify/doc/html/classInotifyWatch.html | 349 +++++++++++++++++++------ 1 file changed, 262 insertions(+), 87 deletions(-) (limited to 'shared/inotify/doc/html/classInotifyWatch.html') diff --git a/shared/inotify/doc/html/classInotifyWatch.html b/shared/inotify/doc/html/classInotifyWatch.html index 119c7873..bc4f53e9 100644 --- a/shared/inotify/doc/html/classInotifyWatch.html +++ b/shared/inotify/doc/html/classInotifyWatch.html @@ -1,25 +1,39 @@ - + inotify-cxx: InotifyWatch Class Reference - + - -
-
-
-
+ + +

InotifyWatch Class Reference

inotify watch class More...

-#include <inotify-cxx.h> +#include <inotify-cxx.h> +

+

+Collaboration diagram for InotifyWatch:
+
+

Collaboration graph
+ + +
[legend]
+

List of all members. @@ -30,15 +44,15 @@ - + - - + + - - + + - + @@ -48,12 +62,32 @@ - + + + + - - + + + - + + + + + + + + + + + + + + + + + @@ -62,9 +96,7 @@ inotify watch class

It holds information about the inotify watch on a particular inode.

-If the INOTIFY_THREAD_SAFE is defined this class is thread-safe. -

-

Constructor & Destructor Documentation

+If the INOTIFY_THREAD_SAFE is defined this class is thread-safe.

Constructor & Destructor Documentation

@@ -90,7 +122,7 @@ If the INOTIFY_THREAD_SAFE is defined this class is thread-safe.
- +
 ~InotifyWatch ()
 Destructor.
int32_t GetDescriptor () const
int32_t GetDescriptor () const
 Returns the watch descriptor.
const std::string & GetPath () const
 Returns the watch descriptor.
const std::string & GetPath () const
 Returns the watched file path.
uint32_t GetMask () const
 Returns the watched file path.
uint32_t GetMask () const
 Returns the watch event mask.
 Returns the watch event mask.
void SetMask (uint32_t uMask) throw (InotifyException)
 Sets the watch event mask.
void SetEnabled (bool fEnabled) throw (InotifyException)
 Enables/disables the watch.
bool IsEnabled () const
bool IsEnabled () const
 Checks whether the watch is enabled.
bool IsRecursive () const
 Checks whether the watch is enabled.
bool IsRecursive () const
 Checks whether the watch is recursive.

Private Member Functions

IN_LOCK_DECL void __Disable ()
 Checks whether the watch is recursive.
 Disables the watch (due to removing by the kernel).

Private Attributes

std::string m_path
 watched file path
uint32_t m_uMask
 event mask
int32_t m_wd
 watch descriptor
Inotify * m_pInotify
 inotify object
bool m_fEnabled
 events enabled yes/no

Friends

class Inotify
) [inline] [inline]

@@ -119,7 +151,7 @@ Creates an inotify watch. Because this watch is inactive it has an invalid descr (  )  - [inline] + [inline] @@ -132,7 +164,37 @@ Destructor.

Member Function Documentation

- + +
+
+ + + + + + + + +
void InotifyWatch::__Disable (  )  [private]
+
+
+ +

+Disables the watch (due to removing by the kernel). +

+This method must be called after receiving an event. It ensures the watch object is consistent with the kernel data. +

+

+Here is the caller graph for this function:
+
+

+ + +
+ +
+

+

@@ -141,7 +203,7 @@ Destructor. - +
(  )  const [inline] const [inline]
@@ -152,31 +214,40 @@ Returns the watch descriptor.

Returns:
watch descriptor; -1 for inactive watch
+

+

+Here is the caller graph for this function:
+
+

+ + +
+

- +

- + - +
const std::string& InotifyWatch::GetPath Inotify* InotifyWatch::GetInotify (  )  const [inline] [inline]

-Returns the watched file path. +Returns the appropriate inotify class instance.

-

Returns:
file path
+
Returns:
inotify instance

- +

@@ -185,7 +256,7 @@ Returns the watched file path. - +
(  )  const [inline] const [inline]
@@ -196,60 +267,91 @@ Returns the watch event mask.

Returns:
event mask
+

+

+Here is the caller graph for this function:
+
+

+ + +
+

- +

- + - - + - +
void InotifyWatch::SetMask const std::string& InotifyWatch::GetPath (uint32_t  uMask  )  throw (InotifyException) const [inline]

-Sets the watch event mask. +Returns the watched file path.

-If the watch is active (added to an instance of Inotify) this method may fail due to unsuccessful re-setting the watch in the kernel.

-

Parameters:
- - -
[in] uMask event mask
-
-
Exceptions:
- - -
InotifyException thrown if changing fails
-
+
Returns:
file path
+ +

+

+Here is the caller graph for this function:
+
+

+ + +

- +

- + - +
Inotify* InotifyWatch::GetInotify bool InotifyWatch::IsEnabled (  )  [inline] const [inline]

-Returns the appropriate inotify class instance. +Checks whether the watch is enabled.

-

Returns:
inotify instance
+
Returns:
true = enables, false = disabled
+ +
+

+ +

+
+ + + + + + + + +
bool InotifyWatch::IsRecursive (  )  const [inline]
+
+
+ +

+Checks whether the watch is recursive. +

+A recursive watch monitors a directory itself and all its subdirectories. This watch is a logical object which may have many underlying kernel watches.

+

Returns:
currently always false (recursive watches not yet supported)
+
Attention:
Recursive watches are currently NOT supported. They are planned for future versions.

@@ -263,7 +365,7 @@ Returns the appropriate inotify class instance. bool  fEnabled  )  - throw (InotifyException) + throw (InotifyException) @@ -272,7 +374,7 @@ Returns the appropriate inotify class instance.

Enables/disables the watch.

-If the watch is active (added to an instance of Inotify) this method may fail due to unsuccessful re-setting the watch in the kernel.

+If the watch is active (added to an instance of Inotify) this method may fail due to unsuccessful re-setting the watch in the kernel.

Re-setting the current state has no effect.

Parameters:
@@ -281,78 +383,151 @@ Re-setting the current state has no effect.

Exceptions:
- +
InotifyException thrown if enabling/disabling fails
InotifyException thrown if enabling/disabling fails

- +

- + - + + - +
bool InotifyWatch::IsEnabled void InotifyWatch::SetMask ( uint32_t  uMask  )  const [inline] throw (InotifyException)

-Checks whether the watch is enabled. +Sets the watch event mask.

-

Returns:
true = enables, false = disabled
+If the watch is active (added to an instance of Inotify) this method may fail due to unsuccessful re-setting the watch in the kernel.

+

Parameters:
+ + +
[in] uMask event mask
+
+
Exceptions:
+ + +
InotifyException thrown if changing fails
+

- +

Friends And Related Function Documentation

+
- - - - - +
bool InotifyWatch::IsRecursive (  )  const [inline]friend class Inotify [friend]

-Checks whether the watch is recursive. + +

+

+

Member Data Documentation

+ +
+
+ + + + +
bool InotifyWatch::m_fEnabled [private]
+
+
+ +

+events enabled yes/no

-A recursive watch monitors a directory itself and all its subdirectories. This watch is a logical object which may have many underlying kernel watches.

-

Returns:
currently always false (recursive watches not yet supported)
-
Attention:
Recursive watches are currently NOT supported. They are planned for future versions.

-

Friends And Related Function Documentation

- +
- +
friend class Inotify [friend] std::string InotifyWatch::m_path [private]
+

+watched file path +

+ +

+

+ +

+
+ + + + +
Inotify* InotifyWatch::m_pInotify [private]
+
+
+ +

+inotify object +

+ +

+

+ +

+
+ + + + +
uint32_t InotifyWatch::m_uMask [private]
+
+
+ +

+event mask +

+ +

+

+ +

+
+ + + + +
int32_t InotifyWatch::m_wd [private]
+
+
+ +

+watch descriptor

The documentation for this class was generated from the following files: -
Generated on Wed Apr 18 18:26:40 2007 for inotify-cxx by  - -doxygen 1.5.1
+
  • inotify-cxx.h
  • inotify-cxx.cpp + +
    +doxygen
    -- cgit