1/****************************************************************************
2**
3** Copyright (C) 2013 David Faure <faure+bluesystems@kde.org>
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QLOCKFILE_H
41#define QLOCKFILE_H
42
43#include <QtCore/qstring.h>
44#include <QtCore/qscopedpointer.h>
45
46QT_BEGIN_NAMESPACE
47
48class QLockFilePrivate;
49
50class Q_CORE_EXPORT QLockFile
51{
52public:
53 QLockFile(const QString &fileName);
54 ~QLockFile();
55
56 QString fileName() const;
57
58 bool lock();
59 bool tryLock(int timeout = 0);
60 void unlock();
61
62 void setStaleLockTime(int);
63 int staleLockTime() const;
64
65 bool isLocked() const;
66 bool getLockInfo(qint64 *pid, QString *hostname, QString *appname) const;
67 bool removeStaleLockFile();
68
69 enum LockError {
70 NoError = 0,
71 LockFailedError = 1,
72 PermissionError = 2,
73 UnknownError = 3
74 };
75 LockError error() const;
76
77protected:
78 QScopedPointer<QLockFilePrivate> d_ptr;
79
80private:
81 Q_DECLARE_PRIVATE(QLockFile)
82 Q_DISABLE_COPY(QLockFile)
83};
84
85QT_END_NAMESPACE
86
87#endif // QLOCKFILE_H
88