granicus.if.org Git - apache/blob - docs/manual/mod/mod_watchdog.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_watchdog.xml.meta">
  24 <name>mod_watchdog</name>
  25 <description>provides infrastructure for other modules to periodically run
  26     tasks</description>
  27 <status>Base</status>
  28 <sourcefile>mod_watchdog.c</sourcefile>
  29 <identifier>watchdog_module</identifier>
  30 <compatibility>Available in Apache 2.3 and later</compatibility>
  31
  32 <summary>
  33 <p><module>mod_watchdog</module> defines programmatic hooks for other modules to
  34 periodically run tasks.  These modules can register handlers for
  35 <module>mod_watchdog</module> hooks.  Currently, the following modules in the
  36 Apache distribution use this functionality:</p>
  37 <ul>
  38 <li><module>mod_heartbeat</module></li>
  39 <li><module>mod_heartmonitor</module></li>
  40 </ul>
  41 <note type="warning">
  42 To allow a module to use <module>mod_watchdog</module> functionality,
  43 <module>mod_watchdog</module> itself must be statically linked to the server
  44 core or, if a dynamic module, be loaded before the calling module.
  45 </note>
  46 </summary>
  47
  48 <directivesynopsis>
  49 <name>WatchdogInterval</name>
  50 <description>Watchdog interval in seconds</description>
  51 <syntax>WatchdogInterval <var>number-of-seconds</var></syntax>
  52 <default>WatchdogInterval 1</default>
  53 <contextlist><context>server config</context></contextlist>
  54
  55 <usage>
  56 <p>Sets the interval at which the watchdog_step hook runs.  Default is to run every
  57 second.</p>
  58 </usage>
  59 </directivesynopsis>
  60 </modulesynopsis>
  61