shmop_open

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

shmop_open — Crée ou ouvre un bloc de mémoire partagée

Description

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

shmop_open() peut créer ou ouvrir un bloc de mémoire partagée.

Liste de paramètres

key
Identifiant système pour le bloc de mémoire partagé. Ce paramètre peut être passé comme un décimal ou un hexadécimal.
mode

Il est possible d'utiliser :

  • "a" pour accès (utilise SHM_RDONLY pour shmat) utiliser cette option pour ouvrir un bloc déjà existant en lecture seule.
  • "c" pour création (utilise IPC_CREATE) utiliser cette option pour créer un nouveau bloc, ou, si un segment avec le même identifiant existe, essayer d'y accéder en lecture et écriture.
  • "w" pour accès en lecture et écriture. Utiliser cette option lorsque l'on doit accéder en lecture et écriture à un segment de mémoire partagée. C'est le cas le plus courant.
  • "n" crée un nouveau segment de mémoire partagée (utilise IPC_CREATE|IPC_EXCL). Utiliser cette option lorsque l'on veut créer un nouveau segment de mémoire partagée. Si un segment existe déjà avec la même clé, la fonction échouera. Ceci est très pratique pour des raisons de sécurité, pour éviter des trous de sécurité qui exploiteraient la course aux ressources.

permissions
Les permissions que l'on donne à ce bloc. Ce sont les mêmes que pour les fichiers. Ces permissions doivent être passées sous forme d'octal (c.-à-d. 0644).
size
La taille du bloc mémoire partagé que l'on veut créer, en octets

Note: Note : Les troisième et quatrième paramètres doivent être passés à 0 si l'on veut ouvrir un bloc de mémoire partagée déjà existant.

Valeurs de retour

En cas de succès, shmop_open() retourne une instance de Shmop que l'on peut utiliser pour accéder à la mémoire que l'on vient de créer. false sera retourné en cas d'échec.

Erreurs / Exceptions

Si mode est invalide, ou si size est inférieur ou égal à zéro, une ValueError est levée. Dans d'autres cas d'échec, un E_WARNING est émis.

Historique

Version Description
8.0.0 En cas de succès, cette fonction retourne désormais une instance de Shmop ; auparavant, une resource était retournée.
8.0.0 Si mode est invalide, ou si size est inférieur ou égal à zéro, une ValueError est levée ; auparavant, un E_WARNING était émis à la place, et la fonction retournait false.

Exemples

Exemple #1 Création d'un nouveau bloc de mémoire partagée Shmop

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

Cet exemple ouvre un nouveau bloc de mémoire partagée, dont l'identifiant est retourné par ftok().

Voir aussi