• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

kabc

KABC::Lock

KABC::Lock Class Reference

#include <lock.h>

Inheritance diagram for KABC::Lock:

Inheritance graph
[legend]

List of all members.


Detailed Description

This class provides locking functionality for a file, directory or an arbitrary string-represented resource.

Definition at line 34 of file lock.h.


Signals

void locked ()
void unlocked ()

Public Member Functions

virtual QString error () const
virtual bool lock ()
 Lock (const QString &identifier)
QString lockFileName () const
virtual bool unlock ()
 ~Lock ()

Static Public Member Functions

static QString locksDir ()
static bool readLockFile (const QString &filename, int &pid, QString &app)
static bool writeLockFile (const QString &filename)

Constructor & Destructor Documentation

Lock::Lock ( const QString &  identifier  ) 

Constructor.

Parameters:
identifier An identifier for the resource to be locked, e.g. a file name.

Definition at line 59 of file lock.cpp.

Lock::~Lock (  ) 

Destruct lock object.

This also removes the lock on the resource.

Definition at line 64 of file lock.cpp.


Member Function Documentation

QString Lock::error (  )  const [virtual]

Returns the lastest error message.

Reimplemented in KABC::LockNull.

Definition at line 177 of file lock.cpp.

bool Lock::lock (  )  [virtual]

Lock resource.

Reimplemented in KABC::LockNull.

Definition at line 107 of file lock.cpp.

void KABC::Lock::locked (  )  [signal]

Emitted after the lock has been locked.

QString Lock::lockFileName (  )  const

Returns the path of the lock file.

The file will be located in the directory returned by locksDir() and have the file extension .lock

Definition at line 102 of file lock.cpp.

QString Lock::locksDir (  )  [static]

Returns the path of the directory where locks are created.

Definition at line 71 of file lock.cpp.

bool Lock::readLockFile ( const QString &  filename,
int &  pid,
QString &  app 
) [static]

Reads the process ID and the application name from a lock file.

Parameters:
filename The lock file to read from. Full path or relative to current working directory
pid The variable the process ID will be read into
app The variable the application name will be read into
Returns:
false if filename could not be read, otherwise true, even when reading the values fails

Definition at line 76 of file lock.cpp.

bool Lock::unlock (  )  [virtual]

Unlock resource.

Reimplemented in KABC::LockNull.

Definition at line 156 of file lock.cpp.

void KABC::Lock::unlocked (  )  [signal]

Emitted after the lock has been unlocked.

bool Lock::writeLockFile ( const QString &  filename  )  [static]

Writes the process ID and the application name to a lock file.

Parameters:
filename The lock file to write to
Returns:
false if the file could not be opened for writing, otherwise true

Definition at line 89 of file lock.cpp.


The documentation for this class was generated from the following files:
  • lock.h
  • lock.cpp

kabc

Skip menu "kabc"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal