| <?xml version="1.0"?> |
| <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd"> |
| <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?> |
| <!-- English Revision : 1422580 --> |
| <!-- French translation : Lucien GENTIS --> |
| <!-- Reviewed by : Vincent Deffontaines --> |
| |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| |
| <modulesynopsis metafile="mod_slotmem_shm.xml.meta"> |
| |
| <name>mod_slotmem_shm</name> |
| <description>Fournisseur de mémoire partagée basée sur les |
| slots.</description> |
| <status>Extension</status> |
| <sourcefile>mod_slotmem_shm.c</sourcefile> |
| <identifier>slotmem_shm_module</identifier> |
| |
| <summary> |
| <p><code>mod_slotmem_shm</code> est un fournisseur de mémoire qui |
| permet la création et l'accès à un segment de mémoire partagée dans |
| lequel les ensembles de données sont organisés en "slots". |
| </p> |
| |
| <p>L'ensemble de la mémoire partagée est effacé à chaque |
| redémarrage, que ce dernier soit <code>graceful</code> ou non. Les données sont |
| stockées et restituées dans et à partir d'un fichier défini par le |
| paramètre <code>name</code> des appels <code>create</code> et |
| <code>attach</code>. Si son chemin absolu n'est pas spécifié, le |
| chemin du fichier sera relatif au chemin défini par la directive |
| <directive module="core">DefaultRuntimeDir</directive>. |
| </p> |
| |
| <p><code>mod_slotmem_shm</code> fournit les fonctions d'API suivantes |
| : |
| </p> |
| |
| <dl> |
| <dt>apr_status_t doall(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt> |
| <dd>appelle le callback pour tous les slots actifs</dd> |
| |
| <dt>apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool)</dt> |
| <dd>crée un nouveau slot de mémoire dont chaque taille d'objet est |
| item_size. <code>name</code> est utilisé pour générer le nom du fichier |
| permettant de stocker/restaurer le contenu de la mémoire partagée |
| si la configuration le spécifie. Les valeurs possibles sont : |
| <dl> |
| <dt><code>"none"</code></dt> |
| <dd><code>Mémoire partagée anonyme et pas de stockage |
| persistant</code></dd> |
| <dt><code>"file-name"</code></dt> |
| <dd><code>[DefaultRuntimeDir]/file-name</code></dd> |
| <dd><code>Absolute file name</code></dd> |
| <dd><code>$absolute-file-name</code></dd> |
| </dl> |
| </dd> |
| |
| <dt>apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool)</dt> |
| <dd>attache à un slot de mémoire existant. Voir |
| <code>create</code> pour la description du paramètre |
| <code>name</code>.</dd> |
| |
| <dt>apr_status_t dptr(ap_slotmem_instance_t *s, unsigned int item_id, void**mem)</dt> |
| <dd>obtient la mémoire associée à ce slot actif.</dd> |
| |
| <dt>apr_status_t get(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len)</dt> |
| <dd>lit la mémoire depuis ce slot et la transfère vers dest</dd> |
| |
| <dt>apr_status_t put(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len)</dt> |
| <dd>écrit dans ce slot la mémoire en provenance de src</dd> |
| |
| <dt>unsigned int num_slots(ap_slotmem_instance_t *s)</dt> |
| <dd>renvoie le nombre total de slots contenus dans ce segment</dd> |
| |
| <dt>apr_size_t slot_size(ap_slotmem_instance_t *s)</dt> |
| <dd>renvoie la taille totale des données, en octets, contenues |
| dans un slot de ce segment</dd> |
| |
| <dt>apr_status_t grab(ap_slotmem_instance_t *s, unsigned int *item_id);</dt> |
| <dd>alloue ou s'approprie le premier slot disponible et le marque comme utilisé (n'effectue aucune |
| copie de données)</dd> |
| |
| <dt>apr_status_t fgrab(ap_slotmem_instance_t *s, unsigned int item_id);</dt> |
| <dd>force l'allocation ou l'attribution du slot spécifié et le marque comme utilisé (n'effectue aucune |
| copie de données)</dd> |
| |
| <dt>apr_status_t release(ap_slotmem_instance_t *s, unsigned int item_id);</dt> |
| <dd>libère un slot et le marque comme non utilisé (n'effectue aucune |
| copie de données)</dd> |
| </dl> |
| |
| </summary> |
| |
| </modulesynopsis> |
