En esta página

QSharedMemory Class

La clase QSharedMemory permite acceder a un segmento de memoria compartida. Más información...

Cabecera: #include <QSharedMemory>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core
Heredado de: QObject

Tipos públicos

enum AccessMode { ReadOnly, ReadWrite }
enum SharedMemoryError { NoError, PermissionDenied, InvalidSize, KeyError, AlreadyExists, …, UnknownError }

Funciones públicas

QSharedMemory(const QString &key, QObject *parent = nullptr)
QSharedMemory(QObject *parent = nullptr)
QSharedMemory(const QNativeIpcKey &key, QObject *parent = nullptr)
virtual ~QSharedMemory()
bool attach(QSharedMemory::AccessMode mode = ReadWrite)
const void *constData() const
bool create(qsizetype size, QSharedMemory::AccessMode mode = ReadWrite)
void *data()
const void *data() const
bool detach()
QSharedMemory::SharedMemoryError error() const
QString errorString() const
bool isAttached() const
QString key() const
bool lock()
(since 6.6) QNativeIpcKey nativeIpcKey() const
QString nativeKey() const
void setKey(const QString &key)
(since 6.6) void setNativeKey(const QNativeIpcKey &key)
void setNativeKey(const QString &key, QNativeIpcKey::Type type = QNativeIpcKey::legacyDefaultTypeForOs())
qsizetype size() const
bool unlock()

Descripción detallada

QSharedMemory permite el acceso a un segmento de memoria compartida por parte de múltiples subprocesos y procesos. Los segmentos de memoria compartida se identifican mediante una clave, representada por ` QNativeIpcKey`. Se puede crear una clave de forma multiplataforma utilizando `platformSafeKey()`.

Un objeto QSharedMemory debe llamar a create() para crear el segmento, y esta llamada especifica el tamaño del mismo. El resto de procesos simplemente llaman a attach() para acceder al segmento, que ya debe existir. Una vez que cualquiera de las dos operaciones se haya completado con éxito, la aplicación puede llamar a data() para obtener un puntero a los datos.

Para admitir operaciones no atómicas, QSharedMemory proporciona una API que permite obtener acceso exclusivo: puedes bloquear la memoria compartida con ` lock()` antes de leer o escribir en ella, pero recuerda liberar el bloqueo con ` unlock()` una vez que hayas terminado.

Por defecto, QSharedMemory destruye automáticamente el segmento de memoria compartida cuando la última instancia de QSharedMemory se « detached » del segmento y no quedan referencias al mismo.

Para obtener más detalles sobre los tipos de claves, las limitaciones específicas de cada plataforma y la interoperabilidad con aplicaciones más antiguas o ajenas a Qt, consulta la documentación sobre claves IPC nativas. Esta incluye información importante para aplicaciones en entornos aislados (sandbox) en plataformas de Apple, incluidas todas las aplicaciones obtenidas a través de la App Store de Apple.

Véase también «Comunicación entre procesos » y « QSystemSemaphore ».

Documentación sobre tipos de miembros

enum QSharedMemory::AccessMode

ConstanteValorDescripción
QSharedMemory::ReadOnly0El segmento de memoria compartida es de solo lectura. No se permite escribir en el segmento de memoria compartida. Si se intenta escribir en un segmento de memoria compartida creado con ReadOnly, el programa se interrumpe.
QSharedMemory::ReadWrite1Se permite tanto la lectura como la escritura en el segmento de memoria compartida.

enum QSharedMemory::SharedMemoryError

ConstanteValorDescripción
QSharedMemory::NoError0No se ha producido ningún error.
QSharedMemory::PermissionDenied1La operación ha fallado porque el usuario que la ha iniciado no disponía de los permisos necesarios.
QSharedMemory::InvalidSize2Una operación de creación ha fallado porque el tamaño solicitado no era válido.
QSharedMemory::KeyError3La operación ha fallado debido a una clave no válida.
QSharedMemory::AlreadyExists4La operación ` create()` ha fallado porque ya existía un segmento de memoria compartida con la clave especificada.
QSharedMemory::NotFound5La operación ` attach()` ha fallado porque no se ha podido encontrar un segmento de memoria compartida con la clave especificada.
QSharedMemory::LockError6El intento de crear un segmento de memoria compartida mediante ` lock()` falló porque ` create()` o ` attach()` fallaron y devolvieron «false», o porque se produjo un error del sistema en ` QSystemSemaphore::acquire()`.
QSharedMemory::OutOfResources7Una operación create() ha fallado porque no había memoria suficiente disponible para satisfacer la solicitud.
QSharedMemory::UnknownError8Se ha producido algún otro problema grave.

Documentación de la función miembro

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

Crea un objeto de memoria compartida con el ` parent ` indicado y con la clave «legacy» establecida en ` key`. Al tener la clave establecida, se pueden invocar sus funciones ` create()` y ` attach()`.

Véanse también setKey(), create() y attach().

QSharedMemory::QSharedMemory(QObject *parent = nullptr)

Crea un objeto de memoria compartida con el ` parent` proporcionado. El constructor no establece la clave del objeto de memoria compartida, por lo que este no tiene asociado ningún segmento de memoria compartida subyacente. La clave debe establecerse mediante ` setNativeKey()` antes de poder utilizar ` create()` o ` attach()`.

Esta función sobrecarga ` QSharedMemory::QSharedMemory()`.

Véase también setNativeKey().

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

Crea un objeto de memoria compartida con el ` parent ` indicado y con su clave establecida en ` key`. Dado que su clave está establecida, se pueden invocar sus funciones ` create()` y ` attach()`.

Esta es una función sobrecargada.

Véase también setNativeKey(), create() y attach().

[virtual noexcept] QSharedMemory::~QSharedMemory()

El destructor borra la clave, lo que obliga al objeto de memoria compartida a « detach » del segmento de memoria compartida subyacente. Si este objeto de memoria compartida es el último conectado al segmento de memoria compartida, la operación « detach()» destruye el segmento de memoria compartida.

Véanse también detach() y isAttached().

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

Intenta vincular el proceso al segmento de memoria compartida identificado por la clave que se pasó al constructor o a una llamada a ` setNativeKey()`. El acceso « mode » es « ReadWrite » por defecto. También puede ser « ReadOnly ». Devuelve « true » si la operación de vinculación se realiza correctamente. Si se devuelve «false», llame a error() para determinar qué error se ha producido. Tras adjuntar el segmento de memoria compartida, se puede obtener un puntero a la memoria compartida llamando a data().

Véase también ` isAttached()`, ` detach()` y ` create()`.

const void *QSharedMemory::constData() const

Devuelve un puntero const al contenido del segmento de memoria compartida, si hay alguno asociado. En caso contrario, devuelve null. El valor devuelto por esta función no cambiará hasta que se produzca un ` detach `, por lo que es seguro almacenar este puntero.

Si las operaciones de memoria no son atómicas, puedes bloquear la memoria compartida con ` lock()` antes de leer o escribir, pero recuerda liberar el bloqueo con ` unlock()` una vez que hayas terminado.

Véanse también attach() y create().

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

Crea un segmento de memoria compartida de size bytes con la clave pasada al constructor o establecida mediante setNativeKey(), a continuación se vincula al nuevo segmento de memoria compartida con el acceso mode especificado y devuelve true. Si ya existe un segmento de memoria compartida identificado por la clave, no se lleva a cabo la operación de vinculación y se devuelve false. Cuando el valor de retorno es false, llame a error() para determinar qué error se ha producido.

Véase también error().

void *QSharedMemory::data()

Devuelve un puntero al contenido del segmento de memoria compartida, si hay alguno asociado. De lo contrario, devuelve null. El valor devuelto por esta función no cambiará hasta que se produzca un ` detach `, por lo que es seguro almacenar este puntero.

Si las operaciones de memoria no son atómicas, puedes bloquear la memoria compartida con ` lock()` antes de leer o escribir, pero recuerda liberar el bloqueo con ` unlock()` cuando hayas terminado.

Véase también ` attach()`.

const void *QSharedMemory::data() const

Esta función sobrecarga la función « QSharedMemory::data()».

bool QSharedMemory::detach()

Desvincula el proceso del segmento de memoria compartida. Si este era el último proceso vinculado al segmento de memoria compartida, el sistema libera dicho segmento, es decir, se destruye su contenido. La función devuelve ` true ` si desvincula el segmento de memoria compartida. Si devuelve ` false`, suele significar que el segmento no está vinculado o que está bloqueado por otro proceso.

Véanse también attach() y isAttached().

QSharedMemory::SharedMemoryError QSharedMemory::error() const

Devuelve un valor que indica si se ha producido un error y, en caso afirmativo, de qué error se trata.

Véase también errorString().

QString QSharedMemory::errorString() const

Devuelve una descripción textual del último error que se ha producido. Si error() devuelve un objeto de tipo error value, llama a esta función para obtener una cadena de texto que describa el error.

Véase también ` error()`.

bool QSharedMemory::isAttached() const

Devuelve ` true ` si este proceso está vinculado al segmento de memoria compartida.

Véase también attach() y detach().

QString QSharedMemory::key() const

Devuelve la clave heredada asignada con ` setKey()` a esta memoria compartida, o una clave nula si no se ha asignado ninguna clave, o si el segmento utiliza ` nativeKey()`. La clave es el identificador que utilizan las aplicaciones Qt para identificar el segmento de memoria compartida.

Puedes averiguar la clave nativa, específica de la plataforma, que utiliza el sistema operativo llamando a nativeKey().

Véanse también setKey() y setNativeKey().

bool QSharedMemory::lock()

Se trata de un semáforo que bloquea el segmento de memoria compartida para que este proceso pueda acceder a él y devuelve « true ». Si otro proceso ha bloqueado el segmento, esta función se bloquea hasta que se libere el bloqueo. A continuación, adquiere el bloqueo y devuelve true. Si esta función devuelve false, significa que se ha ignorado una devolución falsa de create() o attach(), que se ha establecido la clave con setNativeKey() o que QSystemSemaphore::acquire() ha fallado debido a un error desconocido del sistema.

Véase también unlock(), data() y QSystemSemaphore::acquire().

[since 6.6] QNativeIpcKey QSharedMemory::nativeIpcKey() const

Devuelve el tipo de clave de este objeto de memoria compartida. El tipo de clave complementa la función ` nativeKey()` como identificador utilizado por el sistema operativo para identificar el segmento de memoria compartida.

Puedes utilizar la clave nativa para acceder a segmentos de memoria compartida que no hayan sido creados por Qt, o para conceder acceso a la memoria compartida a aplicaciones ajenas a Qt. Consulta Claves IPC nativas para obtener más información.

Esta función se introdujo en Qt 6.6.

Véanse también ` nativeKey()` y ` setNativeKey()`.

QString QSharedMemory::nativeKey() const

Devuelve la clave nativa, específica de la plataforma, de este objeto de memoria compartida. La clave nativa es el identificador que utiliza el sistema operativo para identificar el segmento de memoria compartida.

Puedes utilizar la clave nativa para acceder a segmentos de memoria compartida que no hayan sido creados por Qt, o para conceder acceso a la memoria compartida a aplicaciones ajenas a Qt. Consulta Claves IPC nativas para obtener más información.

Véase también setNativeKey() y nativeIpcKey().

void QSharedMemory::setKey(const QString &key)

Establece la clave heredada ` key ` para este objeto de memoria compartida. Si ` key ` coincide con la clave actual, la función devuelve un valor sin realizar ninguna acción. En caso contrario, si el objeto de memoria compartida está vinculado a un segmento de memoria compartida subyacente, se desvinculará ( detach ) de él antes de establecer la nueva clave. Esta función no realiza una llamada a ` attach()`.

Se puede llamar a key() para recuperar la clave heredada. Esta función es prácticamente idéntica a:

shm.setNativeKey(QSharedMemory::legacyNativeKey(key));

salvo que permite obtener la clave heredada mediante key().

Véase también key(), nativeKey() y isAttached().

[since 6.6] void QSharedMemory::setNativeKey(const QNativeIpcKey &key)

Establece la clave de memoria compartida nativa y específica de la plataforma ( key ) para este objeto de memoria compartida. Si ` key ` es igual a la clave nativa actual, la función devuelve un valor sin realizar ninguna acción. En caso contrario, si el objeto de memoria compartida está vinculado a un segmento de memoria compartida subyacente, se desvinculará ( detach ) de él antes de establecer la nueva clave. Esta función no realiza una llamada a ` attach()`.

Esta función resulta útil si la clave nativa se ha compartido desde otro proceso. Consulta «Claves IPC nativas » para obtener más información.

Las claves nativas portables se pueden obtener mediante platformSafeKey().

Se puede llamar a ` nativeKey()` para recuperar la clave nativa.

Esta función se introdujo en Qt 6.6.

Véase también nativeKey(), nativeIpcKey() y isAttached().

void QSharedMemory::setNativeKey(const QString &key, QNativeIpcKey::Type type = QNativeIpcKey::legacyDefaultTypeForOs())

Establece la clave nativa específica de la plataforma « key » para este objeto de memoria compartida de tipo « type » (el parámetro de tipo está disponible desde Qt 6.6). Si « key » es igual a la clave nativa actual, la función retorna sin realizar ninguna acción. De lo contrario, si el objeto de memoria compartida está vinculado a un segmento de memoria compartida subyacente, se « detach » de él antes de establecer la nueva clave. Esta función no realiza un « attach()».

Esta función resulta útil si la clave nativa se ha compartido desde otro proceso, aunque la aplicación debe asegurarse de que el tipo de clave coincida con lo que espera el otro proceso. Véase «Claves IPC nativas» para obtener más información.

Las claves nativas portables se pueden obtener mediante `platformSafeKey()`.

Se puede llamar a nativeKey() para recuperar la clave nativa.

Véanse también ` nativeKey()`, ` nativeIpcKey()` y ` isAttached()`.

qsizetype QSharedMemory::size() const

Devuelve el tamaño del segmento de memoria compartida asociado. Si no hay ningún segmento de memoria compartida asociado, se devuelve 0.

Nota: El tamaño del segmento puede ser mayor que el tamaño solicitado que se pasó a create().

Véanse también create() y attach().

bool QSharedMemory::unlock()

Libera el bloqueo del segmento de memoria compartida y devuelve ` true`, si este proceso tiene actualmente el bloqueo. Si el segmento no está bloqueado, o si el bloqueo lo tiene otro proceso, no ocurre nada y se devuelve `false`.

Véase también lock().

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.