Qt 4.8
qsharedmemory_p.h
Go to the documentation of this file.
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_P_H
43 #define QSHAREDMEMORY_P_H
44 
45 //
46 // W A R N I N G
47 // -------------
48 //
49 // This file is not part of the Qt API. It exists purely as an
50 // implementation detail. This header file may change from version to
51 // version without notice, or even be removed.
52 //
53 // We mean it.
54 //
55 
56 #include "qsharedmemory.h"
57 
58 #ifdef QT_NO_SHAREDMEMORY
59 # ifndef QT_NO_SYSTEMSEMAPHORE
60 namespace QSharedMemoryPrivate
61 {
64  const QString &prefix = QLatin1String("qipc_sharedmemory_"));
65 }
66 #endif
67 #else
68 
69 #include "qsystemsemaphore.h"
70 #include "private/qobject_p.h"
71 
72 #ifdef Q_OS_WIN
73 # include <qt_windows.h>
74 #elif defined(Q_OS_SYMBIAN)
75 # include <e32std.h>
76 # include <sys/types.h>
77 #else
78 # include <sys/types.h>
79 #endif
80 
82 
83 #ifndef QT_NO_SYSTEMSEMAPHORE
84 
88 {
89 
90 public:
91  inline QSharedMemoryLocker(QSharedMemory *sharedMemory) : q_sm(sharedMemory)
92  {
93  Q_ASSERT(q_sm);
94  }
95 
97  {
98  if (q_sm)
99  q_sm->unlock();
100  }
101 
102  inline bool lock()
103  {
104  if (q_sm && q_sm->lock())
105  return true;
106  q_sm = 0;
107  return false;
108  }
109 
110 private:
112 };
113 #endif // QT_NO_SYSTEMSEMAPHORE
114 
116 {
118 
119 public:
121 
122  void *memory;
123  int size;
128 #ifndef QT_NO_SYSTEMSEMAPHORE
131 #endif
132 
133  static int createUnixKeyFile(const QString &fileName);
134  static QString makePlatformSafeKey(const QString &key,
135  const QString &prefix = QLatin1String("qipc_sharedmemory_"));
136 #ifdef Q_OS_WIN
137  HANDLE handle();
138 #elif defined(QT_POSIX_IPC)
139  int handle();
140 #else
141  key_t handle();
142 #endif
143  bool initKey();
144  void cleanHandle();
145  bool create(int size);
147  bool detach();
148 
149 #ifdef Q_OS_SYMBIAN
150  void setErrorString(const QString &function, TInt errorCode);
151 #else
152  void setErrorString(const QString &function);
153 #endif
154 
155 #ifndef QT_NO_SYSTEMSEMAPHORE
156  inline bool tryLocker(QSharedMemoryLocker *locker, const QString &function) {
157  if (!locker->lock()) {
158  errorString = QSharedMemory::tr("%1: unable to lock").arg(function);
159  error = QSharedMemory::LockError;
160  return false;
161  }
162  return true;
163  }
164 #endif // QT_NO_SYSTEMSEMAPHORE
165 
166 private:
167 #ifdef Q_OS_WIN
169 #elif defined(Q_OS_SYMBIAN)
170  RChunk chunk;
171 #elif defined(QT_POSIX_IPC)
172  int hand;
173 #else
174  key_t unix_key;
175 #endif
176 };
177 
179 
180 #endif // QT_NO_SHAREDMEMORY
181 
182 #endif // QSHAREDMEMORY_P_H
183 
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QSharedMemory::SharedMemoryError error
QSystemSemaphore systemSemaphore
void setErrorString(const QString &function)
The QSystemSemaphore class provides a general counting system semaphore.
static QString tr(const char *sourceText, const char *comment=0, int n=-1)
QLatin1String(DBUS_INTERFACE_DBUS))) Q_GLOBAL_STATIC_WITH_ARGS(QString
The QString class provides a Unicode character string.
Definition: qstring.h:83
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QSharedMemory * q_sm
HANDLE handle()
If not already made create the handle used for accessing the shared memory.
void * HANDLE
Definition: qnamespace.h:1671
bool attach(QSharedMemory::AccessMode mode)
static int createUnixKeyFile(const QString &fileName)
Creates the unix file if needed.
QString arg(qlonglong a, int fieldwidth=0, int base=10, const QChar &fillChar=QLatin1Char(' ')) const Q_REQUIRED_RESULT
Definition: qstring.cpp:7186
#define Q_DECLARE_PUBLIC(Class)
Definition: qglobal.h:2477
bool tryLocker(QSharedMemoryLocker *locker, const QString &function)
The QSharedMemory class provides access to a shared memory segment.
Definition: qsharedmemory.h:57
#define Q_AUTOTEST_EXPORT
Definition: qglobal.h:1510
QSharedMemoryLocker(QSharedMemory *sharedMemory)
static QString makePlatformSafeKey(const QString &key, const QString &prefix=QLatin1String("qipc_sharedmemory_"))
Generate a string from the key which can be any unicode string into the subset that the win/unix kern...
Helper class.
static QString fileName(const QString &fileUrl)