kabc Library API Documentation

lock.h

00001 /*
00002     This file is part of libkabc.
00003 
00004     Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
00005 
00006     This library is free software; you can redistribute it and/or
00007     modify it under the terms of the GNU Library General Public
00008     License as published by the Free Software Foundation; either
00009     version 2 of the License, or (at your option) any later version.
00010 
00011     This library is distributed in the hope that it will be useful,
00012     but WITHOUT ANY WARRANTY; without even the implied warranty of
00013     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014     Library General Public License for more details.
00015 
00016     You should have received a copy of the GNU Library General Public License
00017     along with this library; see the file COPYING.LIB.  If not, write to
00018     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00019     Boston, MA 02111-1307, USA.
00020 */
00021 #ifndef KABC_LOCK_H
00022 #define KABC_LOCK_H
00023 
00024 #include <qstring.h>
00025 #include <qobject.h>
00026 
00027 namespace KABC {
00028 
00033 class Lock : public QObject
00034 {
00035     Q_OBJECT
00036   public:
00043     Lock( const QString &identifier );
00044 
00048     ~Lock();
00049 
00053     virtual bool lock();
00054     
00058     virtual bool unlock();
00059 
00060     virtual QString error() const;
00061 
00062     QString lockFileName() const;
00063 
00064     static bool readLockFile( const QString &filename, int &pid, QString &app );
00065     static bool writeLockFile( const QString &filename );
00066 
00067     static QString locksDir();
00068 
00069   signals:
00070     void locked();
00071     void unlocked();
00072 
00073   private:
00074     QString mIdentifier;
00075     
00076     QString mLockUniqueName;
00077 
00078     QString mError;
00079 
00080     class Private;
00081     Private *d;
00082 };
00083 
00084 }
00085 
00086 #endif
KDE Logo
This file is part of the documentation for kabc Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Sep 23 17:13:01 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003