Класс QSharedMemory

Класс QSharedMemory предоставляет доступ к сегменту общей памяти. Подробнее...

• Список всех членов, включая унаследованные

Типы

Открытые функции

Подробное описание

QSharedMemory предоставляет доступ к сегменту общей памяти для нескольких потоков и процессов. Также она предоставляет способ для одного потока или процесса заблокировать память для эксклюзивного доступа.

При использовании этого класса следует учитывать следующие платформенные различия:

• Windows: QSharedMemory не «владеет» сегментом общей памяти. Когда все потоки или процессы, имеющие экземпляр QSharedMemory, подключенный к конкретному сегменту общей памяти, либо уничтожили свой экземпляр QSharedMemory, либо завершили работу, ядро Windows автоматически освобождает сегмент общей памяти.
• Unix: QSharedMemory «владеет» сегментом общей памяти. Когда последний поток или процесс, имеющий экземпляр QSharedMemory, подключенный к конкретному сегменту общей памяти, отсоединяется от сегмента, уничтожив свой экземпляр QSharedMemory, ядро Unix освобождает сегмент общей памяти. Но если этот последний поток или процесс аварийно завершает работу без вызова деструктора QSharedMemory, сегмент общей памяти сохраняется после сбоя.
• HP-UX: Допускается только одно подключение к сегменту общей памяти на процесс. Это означает, что QSharedMemory не следует использовать в нескольких потоках в одном процессе на HP-UX.
• Платформы Apple: Приложения с ограниченным доступом (включая приложения, распространяемые через Apple App Store) требуют использования POSIX общей памяти (вместо общей памяти System V), что добавляет ряд ограничений, включая:
  • Ключ должен иметь вид <application group identifier>/<custom identifier>, как описано здесь и здесь.
  • Длина ключа ограничена 30 символами.
  • При завершении процесса именованные сегменты общей памяти не очищаются, поэтому повторный запуск приложения и повторное создание общей памяти с тем же именем приведет к ошибке. Чтобы обойти эту проблему, используйте подключение к существующему сегменту общей памяти:

    QSharedMemory shm("DEVTEAMID.app-group/shared");
    if (!shm.create(42) && shm.error() == QSharedMemory::AlreadyExists)
        shm.attach();

Не забудьте заблокировать общую память с помощью lock() перед чтением или записью в общую память и не забудьте освободить блокировку с помощью unlock() после завершения работы.

QSharedMemory автоматически уничтожает сегмент общей памяти, когда последний экземпляр QSharedMemory отсоединяется от сегмента и ссылки на сегмент больше не остаются.

Документация по типам членов

Перечисление QSharedMemory::AccessMode

Перечисление QSharedMemory::SharedMemoryError

Документация по функциям-членам

QSharedMemory::QSharedMemory(const QString &key, QObject *parent = nullptr)

Создаёт объект общей памяти с заданным parent и ключом, установленным в key. Поскольку ключ установлен, можно вызывать функции create() и attach().

См. также setKey(), create() и attach().

QSharedMemory::QSharedMemory(QObject *parent = nullptr)

Эта функция перегружает QSharedMemory().

Создаёт объект общей памяти с заданным parent. Ключ объекта общей памяти не устанавливается конструктором, поэтому к объекту общей памяти не прикреплён сегмент общей памяти. Ключ необходимо установить с помощью setKey() или setNativeKey() перед тем, как можно будет использовать create() или attach().

См. также setKey().

[virtual] QSharedMemory::~QSharedMemory()

Деструктор очищает ключ, что заставляет объект общей памяти отсоединиться от сегмента общей памяти. Если этот объект общей памяти является последним подключённым к сегменту общей памяти, операция отсоединения уничтожает сегмент общей памяти.

См. также detach() и isAttached().

bool QSharedMemory::attach(QSharedMemory::AccessMode mode = ReadWrite)

Попытка прикрепить процесс к сегменту общей памяти, идентифицируемому ключом, переданным в конструктор или вызову setKey() или setNativeKey(). Режим доступа mode по умолчанию равен ReadWrite. Также может быть ReadOnly. Возвращает true, если операция присоединения выполнена успешно. Если возвращается false, вызовите error(), чтобы определить возникшую ошибку. После присоединения сегмента общей памяти указатель на общую память можно получить, вызвав data().

См. также isAttached(), detach() и create().

const void *QSharedMemory::constData() const

Возвращает указатель const на содержимое сегмента общей памяти, если он присоединён. В противном случае возвращает null. Не забудьте заблокировать общую память с помощью lock() перед чтением или записью в общую память и не забудьте освободить блокировку с помощью unlock() после завершения работы.

См. также attach() и create().

bool QSharedMemory::create(qsizetype size, QSharedMemory::AccessMode mode = ReadWrite)

Создаёт сегмент общей памяти размером size байт с ключом, переданным в конструктор, установленным с помощью setKey() или setNativeKey(), затем присоединяется к новому сегменту общей памяти с заданным режимом доступа mode и возвращает true. Если сегмент общей памяти, идентифицируемый ключом, уже существует, операция присоединения не выполняется и возвращается false. Когда возвращается false, вызовите error(), чтобы определить возникшую ошибку.

См. также error().

void *QSharedMemory::data()

Возвращает указатель на содержимое сегмента общей памяти, если он присоединён. В противном случае возвращает null. Не забудьте заблокировать общую память с помощью lock() перед чтением или записью в общую память и не забудьте освободить блокировку с помощью unlock() после завершения работы.

См. также attach().

const void *QSharedMemory::data() const

Эта функция перегружает data().

bool QSharedMemory::detach()

Отсоединяет процесс от сегмента общей памяти. Если это был последний процесс, подключённый к сегменту общей памяти, то сегмент общей памяти высвобождается системой, т.е. содержимое уничтожается. Функция возвращает true, если она отсоединяет сегмент общей памяти. Если возвращается false, это обычно означает, что сегмент либо не подключён, либо заблокирован другим процессом.

См. также attach() и isAttached().

QSharedMemory::SharedMemoryError QSharedMemory::error() const

Возвращает значение, указывающее, произошла ли ошибка, и, если да, то какая.

См. также errorString().

QString QSharedMemory::errorString() const

Возвращает текстовое описание последней произошедшей ошибки. Если error() возвращает значение ошибки, вызовите эту функцию, чтобы получить текстовую строку, описывающую ошибку.

См. также error().

bool QSharedMemory::isAttached() const

Возвращает true, если этот процесс присоединён к сегменту общей памяти.

См. также attach() и detach().

QString QSharedMemory::key() const

Возвращает ключ, назначенный с помощью setKey() для этой общей памяти или null-ключ, если ключ не был назначен или сегмент использует nativeKey(). Ключ — это идентификатор, используемый приложениями Qt для идентификации сегмента общей памяти.

Вы можете получить системный, специфичный для платформы, ключ, вызвав nativeKey().

См. также setKey() и setNativeKey().

bool QSharedMemory::lock()

Это семафор, который блокирует сегмент общей памяти для доступа этим процессом и возвращает true. Если другой процесс заблокировал сегмент, эта функция блокируется до тех пор, пока блокировка не будет освобождена. Затем она приобретает блокировку и возвращает true. Если эта функция возвращает false, это означает, что вы проигнорировали ложное возвращение из create() или attach(), что вы установили ключ с помощью setNativeKey() или что QSystemSemaphore::acquire() завершилась неудачно из-за неизвестной системной ошибки.

См. также unlock(), data() и QSystemSemaphore::acquire().

QString QSharedMemory::nativeKey() const

Возвращает системный, специфичный для платформы, ключ для этого объекта общей памяти. Системный ключ — это идентификатор, используемый операционной системой для идентификации сегмента общей памяти.

Вы можете использовать системный ключ для доступа к сегментам общей памяти, которые не были созданы Qt, или для предоставления доступа к общей памяти приложениям, не использующим Qt.

См. также setKey() и setNativeKey().

void QSharedMemory::setKey(const QString &key)

Устанавливает независимый от платформы ключ для этого объекта общей памяти. Если key совпадает с текущим ключом, функция возвращается без каких-либо действий.

Вы можете вызвать key(), чтобы получить независимый от платформы ключ. Внутренне, QSharedMemory преобразует этот ключ в системный ключ.

Если объект общей памяти подключён к сегменту общей памяти, он отсоединится от него перед установкой нового ключа. Эта функция не выполняет attach().

См. также key(), nativeKey() и isAttached().

void QSharedMemory::setNativeKey(const QString &key)

Устанавливает системный, специфичный для платформы, ключ для этого объекта общей памяти. Если key совпадает с текущим системным ключом, функция возвращается без каких-либо действий. Если всё, что вам нужно, это назначить ключ сегменту, вы должны вызвать setKey() вместо этого.

Вы можете вызвать nativeKey(), чтобы получить системный ключ. Если системный ключ был назначен, вызов key() вернёт пустую строку.

Если объект общей памяти подключён к сегменту общей памяти, он отсоединится от него перед установкой нового ключа. Эта функция не выполняет attach().

Приложение не будет портативным, если вы установите системный ключ.

См. также nativeKey(), key() и isAttached().

qsizetype QSharedMemory::size() const

Возвращает размер подключенного сегмента общей памяти. Если сегмент общей памяти не подключен, возвращается 0.

См. также create() и attach().

bool QSharedMemory::unlock()

Освобождает блокировку сегмента общей памяти и возвращает true, если блокировка в данный момент удерживается этим процессом. Если сегмент не заблокирован или блокировка удерживается другим процессом, ничего не происходит и возвращается false.

См. также lock().