Класс QSharedMemory

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

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

Открытые типы

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

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

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

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

• Windows: QSharedMemory не «владеет» сегментом общей памяти. Когда все потоки или процессы, имеющие экземпляр QSharedMemory, прикреплённый к конкретному сегменту общей памяти, либо уничтожили свой экземпляр QSharedMemory, либо завершились, ядро Windows автоматически освобождает сегмент общей памяти.
• Unix: QSharedMemory «владеет» сегментом общей памяти. Когда последний поток или процесс, имеющий экземпляр QSharedMemory, прикреплённый к конкретному сегменту общей памяти, отсоединяется от сегмента, уничтожив свой экземпляр QSharedMemory, ядро Unix освобождает сегмент общей памяти. Но если этот последний поток или процесс аварийно завершается, не выполнив деструктор QSharedMemory, сегмент общей памяти сохраняется после аварии.
• HP-UX: разрешено только одно присоединение к сегменту общей памяти на процесс. Это означает, что QSharedMemory не следует использовать в нескольких потоках в одном процессе в HP-UX.

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

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

Предупреждение: QSharedMemory изменяет ключ специфичным для Qt способом, если не указано иное. Взаимодействие с приложениями, не являющимися Qt, достигается путём создания сначала стандартной общей памяти с QSharedMemory() и последующего установки нативного ключа с помощью setNativeKey(). При использовании нативных ключей общая память не защищена от нескольких обращений к ней (например, невозможно lock()), и для достижения такой защиты необходимо использовать пользовательский механизм.

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

Перечисление 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() уничтожает сегмент общей памяти.

См. также 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() для этой общей памяти, или пустой ключ, если ключ не был назначен или сегмент использует 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(), чтобы получить независимый от платформы ключ. Внутренне QSharedMemory преобразует этот ключ в специфичный для платформы ключ. Если вместо этого вы вызовете nativeKey(), вы получите специфичный для платформы, преобразованный ключ.

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

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

void QSharedMemory::setNativeKey(const QString &key)

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

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

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

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

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

qsizetype QSharedMemory::size() const

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

Примечание: Размер сегмента может быть больше, чем запрошенный размер, переданный в create().

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

bool QSharedMemory::unlock()

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

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