Sane C++ Libraries
C++ Platform Abstraction Libraries
SC::FileSystemWatcher::FolderWatcher Struct Reference

Represents a single folder being watched. More...

#include <FileSystemWatcher.h>

Public Member Functions

Result stopWatching ()
 Stop watching this directory. More...
 

Public Attributes

Function< void(const Notification &)> notifyCallback
 Function that will be called on a notification. More...
 

Friends

struct FileSystemWatcher
 
struct IntrusiveDoubleLinkedList< FolderWatcher >
 

Detailed Description

Represents a single folder being watched.

While in use, the address of this object must not change, as it's inserted in a linked list.

Note
You can create an SC::ArenaMap to create a buffer of these objects, that can be easily reused.

Member Function Documentation

◆ stopWatching()

Result SC::FileSystemWatcher::FolderWatcher::stopWatching ( )

Stop watching this directory.

After calling it the FolderWatcher can be reused or released.

Returns
Valid result if directory was unwatched successfully.

Member Data Documentation

◆ notifyCallback

Function<void(const Notification&)> SC::FileSystemWatcher::FolderWatcher::notifyCallback

Function that will be called on a notification.


The documentation for this struct was generated from the following file: