XRootD
XrdOucChkPnt Class Referenceabstract

#include <XrdOucChkPnt.hh>

+ Inheritance diagram for XrdOucChkPnt:
+ Collaboration diagram for XrdOucChkPnt:

Public Member Functions

 XrdOucChkPnt ()
 Constructor and destructor. More...
 
virtual ~XrdOucChkPnt ()
 
virtual int Create ()=0
 
virtual int Delete ()=0
 
virtual void Finished ()=0
 
virtual int Query (struct iov &range)=0
 
virtual int Restore (bool *readok=0)=0
 
virtual int Truncate (struct iov *&range)=0
 
virtual int Write (struct iov *&range, int rnum)=0
 

Detailed Description

Definition at line 40 of file XrdOucChkPnt.hh.

Constructor & Destructor Documentation

◆ XrdOucChkPnt()

XrdOucChkPnt::XrdOucChkPnt ( )
inline

Constructor and destructor.

Definition at line 115 of file XrdOucChkPnt.hh.

115 {}

◆ ~XrdOucChkPnt()

virtual XrdOucChkPnt::~XrdOucChkPnt ( )
inlinevirtual

Definition at line 117 of file XrdOucChkPnt.hh.

117 {} // Use Finished() not delete!

Member Function Documentation

◆ Create()

virtual int XrdOucChkPnt::Create ( )
pure virtual

Create a checkpoint.

Returns
0 upon success and -errno upon failure.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint().

+ Here is the caller graph for this function:

◆ Delete()

virtual int XrdOucChkPnt::Delete ( )
pure virtual

Delete a checkpoint.

Returns
0 upon success and -errno upon failure.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint().

+ Here is the caller graph for this function:

◆ Finished()

virtual void XrdOucChkPnt::Finished ( )
pure virtual

Indicate that the checkpointing is finished. Any outstanding checkpoint should be delete and the object should delete itself if necessary.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint(), and XrdOfsFile::close().

+ Here is the caller graph for this function:

◆ Query()

virtual int XrdOucChkPnt::Query ( struct iov range)
pure virtual

Query checkpoint limits.

Parameters
range- reference to where limits are placed. range.length - holds maximum checkpoint length allowed.
Returns
0 upon success and -errno upon failure.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint().

+ Here is the caller graph for this function:

◆ Restore()

virtual int XrdOucChkPnt::Restore ( bool *  readok = 0)
pure virtual

Restore a checkpoint.

Parameters
readok- When not nil and an error occurs readok is set true if read access is still allowed; otherwise no access should be allowed.
Returns
0 upon success and -errno upon failure.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint(), and XrdOfsFile::close().

+ Here is the caller graph for this function:

◆ Truncate()

virtual int XrdOucChkPnt::Truncate ( struct iov *&  range)
pure virtual

Truncate a file to a specific size.

Parameters
range- reference to the file truncate size in offset.
Returns
0 upon success and -errno upon failure.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint().

+ Here is the caller graph for this function:

◆ Write()

virtual int XrdOucChkPnt::Write ( struct iov *&  range,
int  rnum 
)
pure virtual

Write data to a checkpointed file.

Parameters
range- reference to the file pieces to write.
rnum- number of elements in "range".
Returns
0 upon success and -errno upon failure.

Implemented in XrdOfsChkPnt.

Referenced by XrdOfsFile::checkpoint().

+ Here is the caller graph for this function:

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