From fd0853d2623dd278b08288331ed42e3be59252fb Mon Sep 17 00:00:00 2001 From: Daniel Wilhelm Date: Fri, 18 Apr 2014 17:00:17 +0200 Subject: 2.2 --- shared/inotify/doc/html/classInotifyWatch.html | 358 +++++++++++++++++++++++++ 1 file changed, 358 insertions(+) create mode 100644 shared/inotify/doc/html/classInotifyWatch.html (limited to 'shared/inotify/doc/html/classInotifyWatch.html') diff --git a/shared/inotify/doc/html/classInotifyWatch.html b/shared/inotify/doc/html/classInotifyWatch.html new file mode 100644 index 00000000..119c7873 --- /dev/null +++ b/shared/inotify/doc/html/classInotifyWatch.html @@ -0,0 +1,358 @@ + + +inotify-cxx: InotifyWatch Class Reference + + + + +
+
+
+
+

InotifyWatch Class Reference

inotify watch class +More... +

+#include <inotify-cxx.h> +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 InotifyWatch (const std::string &rPath, int32_t uMask, bool fEnabled=true)
 Constructor.
 ~InotifyWatch ()
 Destructor.
int32_t GetDescriptor () const
 Returns the watch descriptor.
const std::string & GetPath () const
 Returns the watched file path.
uint32_t GetMask () const
 Returns the watch event mask.
void SetMask (uint32_t uMask) throw (InotifyException)
 Sets the watch event mask.
Inotify * GetInotify ()
 Returns the appropriate inotify class instance.
void SetEnabled (bool fEnabled) throw (InotifyException)
 Enables/disables the watch.
bool IsEnabled () const
 Checks whether the watch is enabled.
bool IsRecursive () const
 Checks whether the watch is recursive.

Friends

class Inotify
+

Detailed Description

+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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
InotifyWatch::InotifyWatch (const std::string &  rPath,
int32_t  uMask,
bool  fEnabled = true 
) [inline]
+
+
+ +

+Constructor. +

+Creates an inotify watch. Because this watch is inactive it has an invalid descriptor (-1).

+

Parameters:
+ + + + +
[in] rPath watched file path
[in] uMask mask for events
[in] fEnabled events enabled yes/no
+
+ +
+

+ +

+
+ + + + + + + + +
InotifyWatch::~InotifyWatch (  )  [inline]
+
+
+ +

+Destructor. +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
int32_t InotifyWatch::GetDescriptor (  )  const [inline]
+
+
+ +

+Returns the watch descriptor. +

+

Returns:
watch descriptor; -1 for inactive watch
+ +
+

+ +

+
+ + + + + + + + +
const std::string& InotifyWatch::GetPath (  )  const [inline]
+
+
+ +

+Returns the watched file path. +

+

Returns:
file path
+ +
+

+ +

+
+ + + + + + + + +
uint32_t InotifyWatch::GetMask (  )  const [inline]
+
+
+ +

+Returns the watch event mask. +

+

Returns:
event mask
+ +
+

+ +

+
+ + + + + + + + + +
void InotifyWatch::SetMask (uint32_t  uMask  )  throw (InotifyException)
+
+
+ +

+Sets the watch event mask. +

+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
+
+ +
+

+ +

+
+ + + + + + + + +
Inotify* InotifyWatch::GetInotify (  )  [inline]
+
+
+ +

+Returns the appropriate inotify class instance. +

+

Returns:
inotify instance
+ +
+

+ +

+
+ + + + + + + + + +
void InotifyWatch::SetEnabled (bool  fEnabled  )  throw (InotifyException)
+
+
+ +

+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.

+Re-setting the current state has no effect.

+

Parameters:
+ + +
[in] fEnabled set enabled yes/no
+
+
Exceptions:
+ + +
InotifyException thrown if enabling/disabling fails
+
+ +
+

+ +

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

+Checks whether the watch is enabled. +

+

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.
+ +
+

+

Friends And Related Function Documentation

+ +
+
+ + + + +
friend class Inotify [friend]
+
+
+ +

+ +

+

+

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
+ + -- cgit