Base Framework
Public Member Functions | List of all members
FolderMonitor Class Reference

Folder monitor. More...

#include <base/filesystem/FolderMonitor.h>

Inherits Resource.

Public Member Functions

 FolderMonitor (const String &path)
 
bool isSignaled () const
 
void wait () const
 
bool wait (unsigned int milliseconds) const
 
 ~FolderMonitor () noexcept
 
- Public Member Functions inherited from Resource
String getDescription () const
 
void setDescription (const String &description)
 
unsigned int getResourceId () const
 
unsigned int getCreatedById () const
 
AnyReference getHandle () const noexcept
 
template<class TYPE >
TYPE & getInternalHandle () const
 
 operator bool () const noexcept
 

Additional Inherited Members

- Protected Attributes inherited from Resource
AnyReference handle
 

Detailed Description

Folder monitor.

Folder monitor.

Version
1.1

Constructor & Destructor Documentation

◆ FolderMonitor()

FolderMonitor::FolderMonitor ( const String path)

Initializes folder monitor.

Parameters
pathSpecifies the folder to monitor.

◆ ~FolderMonitor()

FolderMonitor::~FolderMonitor ( )
noexcept

Destroys the monitor.

Member Function Documentation

◆ isSignaled()

bool FolderMonitor::isSignaled ( ) const

Returns true if the an event has occured.

◆ wait() [1/2]

void FolderMonitor::wait ( ) const

Waits for an event.

◆ wait() [2/2]

bool FolderMonitor::wait ( unsigned int  milliseconds) const

Waits for an event.

Parameters
millisecondsThe timeout period.