xrootd: XrdCl::FileTimer Class Reference

xrootd

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

#include <XrdClFileTimer.hh>

Inheritance diagram for XrdCl::FileTimer:

Inheritance graph

Collaboration diagram for XrdCl::FileTimer:

Collaboration graph

List of all members.

Public Member Functions
	FileTimer ()
	Constructor.
virtual	~FileTimer ()
	Destructor.
void	RegisterFileObject (FileStateHandler *file)
	Register a file state handler.
void	UnRegisterFileObject (FileStateHandler *file)
	Un-register a file state handler.
void	Lock ()
	Lock the task.
void	UnLock ()
	Un-lock the task.
virtual time_t	Run (time_t now)
	Perform the task's action.
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.

Private Attributes
std::set< FileStateHandler * >	pFileObjects
XrdSysMutex	pMutex

Detailed Description

Task generating timeout events for FileStateHandlers in recovery mode.

Constructor & Destructor Documentation

XrdCl::FileTimer::FileTimer ( )

inline

Constructor.

References XrdCl::Task::SetName().

virtual XrdCl::FileTimer::~FileTimer ( )

inlinevirtual

Destructor.

Member Function Documentation

void XrdCl::FileTimer::Lock ( )

inline

Lock the task.

References XrdSysMutex::Lock(), and pMutex.

Referenced by XrdCl::ForkHandler::Prepare().

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

inline

Register a file state handler.

References pFileObjects, and pMutex.

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

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

virtual

Perform the task's action.

Implements XrdCl::Task.

References XrdCl::DefaultTimeoutResolution, XrdCl::DefaultEnv::GetEnv(), XrdCl::Env::GetInt(), XrdSysMutex::Lock(), pFileObjects, pMutex, and XrdSysMutex::UnLock().

void XrdCl::FileTimer::UnLock ( )

inline

Un-lock the task.

References pMutex, and XrdSysMutex::UnLock().

Referenced by XrdCl::ForkHandler::Child(), and XrdCl::ForkHandler::Parent().

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

inline

Un-register a file state handler.

References pFileObjects, and pMutex.

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

Member Data Documentation

std::set<FileStateHandler*> XrdCl::FileTimer::pFileObjects

private

Referenced by RegisterFileObject(), Run(), and UnRegisterFileObject().

XrdSysMutex XrdCl::FileTimer::pMutex

private

Referenced by Lock(), RegisterFileObject(), Run(), UnLock(), and UnRegisterFileObject().

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