1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
* This is a simple tdeioslave to handle mbox-files.
* Copyright (C) 2004 Mart Kelder (mart.kde@hccnet.nl)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef MBOXFILE_H
#define MBOXFILE_H
class MBoxProtocol;
class UrlInfo;
/**
* 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*.
*/
class MBoxFile
{
public:
/**
* Constructor
* @param info The urlinfo which must be used
* @param parent The MBoxProtocol parent instance, used to throw errors.
*/
MBoxFile( const UrlInfo* info, MBoxProtocol* parent );
/**
* Empty destructor
*/
~MBoxFile();
protected:
/**
* When implemented, this function handles the locking of the file.
* @return true if the locking was done succesfully.
*/
bool lock();
/**
* When implemented, this function unlocks the file.
*/
void unlock();
protected:
/**
* This can be used to get information about the file.
* The file specified here is the file that must be used.
*/
const UrlInfo* const m_info;
/**
* A instance of the parent protocol, meant to throw errors if neccesairy.
*/
MBoxProtocol* const m_mbox;
};
#endif
|
