Urho3D::FileWatcher Class Reference

Watches a directory and its subdirectories for files being modified. More...

#include <Urho3D/IO/FileWatcher.h>

Inheritance diagram for Urho3D::FileWatcher:

Classes
struct	TimedFileChange

Public Member Functions
	FileWatcher (Context *context)
	Construct.
	~FileWatcher () override
	Destruct.
void	ThreadFunction () override
	Directory watching loop.
bool	StartWatching (const ea::string &pathName, bool watchSubDirs)
	Start watching a directory. Return true if successful.
void	StopWatching ()
	Stop watching the directory.
void	SetDelay (float interval)
	Set the delay in seconds before file changes are notified. This (hopefully) avoids notifying when a file save is still in progress. Default 1 second.
void	AddChange (const FileChange &change)
	Add a file change into the changes queue.
bool	GetNextChange (FileChange &dest)
	Return a file change (true if was found, false if not).
const ea::string &	GetPath () const
	Return the path being watched, or empty if not watching.
float	GetDelay () const
	Return the delay in seconds for notifying file changes.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.
Public Member Functions inherited from Urho3D::Thread
	Thread (const ea::string &name=EMPTY_STRING)
	Construct. Does not start the thread yet.
virtual	~Thread ()
	Destruct. If running, stop and wait for thread to finish.
bool	Run ()
	Start running the thread. Return true if successful, or false if already running or if can not create the thread.
void	Stop ()
	Set the running flag to false and wait for the thread to finish.
void	SetPriority (int priority)
	Set thread priority. The thread must have been started first.
bool	IsStarted () const
	Return whether thread exists.
void	SetName (const ea::string &name)
	Set name of the platform thread on supported platforms. Must be called before Run().

Private Member Functions
	URHO3D_OBJECT (FileWatcher, Object)

Private Attributes
SharedPtr< FileSystem >	fileSystem_
	Filesystem.
ea::string	path_
	The path being watched.
ea::unordered_map< ea::string, TimedFileChange >	changes_
	Pending changes. These will be returned and removed from the list when their timer has exceeded the delay.
Mutex	changesMutex_
	Mutex for the change buffer.
float	delay_
	Delay in seconds for notifying changes.
bool	watchSubDirs_
	Watch subdirectories flag.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Member Functions inherited from Urho3D::Thread
static void	SetMainThread ()
	Set the current thread as the main thread.
static ThreadID	GetCurrentThreadID ()
static bool	IsMainThread ()
	Return whether is executing in the main thread.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Static Protected Member Functions inherited from Urho3D::Thread
static void *	ThreadFunctionStatic (void *data)
	Helper that executes Thread::ThreadFunction().
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.
Protected Attributes inherited from Urho3D::Thread
ea::string	name_ {}
	Name of the thread. It will be propagated to underlying OS thread if possible.
void *	handle_
	Thread handle.
volatile bool	shouldRun_
	Running flag.
Static Protected Attributes inherited from Urho3D::Thread
static ThreadID	mainThreadID
	Main thread's thread ID.

Detailed Description

Watches a directory and its subdirectories for files being modified.

---

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

• Urho3D/IO/FileWatcher.h
• Urho3D/IO/FileWatcher.cpp