1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QSHAREDMEMORY_H
43#define QSHAREDMEMORY_H
44
45#include <QtCore/qobject.h>
46
47QT_BEGIN_HEADER
48
49QT_BEGIN_NAMESPACE
50
51QT_MODULE(Core)
52
53#ifndef QT_NO_SHAREDMEMORY
54
55class QSharedMemoryPrivate;
56
57class Q_CORE_EXPORT QSharedMemory : public QObject
58{
59 Q_OBJECT
60 Q_DECLARE_PRIVATE(QSharedMemory)
61
62public:
63 enum AccessMode
64 {
65 ReadOnly,
66 ReadWrite
67 };
68
69 enum SharedMemoryError
70 {
71 NoError,
72 PermissionDenied,
73 InvalidSize,
74 KeyError,
75 AlreadyExists,
76 NotFound,
77 LockError,
78 OutOfResources,
79 UnknownError
80 };
81
82 QSharedMemory(QObject *parent = 0);
83 QSharedMemory(const QString &key, QObject *parent = 0);
84 ~QSharedMemory();
85
86 void setKey(const QString &key);
87 QString key() const;
88 void setNativeKey(const QString &key);
89 QString nativeKey() const;
90
91 bool create(int size, AccessMode mode = ReadWrite);
92 int size() const;
93
94 bool attach(AccessMode mode = ReadWrite);
95 bool isAttached() const;
96 bool detach();
97
98 void *data();
99 const void* constData() const;
100 const void *data() const;
101
102#ifndef QT_NO_SYSTEMSEMAPHORE
103 bool lock();
104 bool unlock();
105#endif
106
107 SharedMemoryError error() const;
108 QString errorString() const;
109
110private:
111 Q_DISABLE_COPY(QSharedMemory)
112};
113
114#endif // QT_NO_SHAREDMEMORY
115
116QT_END_NAMESPACE
117
118QT_END_HEADER
119
120#endif // QSHAREDMEMORY_H
121
122