XrdCl::FileTimer Class Reference

Task generating timeout events for FileStateHandlers in recovery mode. More...

#include <XrdClFileTimer.hh>

Inheritance diagram for XrdCl::FileTimer:

Collaboration diagram for XrdCl::FileTimer:

Public Member Functions
	FileTimer ()
	Constructor.
virtual	~FileTimer ()
	Destructor.
void	Lock ()
	Lock the task.
void	RegisterFileObject (FileStateHandler *file)
	Register a file state handler.
virtual time_t	Run (time_t now)
	Perform the task's action.
void	UnLock ()
	Un-lock the task.
void	UnRegisterFileObject (FileStateHandler *file)
	Un-register a file state handler.
Public Member Functions inherited from XrdCl::Task
virtual	~Task ()
const std::string &	GetName () const
	Name of the task.
void	SetName (const std::string &name)
	Set name of the task.

Detailed Description

Task generating timeout events for FileStateHandlers in recovery mode.

Definition at line 32 of file XrdClFileTimer.hh.

Constructor & Destructor Documentation

FileTimer()

XrdCl::FileTimer::FileTimer ( )

inline

Constructor.

Definition at line 38 of file XrdClFileTimer.hh.

      {
        SetName( "FileTimer task" );
      }

References XrdCl::Task::SetName().

Here is the call graph for this function:

~FileTimer()

virtual XrdCl::FileTimer::~FileTimer ( )

inlinevirtual

Destructor.

Definition at line 46 of file XrdClFileTimer.hh.

      {
      }

Member Function Documentation

Lock()

void XrdCl::FileTimer::Lock ( )

inline

Lock the task.

Definition at line 71 of file XrdClFileTimer.hh.

      {
        pMutex.Lock();
      }

RegisterFileObject()

void XrdCl::FileTimer::RegisterFileObject ( FileStateHandler * file )

inline

Register a file state handler.

Definition at line 53 of file XrdClFileTimer.hh.

      {
        XrdSysMutexHelper scopedLock( pMutex );
        pFileObjects.insert( file );
      }

Referenced by XrdCl::FileStateHandler::FileStateHandler(), and XrdCl::FileStateHandler::FileStateHandler().

Here is the caller graph for this function:

Run()

time_t XrdCl::FileTimer::Run ( time_t now )

virtual

Perform the task's action.

Implements XrdCl::Task.

Definition at line 29 of file XrdClFileTimer.cc.

  {
    pMutex.Lock();
    std::set<FileStateHandler*>::iterator it;
    for( it = pFileObjects.begin(); it != pFileObjects.end(); ++it )
      (*it)->Tick(now);
    pMutex.UnLock();
    Env *env = DefaultEnv::GetEnv();
    int timeoutResolution = DefaultTimeoutResolution;
    env->GetInt( "TimeoutResolution", timeoutResolution );
    return now+timeoutResolution;
  }

References XrdCl::DefaultTimeoutResolution, XrdCl::DefaultEnv::GetEnv(), and XrdCl::Env::GetInt().

Here is the call graph for this function:

UnLock()

void XrdCl::FileTimer::UnLock ( )

inline

Un-lock the task.

Definition at line 79 of file XrdClFileTimer.hh.

      {
        pMutex.UnLock();
      }

UnRegisterFileObject()

void XrdCl::FileTimer::UnRegisterFileObject ( FileStateHandler * file )

inline

Un-register a file state handler.

Definition at line 62 of file XrdClFileTimer.hh.

      {
        XrdSysMutexHelper scopedLock( pMutex );
        pFileObjects.erase( file );
      }

Referenced by XrdCl::FileStateHandler::~FileStateHandler().

Here is the caller graph for this function:

---

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

• XrdClFileTimer.hh
• XrdClFileTimer.cc