diff options
| author | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2012-08-07 13:24:34 +0100 |
|---|---|---|
| committer | Jannis Pohlmann <jannis.pohlmann@codethink.co.uk> | 2012-08-07 14:53:32 +0100 |
| commit | 9031d8581af77a649a91be6e1ddacdad9883c1ab (patch) | |
| tree | 4c66a27fd43c9b8648cd14724907105a788b8ee3 | |
| parent | 89d902aabd109633a3fed7abdbe1f2cfe19f6928 (diff) | |
| download | node-startup-controller-9031d8581af77a649a91be6e1ddacdad9883c1ab.tar.gz | |
Add documentation for the WatchdogClient class
| -rw-r--r-- | NEWS | 1 | ||||
| -rw-r--r-- | common/watchdog-client.c | 23 |
2 files changed, 24 insertions, 0 deletions
@@ -8,6 +8,7 @@ x.y.z * Add documentation for the JobManager class * Add documentation for the LAHandlerService class * Add documentation for the TargetStartupMonitor class +* Add documentation for the WatchdogClient class 0.9.1 ===== diff --git a/common/watchdog-client.c b/common/watchdog-client.c index a2c1090..4ccf15c 100644 --- a/common/watchdog-client.c +++ b/common/watchdog-client.c @@ -20,6 +20,21 @@ +/** + * SECTION: watchdog-client + * @title: Watchdog Client + * @short_description: Notifies the systemd watchdog over a set period. + * @stability: Internal + * + * The watchdog client notifies systemd's watchdog regularly over a period of seconds + * defined in watchdog_client_new(). If the appropriate service file has %WatchdogSec set + * then systemd will restart the service if it has not replied during that period (e.g. it + * has crashed or is stuck in an infinite loop). + * + */ + + + /* property identifiers */ enum { @@ -176,6 +191,14 @@ watchdog_client_timeout (gpointer user_data) +/** + * watchdog_client_new: + * @timeout: The amount of time to wait in between notifications to systemd's watchdog. + * + * Creates a new watchdog and starts notifying systemd's watchdog every @timeout seconds. + * + * Returns: A new instance of #WatchdogClient. + */ WatchdogClient * watchdog_client_new (guint timeout) { |