2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
4 <!-- English Revision: 1554199 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
9 Licensed to the Apache Software Foundation (ASF) under one or more
10 contributor license agreements. See the NOTICE file distributed with
11 this work for additional information regarding copyright ownership.
12 The ASF licenses this file to You under the Apache License, Version 2.0
13 (the "License"); you may not use this file except in compliance with
14 the License. You may obtain a copy of the License at
16 http://www.apache.org/licenses/LICENSE-2.0
18 Unless required by applicable law or agreed to in writing, software
19 distributed under the License is distributed on an "AS IS" BASIS,
20 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 See the License for the specific language governing permissions and
22 limitations under the License.
25 <modulesynopsis metafile="mod_cache_socache.xml.meta">
27 <name>mod_cache_socache</name>
28 <description>Module de stockage à base de cache d'objets partagés
29 (socache) pour le filtre de mise en cache HTTP.</description>
30 <status>Extension</status>
31 <sourcefile>mod_cache_socache.c</sourcefile>
32 <identifier>cache_socache_module</identifier>
35 <p>Le module <module>mod_cache_socache</module> implémente un
36 gestionnaire de stockage à base de cache d'objets partagés (socache)
37 pour le module <module>mod_cache</module>.</p>
39 <p>Les en-têtes et corps des réponses mises en cache sont rassemblés
40 et stockés sous une même clé dans le cache d'objets partagés. Il est
41 possible de choisir entre plusieurs <a
42 href="../socache.html">implémentations</a> de caches d'objets
45 <p>Des réponses avec différents contenus négociés peuvent être
46 stockées simultanément ; cependant, la mise en cache de contenus
47 partiels n'est pas encore supportée par ce module.</p>
49 <highlight language="config">
50 # Activation de la mise en cache
52 CacheSocacheMaxSize 102400
57 # Possibilité de se rabattre sur le cache disque
59 CacheSocacheMaxSize 102400
66 <note><title>Note :</title>
67 <p>Le module <module>mod_cache_socache</module> requiert les
68 services du module <module>mod_cache</module> qui doit donc avoir
69 été préalablement chargé.</p>
72 <seealso><module>mod_cache</module></seealso>
73 <seealso><module>mod_cache_disk</module></seealso>
74 <seealso><a href="../caching.html">Guide de la mise en cache</a></seealso>
77 <name>CacheSocache</name>
78 <description>Implémentation du cache d'objets partagés à utiliser</description>
79 <syntax>CacheSocache <var>type[:args]</var></syntax>
80 <contextlist><context>server config</context><context>virtual host</context>
82 <compatibility>Disponible à partir de la version 2.5 du serveur HTTP
83 Apache</compatibility>
86 <p>La directive <directive>CacheSocache</directive>
87 définit l'implémentation du cache d'objets partagés à utiliser,
88 suivie d'arguments optionnels. Il est
89 possible de choisir entre plusieurs <a
90 href="../socache.html">implémentations</a> de caches d'objets
93 <highlight language="config">
100 <name>CacheSocacheMaxTime</name>
101 <description>La durée maximale de stockage d'un document dans le cache
102 avant péremption</description>
103 <syntax>CacheSocacheMaxTime <var>secondes</var></syntax>
104 <default>CacheSocacheMaxTime 86400</default>
105 <contextlist><context>server config</context>
106 <context>virtual host</context>
107 <context>directory</context>
108 <context>.htaccess</context>
110 <compatibility>Disponible à partir de la version 2.5 du serveur HTTP
111 Apache</compatibility>
114 <p>La directive <directive>CacheSocacheMaxTime</directive>
115 définit la durée de stockage maximale en secondes d'un document dans
116 le cache avant péremption. Cette définition l'emporte sur la durée
117 de fraîcheur définie pour le document par le protocole HTTP.</p>
119 <highlight language="config">
120 CacheSocacheMaxTime 86400
126 <name>CacheSocacheMinTime</name>
127 <description>La durée minimale de stockage d'un document dans le cache</description>
128 <syntax>CacheSocacheMinTime <var>seconds</var></syntax>
129 <default>CacheSocacheMinTime 600</default>
130 <contextlist><context>server config</context>
131 <context>virtual host</context>
132 <context>directory</context>
133 <context>.htaccess</context>
135 <compatibility>Disponible à partir de la version 2.5 du serveur HTTP
136 Apache</compatibility>
139 <p>La directive <directive>CacheSocacheMinTime</directive>
140 définit le nombre de secondes au delà de la durée de fraîcheur de la
141 réponse pendant lesquelles cette dernière devra être stockée dans le
142 cache d'objets partagés. En effet, si une réponse n'est stockée que
143 pour une durée égale à sa durée de fraîcheur, elle n'a pas besoin
144 d'être rafraîchie.</p>
146 <highlight language="config">
147 CacheSocacheMinTime 600
153 <name>CacheSocacheMaxSize</name>
154 <description>La taille maximale d'une entrée pouvant être placée dans le
156 <syntax>CacheSocacheMaxSize <var>octets</var></syntax>
157 <default>CacheSocacheMaxSize 102400</default>
158 <contextlist><context>server config</context>
159 <context>virtual host</context>
160 <context>directory</context>
161 <context>.htaccess</context>
163 <compatibility>Disponible à partir de la version 2.5 du serveur HTTP
164 Apache</compatibility>
167 <p>La directive <directive>CacheSocacheMaxSize</directive>
168 définit la taille maximale, en octets, de la somme des en-têtes et
169 du corps d'un document pouvant être stocké dans le cache. Bien
170 entendu, plus la taille des en-têtes sera grande, plus la taille
171 maximale du corps du document s'en trouvera réduite.</p>
173 <p>Le module <module>mod_cache_socache</module> ne tentera de mettre
174 en cache que des réponses qui possèdent une taille de contenu
175 explicite, ou dont la taille est suffisamment petite pour qu'elles
176 soient écrites en une seule passe. Ceci permet au module
177 <module>mod_cache_disk</module> de mettre en cache des réponses dont
178 la taille est trop importante pour pouvoir être mises en cache par
179 <module>mod_cache_socache</module>.</p>
181 <highlight language="config">
182 CacheSocacheMaxSize 102400
188 <name>CacheSocacheReadSize</name>
189 <description>La quantité minimale de données du document à lire et
190 mettre en cache avant envoi au client</description>
191 <syntax>CacheSocacheReadSize <var>octets</var></syntax>
192 <default>CacheSocacheReadSize 0</default>
193 <contextlist><context>server config</context>
194 <context>virtual host</context>
195 <context>directory</context>
196 <context>.htaccess</context>
198 <compatibility>Disponible à partir de la version 2.5 du serveur HTTP
199 Apache</compatibility>
202 <p>La directive <directive>CacheSocacheReadSize</directive>
203 définit la quantité minimale de données, en octets, à lire depuis
204 l'arrière-plan avant envoi au client. Avec la valeur par défaut 0,
205 les données sont transmises au client dès leur arrivée et quelle que
206 soit leur taille. Si la valeur définie est non nulle, le cache
207 disque va mettre en tampon au moins la quantité de données
208 correspondante avant envoi au client. Ceci peut améliorer les
209 performances en cas de mise en cache de contenu en provenance d'un
210 mandataire inverse lent.</p>
212 <p>Cette directive n'a d'effet qu'au moment où les données sont
213 stockées dans le cache, et non lorsqu'elles sont servies depuis le
216 <highlight language="config">
223 <name>CacheSocacheReadTime</name>
224 <description>La durée minimale de lecture avant l'envoi des données</description>
225 <syntax>CacheSocacheReadTime <var>millisecondes</var></syntax>
226 <default>CacheSocacheReadTime 0</default>
227 <contextlist><context>server config</context>
228 <context>virtual host</context>
229 <context>directory</context>
230 <context>.htaccess</context>
232 <compatibility>Disponible à partir de la version 2.5 du serveur HTTP
233 Apache</compatibility>
236 <p>La directive <directive>CacheSocacheReadTime</directive>
237 définit le temps minimal qui doit s'écouler avant de tenter
238 l'envoi des données au client. Cette durée sera mise à profit pour
239 lire et mettre en tampon les données avant leur envoi au client.
240 Ceci peut améliorer les performances en cas de mise en cache de
241 contenu en provenance d'un mandataire inverse.</p>
243 <p>La valeur par défaut 0 désactive cette directive.</p>
245 <p>Cette directive n'a d'effet qu'au moment où les données sont
246 stockées dans le cache, et non lorsqu'elles sont servies depuis le
247 cache. Il est recommandé d'utiliser cette directive en concomitance
248 avec la directive <directive
249 module="mod_cache_socache">CacheSocacheReadSize</directive> afin de
250 s'assurer que le serveur ne mette pas les données en tampon de
251 manière excessive dans le cas où les données arriveraient plus vite
252 que prévu.</p>
254 <highlight language="config">
255 CacheSocacheReadTime 1000