klockfile.h

Go to the documentation of this file.

/*
   This file is part of the KDE libraries
   Copyright (c) 2004 Waldo Bastian <bastian@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KLOCKFILE_H
#define KLOCKFILE_H

#include <kdecore_export.h>
#include <ksharedptr.h>
#include <kglobal.h>

class QString;

class KDECORE_EXPORT KLockFile : public KShared
{
public:
   typedef KSharedPtr<KLockFile> Ptr;

   explicit KLockFile(const QString &file, const KComponentData &componentName = KGlobal::mainComponent());

   ~KLockFile();

   enum LockResult {
     LockOK = 0,

     LockFail,

     LockError,

     LockStale
   };

   enum LockFlag {
     NoBlockFlag = 1,

     ForceFlag = 2
   };
   Q_DECLARE_FLAGS(LockFlags, LockFlag)

   
   LockResult lock(LockFlags flags=LockFlags());

   bool isLocked() const;

   void unlock();

   int staleTime() const;

   void setStaleTime(int _staleTime);

   bool getLockInfo(int &pid, QString &hostname, QString &appname);

private:
   class Private;
   Private *const d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KLockFile::LockFlags)

#endif