klockfile.h

/*
   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 <tqstring.h>
#include <tqdatetime.h>
 
#include <ksharedptr.h>
class TDECORE_EXPORT TDELockFile : public TDEShared
{
public:
   typedef TDESharedPtr<TDELockFile> Ptr;
 
   TDELockFile(const TQString &file);

   ~TDELockFile();

   enum LockResult {
     LockOK = 0, 

     LockFail,
     
     LockError,

     LockStale
   };
 
   enum LockOptions {
     LockNoBlock = 1,
     
     LockForce = 2
   };

   LockResult lock(int options=0);
   
   bool isLocked() const;
   
   void unlock();

   int staleTime() const;
   
   void setStaleTime(int _staleTime);

   bool getLockInfo(int &pid, TQString &hostname, TQString &appname);
 
private:
   class TDELockFilePrivate;
   TDELockFilePrivate *d;
};
 
#endif