KLockFile Class Reference

#include <klockfile.h>

Inheritance diagram for KLockFile:

KShared List of all members.

Detailed Description

The KLockFile class provides NFS safe lockfiles.

Author:
Waldo Bastian <bastian@kde.org>
Since:
3.3

Definition at line 33 of file klockfile.h.


Public Types

typedef KSharedPtr< KLockFilePtr
 LockOK = 0
 LockFail
 LockError
 LockStale
 LockNoBlock = 1
 LockForce = 2
enum  LockResult { LockOK = 0, LockFail, LockError, LockStale }
enum  LockOptions { LockNoBlock = 1, LockForce = 2 }

Public Member Functions

 KLockFile (const QString &file)
 ~KLockFile ()
LockResult lock (int options=0)
bool isLocked () const
void unlock ()
int staleTime () const
void setStaleTime (int _staleTime)
bool getLockInfo (int &pid, QString &hostname, QString &appname)

Member Enumeration Documentation

Enumerator:
LockNoBlock  Return immediately, do not wait for the lock to become available.
LockForce  Automatically remove a lock when a lock is detected that is stale for more than staleTime() seconds.

Definition at line 70 of file klockfile.h.

Possible return values of the lock function.

Enumerator:
LockOK  Lock was acquired successfully.
LockFail  The lock could not be acquired because it is held by another process.
LockError  The lock could not be acquired due to an error.
LockStale  A stale lock has been detected.

Definition at line 48 of file klockfile.h.


Constructor & Destructor Documentation

KLockFile::~KLockFile (  ) 

Destroys the object, releasing the lock if held.

Definition at line 75 of file klockfile.cpp.


Member Function Documentation

bool KLockFile::getLockInfo ( int &  pid,
QString hostname,
QString appname 
)

Returns the pid, hostname and appname of the process holding the lock after the lock functon has returned with LockStale.

Returns:
false if the pid and hostname could not be determined

Definition at line 368 of file klockfile.cpp.

bool KLockFile::isLocked (  )  const

Returns whether the lock is held or not.

Definition at line 354 of file klockfile.cpp.

KLockFile::LockResult KLockFile::lock ( int  options = 0  ) 

Attempt to acquire the lock.

Parameters:
options A set of LockOptions OR'ed together.

Definition at line 240 of file klockfile.cpp.

void KLockFile::setStaleTime ( int  _staleTime  ) 

Set the time in seconds after which a lock is considered stale.

Definition at line 89 of file klockfile.cpp.

int KLockFile::staleTime (  )  const

Return the time in seconds after which a lock is considered stale The default is 30.

Definition at line 82 of file klockfile.cpp.

void KLockFile::unlock (  ) 

Release the lock.

Definition at line 359 of file klockfile.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys