tdeioslave/mbox

mboxfile.h
1/*
2 * This is a simple tdeioslave to handle mbox-files.
3 * Copyright (C) 2004 Mart Kelder (mart.kde@hccnet.nl)
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19#ifndef MBOXFILE_H
20#define MBOXFILE_H
21class MBoxProtocol;
22class UrlInfo;
23
30{
31public:
37 MBoxFile( const UrlInfo* info, MBoxProtocol* parent );
38
42 ~MBoxFile();
43
44protected:
49 bool lock();
50
54 void unlock();
55
56protected:
61 const UrlInfo* const m_info;
62
67};
68#endif
This class can be used to lock files when implemented.
Definition: mboxfile.h:30
void unlock()
When implemented, this function unlocks the file.
Definition: mboxfile.cpp:40
const UrlInfo *const m_info
This can be used to get information about the file.
Definition: mboxfile.h:61
bool lock()
When implemented, this function handles the locking of the file.
Definition: mboxfile.cpp:34
MBoxProtocol *const m_mbox
A instance of the parent protocol, meant to throw errors if neccesairy.
Definition: mboxfile.h:66
~MBoxFile()
Empty destructor.
Definition: mboxfile.cpp:30
MBoxFile(const UrlInfo *info, MBoxProtocol *parent)
Constructor.
Definition: mboxfile.cpp:23
This class is the main class and implements all function which can be called through the user.
Definition: mbox.h:32