kdecore Library API Documentation

klockfile.h

00001 /* 00002 This file is part of the KDE libraries 00003 Copyright (c) 2004 Waldo Bastian <bastian@kde.org> 00004 00005 This library is free software; you can redistribute it and/or 00006 modify it under the terms of the GNU Library General Public 00007 License version 2 as published by the Free Software Foundation. 00008 00009 This library is distributed in the hope that it will be useful, 00010 but WITHOUT ANY WARRANTY; without even the implied warranty of 00011 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00012 Library General Public License for more details. 00013 00014 You should have received a copy of the GNU Library General Public License 00015 along with this library; see the file COPYING.LIB. If not, write to 00016 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 00017 Boston, MA 02111-1307, USA. 00018 */ 00019 00020 #ifndef _KLOCKFILE_H_ 00021 #define _KLOCKFILE_H_ 00022 00023 #include <qstring.h> 00024 #include <qdatetime.h> 00025 00026 #include <ksharedptr.h> 00033 class KLockFile : public KShared 00034 { 00035 public: 00036 typedef KSharedPtr<KLockFile> Ptr; 00037 00038 KLockFile(const QString &file); 00039 00043 ~KLockFile(); 00044 00048 enum LockResult { 00052 LockOK = 0, 00053 00057 LockFail, 00058 00062 LockError, 00063 00067 LockStale 00068 }; 00069 00070 enum LockOptions { 00074 LockNoBlock = 1, 00075 00080 LockForce = 2 00081 }; 00082 00088 LockResult lock(int options=0); 00089 00093 bool isLocked() const; 00094 00098 void unlock(); 00099 00104 int staleTime() const; 00105 00109 void setStaleTime(int _staleTime); 00110 00116 bool getLockInfo(int &pid, QString &hostname, QString &appname); 00117 00118 private: 00119 class KLockFilePrivate; 00120 KLockFilePrivate *d; 00121 }; 00122 00123 #endif
KDE Logo
This file is part of the documentation for kdecore Library Version 3.3.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 17 11:26:08 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003