Main Page | Class List | File List | Class Members | File Members

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.
InotifyGetInotify ()
 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.

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

Inotify* InotifyWatch::GetInotify  )  [inline]
 

Returns the appropriate inotify class instance.

Returns:
inotify instance

uint32_t InotifyWatch::GetMask  )  const [inline]
 

Returns the watch event mask.

Returns:
event mask

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

Returns the watched file path.

Returns:
file path

bool InotifyWatch::IsEnabled  )  const [inline]
 

Checks whether the watch is enabled.

Returns:
true = enables, false = disabled

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

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


Friends And Related Function Documentation

friend class Inotify [friend]
 


The documentation for this class was generated from the following files:
Generated on Mon Oct 30 21:54:32 2006 for incron by  doxygen 1.4.4