mirror of
https://bitbucket.org/smil3y/kde-workspace.git
synced 2025-02-24 02:42:50 +00:00
116 lines
3.3 KiB
C++
116 lines
3.3 KiB
C++
/*
|
|
This file is part of the KDE
|
|
|
|
Copyright (C) 2009 Tobias Koenig (tokoe@kde.org)
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License
|
|
version 2 as published by the Free Software Foundation.
|
|
|
|
This software 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
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this library; see the file COPYING. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KINTERPROCESSLOCK_H
|
|
#define KINTERPROCESSLOCK_H
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
/**
|
|
* @short A class for serializing access to a resource that is shared between multiple processes.
|
|
*
|
|
* This class can be used to serialize access to a resource between
|
|
* multiple processes. Instead of using lock files, which could
|
|
* become stale easily, the registration of dummy dbus services is used
|
|
* to allow only one process at a time to access the resource.
|
|
*
|
|
* Example:
|
|
*
|
|
* @code
|
|
*
|
|
* KInterProcessLock *lock = new KInterProcessLock("myresource");
|
|
* connect(lock, SIGNAL(lockGranted(KInterProcessLock *)),
|
|
* this, SLOT(doCriticalTask(KInterProcessLock *)));
|
|
* lock->lock();
|
|
*
|
|
* ...
|
|
*
|
|
* ... ::doCriticalTask(KInterProcessLock *lock)
|
|
* {
|
|
* // change common resource
|
|
*
|
|
* lock->unlock();
|
|
* }
|
|
*
|
|
* @endcode
|
|
*
|
|
* @author Tobias Koenig <tokoe@kde.org>
|
|
*/
|
|
class KInterProcessLock : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
/**
|
|
* Creates a new inter process lock object.
|
|
*
|
|
* @param resource The identifier of the resource that shall be locked.
|
|
* This identifier can be any string, however it must be unique for
|
|
* the resource and every client that wants to access the resource must
|
|
* know it.
|
|
*/
|
|
KInterProcessLock(const QString &resource);
|
|
|
|
/**
|
|
* Destroys the inter process lock object.
|
|
*/
|
|
~KInterProcessLock();
|
|
|
|
/**
|
|
* Returns the identifier of the resource the lock is set on.
|
|
*/
|
|
QString resource() const;
|
|
|
|
/**
|
|
* Requests the lock.
|
|
*
|
|
* The lock is granted as soon as the lockGranted() signal is emitted.
|
|
*/
|
|
void lock();
|
|
|
|
/**
|
|
* Releases the lock.
|
|
*
|
|
* @note This method should be called as soon as the critical area is left
|
|
* in your code path and the lock is no longer needed.
|
|
*/
|
|
void unlock();
|
|
|
|
/**
|
|
* Waits for the granting of a lock by starting an internal event loop.
|
|
*/
|
|
void waitForLockGranted();
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* This signal is emitted when the requested lock has been granted.
|
|
*
|
|
* @param lock The lock that has been granted.
|
|
*/
|
|
void lockGranted(KInterProcessLock *lock);
|
|
|
|
private:
|
|
class Private;
|
|
Private* const d;
|
|
|
|
Q_PRIVATE_SLOT(d, void _k_serviceRegistered(const QString&))
|
|
};
|
|
|
|
#endif
|