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

InotifyEvent Class Reference

inotify event class More...

#include <inotify-cxx.h>

List of all members.

Public Member Functions

 InotifyEvent ()
 Constructor.
 InotifyEvent (const struct inotify_event *pEvt)
 Constructor.
 ~InotifyEvent ()
 Destructor.
int32_t GetDescriptor () const
 Returns the event watch descriptor.
uint32_t GetMask () const
 Returns the event mask.
bool IsType (uint32_t uType) const
 Checks for the event type.
uint32_t GetCookie () const
 Returns the event cookie.
uint32_t GetLength () const
 Returns the event name length.
const std::string & GetName () const
 Returns the event name.
void GetName (std::string &rName) const
 Extracts the event name.
void GetData (struct inotify_event *pEvt)
 Returns the event raw data.
void GetData (struct inotify_event &rEvt)
 Returns the event raw data.
void DumpTypes (std::string &rStr) const
 Fills the string with all types contained in the event mask.


Detailed Description

inotify event class

It holds all information about inotify event and provides access to its particular values.


Constructor & Destructor Documentation

InotifyEvent::InotifyEvent  )  [inline]
 

Constructor.

Creates a plain event.

InotifyEvent::InotifyEvent const struct inotify_event *  pEvt  )  [inline]
 

Constructor.

Creates an event based on inotify event data. For NULL pointer it works the same way as InotifyEvent().

Parameters:
[in] pEvt event data

InotifyEvent::~InotifyEvent  )  [inline]
 

Destructor.


Member Function Documentation

void InotifyEvent::DumpTypes std::string &  rStr  )  const
 

Fills the string with all types contained in the event mask.

Parameters:
[out] rStr dumped event types

uint32_t InotifyEvent::GetCookie  )  const [inline]
 

Returns the event cookie.

Returns:
event cookie

void InotifyEvent::GetData struct inotify_event &  rEvt  )  [inline]
 

Returns the event raw data.

Parameters:
[in,out] rEvt event data

void InotifyEvent::GetData struct inotify_event *  pEvt  )  [inline]
 

Returns the event raw data.

For NULL pointer it does nothing.

Parameters:
[in,out] pEvt event data

int32_t InotifyEvent::GetDescriptor  )  const [inline]
 

Returns the event watch descriptor.

Returns:
watch descriptor
See also:
InotifyWatch::GetDescriptor()

uint32_t InotifyEvent::GetLength  )  const [inline]
 

Returns the event name length.

Returns:
event name length

uint32_t InotifyEvent::GetMask  )  const [inline]
 

Returns the event mask.

Returns:
event mask
See also:
InotifyWatch::GetMask()

void InotifyEvent::GetName std::string &  rName  )  const [inline]
 

Extracts the event name.

Parameters:
[out] rName event name

const std::string& InotifyEvent::GetName  )  const [inline]
 

Returns the event name.

Returns:
event name

bool InotifyEvent::IsType uint32_t  uType  )  const [inline]
 

Checks for the event type.

Parameters:
[in] uType type which is checked for
Returns:
true = event mask contains the given type, false = otherwise


The documentation for this class was generated from the following files:
Generated on Mon Sep 4 22:30:17 2006 for inotify-cxx by  doxygen 1.4.4