Urho3D::FileWatcher Class Reference

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

#include <FileWatcher.h>

Inheritance diagram for Urho3D::FileWatcher:

Collaboration diagram for Urho3D::FileWatcher:

Public Member Functions
	FileWatcher (Context *context)
	Construct.
virtual	~FileWatcher ()
	Destruct.
virtual void	ThreadFunction ()
	Directory watching loop.
bool	StartWatching (const 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 String &fileName)
	Add a file change into the changes queue.
bool	GetNextChange (String &dest)
	Return a file change (true if was found, false if not.)
const 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.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual Urho3D::StringHash	GetType () const =0
	Return type hash.
virtual Urho3D::StringHash	GetBaseType () const =0
	Return base class type hash.
virtual const Urho3D::String &	GetTypeName () const =0
	Return type name.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *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 PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
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 String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
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.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.
Public Member Functions inherited from Urho3D::Thread
	Thread ()
	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.

Private Member Functions
	OBJECT (FileWatcher)

Private Attributes
SharedPtr< FileSystem >	fileSystem_
	Filesystem.
String	path_
	The path being watched.
HashMap< String, Timer >	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::Thread
static void	SetMainThread ()
	Set the current thread as the main thread.
static ThreadID	GetCurrentThreadID ()
	Return the current thread's ID.
static bool	IsMainThread ()
	Return whether is executing in the main thread.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.
Protected Attributes inherited from Urho3D::Thread
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:

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/IO/FileWatcher.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/IO/FileWatcher.cpp