shmop_open

    (PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

    shmop_open — Резервирование или использование блока разделяемой памяти

    Описание

    shmop_open(
        int$key,
        string$mode,
        int$permissions,
        int$size
    ): Shmop|false

    shmop_open() резервирует или использует существующий блок разделяемой памяти.

    Список параметров

    key

    Системный идентификатор блока разделяемой памяти. Может быть задан в десятичной или шестнадцатеричной кодировке.

    mode

    Доступные для использования флаги:

    • "a" для доступа (устанавливает флаг SHM_RDONLY) Следует применять этот флаг, когда необходимо использовать ранее зарезервированный участок разделяемой памяти, уже содержащий какие-либо данные. В этом случае доступ возможен только для операций чтения.
    • "c" для резервирования (устанавливает флаг IPC_CREATE) Следует применять этот флаг для создания нового зарезервированного участка разделяемой памяти. Если участок памяти с таким идентификатором уже существует, выполняется попытка доступа к нему для последующих операций чтения и записи.
    • "w" для выполнения операций чтения и записи Следует применять этот флаг для чтения и записи данных, хранимых в разделяемой памяти. Данный флаг используется в большинстве случаев.
    • "n" для создания в памяти нового сегмента (устанавливает флаг IPC_CREATE|IPC_EXCL) Следует применять этот флаг для создания нового сегмента в разделяемой памяти, но если сегмент уже существует с тем же флагом, происходит отказ. Это полезно в целях безопасности, т.к. позволяет избежать ошибок синхронизации (Race condition exploits).
    permissions

    Права доступа к участку памяти такие же, как к обычному файлу. Их можно указывать в восьмеричном виде, например 0644.

    size

    Размер резервируемого блока в разделяемой памяти в байтах

    Замечание:

    Обратите внимание: третий и четвёртый параметры должны быть указаны как 0, если необходимо получить доступ к существующему участку памяти.

    Возвращаемые значения

    В случае успешного выполнения shmop_open() возвращает экземпляр Shmop, который может быть в дальнейшем использован для доступа к зарезервированному участку памяти. В случае возникновения ошибки возвращает false.

    Ошибки

    Если параметр mode указан некорректно или параметр size меньше или равен нулю, выдаётся ошибка ValueError. В случае возникновения других ошибок выдаётся ошибка уровня E_WARNING.

    Список изменений

    ВерсияОписание
    8.0.0 В случае успешного выполнения возвращается экземпляр Shmop; ранее возвращался ресурс (resource).
    8.0.0 Если параметр mode указан некорректно или параметр size меньше или равен нулю, выдаётся ошибка ValueError. previously E_WARNING was emitted instead, ранее вместо этого выдавалась ошибка уровня E_WARNING и функция возвращала false.

    Примеры

    Пример #1 Резервирование участка разделяемой памяти

    <?php
    $shm_key     = ftok(__FILE__, 't');
    $shm_id = shmop_open($shm_key, "c", 0644, 100);
    ?>

    В приведённом примере выполняется доступ к блоку с идентификатором, возвращаемым функцией ftok().

    Смотрите также

    • shmop_close() - Закрытие блока разделяемой памяти
    • shmop_delete() - Удаление блока разделяемой памяти
    To Top