Public Types | Public Member Functions | Static Public Attributes | List of all members
fileMonitor Class Reference

Checking for changes to files. More...

Collaboration diagram for fileMonitor:
Collaboration graph
[legend]

Public Types

enum  fileState { UNMODIFIED = 0, MODIFIED = 1, DELETED = 2 }
 Enumeration defining the file state. More...
 

Public Member Functions

 fileMonitor (const bool useInotify)
 Construct with specified inotify use. More...
 
 ~fileMonitor ()
 Destructor. More...
 
label addWatch (const fileName &)
 Add file to watch. Return watch descriptor. More...
 
bool removeWatch (const label watchFd)
 Remove file to watch. Return true if successful. More...
 
const fileName & getFile (const label watchFd) const
 Get name of file being watched. More...
 
fileState getState (const label watchFd) const
 Check state using handle. More...
 
void updateStates (const bool masterOnly, const bool syncPar) const
 Check state of all files. Updates state_. More...
 
void setUnmodified (const label watchFd)
 Reset state (e.g. after having read it) using handle. More...
 

Static Public Attributes

static const Enum< fileState > fileStateNames_
 
static int debug
 Named/registered debug switch: 'fileMonitor'. More...
 

Detailed Description

Checking for changes to files.

Note
The default is to use stat to get the timestamp.

Compile with FOAM_USE_INOTIFY to use the inotify (Linux specific, since 2.6.13) framework. The problem is that inotify does not work on nfs3 mounted directories!!

Source files

Definition at line 61 of file fileMonitor.H.

Member Enumeration Documentation

◆ fileState

enum fileState

Enumeration defining the file state.

Enumerator
UNMODIFIED 
MODIFIED 
DELETED 

Definition at line 70 of file fileMonitor.H.

Constructor & Destructor Documentation

◆ fileMonitor()

fileMonitor ( const bool  useInotify)
explicit

Construct with specified inotify use.

Definition at line 440 of file fileMonitor.C.

◆ ~fileMonitor()

~fileMonitor ( )

Destructor.

Definition at line 453 of file fileMonitor.C.

Member Function Documentation

◆ addWatch()

Foam::label addWatch ( const fileName &  fName)

Add file to watch. Return watch descriptor.

Definition at line 461 of file fileMonitor.C.

References Foam::ensightOutput::debug, Foam::endl(), Foam::Pout, and WarningInFunction.

Here is the call graph for this function:

◆ removeWatch()

bool removeWatch ( const label  watchFd)

Remove file to watch. Return true if successful.

Definition at line 499 of file fileMonitor.C.

References Foam::ensightOutput::debug, Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ getFile()

const Foam::fileName & getFile ( const label  watchFd) const

Get name of file being watched.

Definition at line 513 of file fileMonitor.C.

◆ getState()

Foam::fileMonitor::fileState getState ( const label  watchFd) const

Check state using handle.

Definition at line 519 of file fileMonitor.C.

◆ updateStates()

void updateStates ( const bool  masterOnly,
const bool  syncPar 
) const

Check state of all files. Updates state_.

Definition at line 527 of file fileMonitor.C.

References Pstream::broadcast(), Foam::ensightOutput::debug, Foam::endl(), forAll, Pstream::listCombineGather(), UPstream::master(), Foam::Pout, Foam::reduce(), and WarningInFunction.

Here is the call graph for this function:

◆ setUnmodified()

void setUnmodified ( const label  watchFd)

Reset state (e.g. after having read it) using handle.

Definition at line 623 of file fileMonitor.C.

References Foam::highResLastModified().

Here is the call graph for this function:

Member Data Documentation

◆ fileStateNames_

const Foam::Enum< Foam::fileMonitor::fileState > fileStateNames_
static

Definition at line 77 of file fileMonitor.H.

◆ debug

int debug
static

Named/registered debug switch: 'fileMonitor'.

Definition at line 137 of file fileMonitor.H.

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