CeresEngine::FunctionalFileEventHandler Class Reference

A FileEventHandler that calls a function or a lambda. More...

#include <CeresEngine/Foundation/IO/FileWatcher.hpp>

Inheritance diagram for CeresEngine::FunctionalFileEventHandler:

Public Types
using	EventFunc = std::function< void(const FileHandle &, FileEvent)>
	Callback function type for file system events.

Public Member Functions
	FunctionalFileEventHandler ()
	FunctionalFileEventHandler (EventFunc &&funcFileEvent)
	Creates a new FunctionalFileEventHandler.
	~FunctionalFileEventHandler () final
Public Member Functions inherited from CeresEngine::FileEventHandler
	FileEventHandler ()=default
virtual	~FileEventHandler ()=default

Protected Member Functions
void	onFileEvent (const FileHandle &handle, FileEvent event) final
Protected Member Functions inherited from CeresEngine::FileEventHandler
virtual void	onFileCreated (const FileHandle &handle)
	Called when a file or directory has been created.
virtual void	onFileRemoved (const FileHandle &handle)
	Called when a file or directory has been removed.
virtual void	onFileModified (const FileHandle &handle)
	Called when a file or directory has been modified.
virtual void	onFileAttributesChanged (const FileHandle &handle)
	Called when file attributes have been modified.

Private Attributes
EventFunc	mFuncFileEvent
	A Callback function for file system events.

Detailed Description

A FileEventHandler that calls a function or a lambda.

Member Typedef Documentation

EventFunc

using CeresEngine::FunctionalFileEventHandler::EventFunc = std::function<void(const FileHandle&, FileEvent)>

Callback function type for file system events.

Constructor & Destructor Documentation

FunctionalFileEventHandler() [1/2]

CeresEngine::FunctionalFileEventHandler::FunctionalFileEventHandler

(

)

FunctionalFileEventHandler() [2/2]

CeresEngine::FunctionalFileEventHandler::FunctionalFileEventHandler ( EventFunc &&  funcFileEvent )

explicit

Creates a new FunctionalFileEventHandler.

Parameters

funcFileEvent

A function that will be called on each file system event.

~FunctionalFileEventHandler()

CeresEngine::FunctionalFileEventHandler::~FunctionalFileEventHandler ( )

final

Member Function Documentation

onFileEvent()

void CeresEngine::FunctionalFileEventHandler::onFileEvent ( const FileHandle &  handle, FileEvent  event  )

finalprotectedvirtual

Reimplemented from CeresEngine::FileEventHandler.

Member Data Documentation

mFuncFileEvent

EventFunc CeresEngine::FunctionalFileEventHandler::mFuncFileEvent

private

A Callback function for file system events.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/IO/FileWatcher.hpp