summaryrefslogtreecommitdiffstats
path: root/src/corelib/io/qlockfile.h
blob: 29611e679d58ed45da06d02da6ff803ebf8c66d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
// Copyright (C) 2013 David Faure <faure+bluesystems@kde.org>
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default

#ifndef QLOCKFILE_H
#define QLOCKFILE_H

#include <QtCore/qstring.h>
#include <QtCore/qscopedpointer.h>

#include <chrono>
#include <memory>

QT_BEGIN_NAMESPACE

class QLockFilePrivate;

class Q_CORE_EXPORT QLockFile
{
public:
    explicit QLockFile(const QString &fileName);
    ~QLockFile();

    QString fileName() const;

    bool lock();
    QT_CORE_INLINE_SINCE(6, 10)
    bool tryLock(int timeout);
    void unlock();

    QT_CORE_INLINE_SINCE(6, 10)
    void setStaleLockTime(int);
    QT_CORE_INLINE_SINCE(6, 10)
    int staleLockTime() const;

    bool tryLock(std::chrono::milliseconds timeout = std::chrono::milliseconds::zero());

    void setStaleLockTime(std::chrono::milliseconds value);
    std::chrono::milliseconds staleLockTimeAsDuration() const;

    bool isLocked() const;
    bool getLockInfo(qint64 *pid, QString *hostname, QString *appname) const;
    bool removeStaleLockFile();

    enum LockError {
        NoError = 0,
        LockFailedError = 1,
        PermissionError = 2,
        UnknownError = 3
    };
    LockError error() const;

private:
    std::unique_ptr<QLockFilePrivate> d_ptr;

    Q_DECLARE_PRIVATE(QLockFile)
    Q_DISABLE_COPY(QLockFile)
};

#if QT_CORE_INLINE_IMPL_SINCE(6, 10)
bool QLockFile::tryLock(int timeout)
{
    return tryLock(std::chrono::milliseconds{timeout});
}

void QLockFile::setStaleLockTime(int staleLockTime)
{
    setStaleLockTime(std::chrono::milliseconds{staleLockTime});
}

int QLockFile::staleLockTime() const
{
    return int(staleLockTimeAsDuration().count());
}
#endif // QT_CORE_INLINE_IMPL_SINCE(6, 10)

QT_END_NAMESPACE

#endif // QLOCKFILE_H