kioslaves
MBoxFile Class Reference
This class can be used to lock files when implemented. More...
#include <mboxfile.h>
Inheritance diagram for MBoxFile:
Public Member Functions | |
| MBoxFile (const UrlInfo *info, MBoxProtocol *parent) | |
| ~MBoxFile () | |
Protected Member Functions | |
| bool | lock () |
| void | unlock () |
Protected Attributes | |
| const UrlInfo *const | m_info |
| MBoxProtocol *const | m_mbox |
Detailed Description
This class can be used to lock files when implemented.It is a base class for all classes that needs locking and/ir an UrlInfo*.
Definition at line 29 of file mboxfile.h.
Constructor & Destructor Documentation
| MBoxFile::MBoxFile | ( | const UrlInfo * | info, | |
| MBoxProtocol * | parent | |||
| ) |
Constructor.
- Parameters:
-
info The urlinfo which must be used parent The MBoxProtocol parent instance, used to throw errors.
Definition at line 23 of file mboxfile.cc.
| MBoxFile::~MBoxFile | ( | ) |
Member Function Documentation
| bool MBoxFile::lock | ( | ) | [protected] |
When implemented, this function handles the locking of the file.
- Returns:
- true if the locking was done succesfully.
Definition at line 34 of file mboxfile.cc.
| void MBoxFile::unlock | ( | ) | [protected] |
Member Data Documentation
const UrlInfo* const MBoxFile::m_info [protected] |
This can be used to get information about the file.
The file specified here is the file that must be used.
Definition at line 61 of file mboxfile.h.
MBoxProtocol* const MBoxFile::m_mbox [protected] |
A instance of the parent protocol, meant to throw errors if neccesairy.
Definition at line 66 of file mboxfile.h.
The documentation for this class was generated from the following files:
