kanzi::connect::FileTracker Class Reference

Allows to monitor changes in a file contents. More...

#include <file_tracker.hpp>

Public Types
typedef kanzi::function< void(kanzi::string_view filename)>	ModifiedFunction
	Type of callback function to notify for file modification. More...

Public Member Functions
	FileTracker (Domain &domain)
	Constructor. More...
void	start (kanzi::string_view filename, ModifiedFunction modified)
	Starts tracking of given file. More...
void	stop ()
	Stops tracking of file. More...
	~FileTracker ()
	Destructor. More...

Protected Member Functions
time_t	getFileModificationTime () const
	Retrieve modification time of the file that is being tracked. More...
void	onTimer (const kanzi::TimerMessageArguments &arguments)
	Timer callback function. More...

Detailed Description

Allows to monitor changes in a file contents.

Member Typedef Documentation

ModifiedFunction

typedef kanzi::function<void(kanzi::string_view filename)> kanzi::connect::FileTracker::ModifiedFunction

Type of callback function to notify for file modification.

Constructor & Destructor Documentation

FileTracker()

kanzi::connect::FileTracker::FileTracker

(

Domain &

domain

)

Constructor.

Parameters

domain

Kanzi UI domain. Used for subscribing timers. Mandatory.

~FileTracker()

kanzi::connect::FileTracker::~FileTracker

(

)

Destructor.

Member Function Documentation

getFileModificationTime()

time_t kanzi::connect::FileTracker::getFileModificationTime ( ) const

protected

Retrieve modification time of the file that is being tracked.

Returns

Time of previous modification.

onTimer()

void kanzi::connect::FileTracker::onTimer ( const kanzi::TimerMessageArguments &  arguments )

protected

Timer callback function.

Parameters

arguments

Arguments for the timer callback function.

start()

void kanzi::connect::FileTracker::start	(	kanzi::string_view	filename,
		ModifiedFunction	modified
	)

Starts tracking of given file.

Parameters

filename	File path to file that will be tracked.
modified	Function callback to invoke when a change occurs in file.

stop()

void kanzi::connect::FileTracker::stop

(

)

Stops tracking of file.

---

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

• connect/kanzi_adaptation/datasource/file_tracker.hpp