X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_notify.xml;h=6bf823076332871f64bbf94c9b99b278f94a76cd;hp=dd0ba935d6c24f16fc110fc67a472ebd17d3f368;hb=05a2f6fefedd7254fd799502191d025d2908cf74;hpb=263653e10353d8ad155f1faba01981816a2bb712 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index dd0ba935d..6bf823076 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -8,20 +8,21 @@ Copyright 2010 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + under the terms of the GNU Lesser General Public License as published by + the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. systemd is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> - + sd_notify @@ -45,12 +46,12 @@ sd_notify sd_notifyf - Notify init system about start-up completion and other daemon status changes + Notify service manager about start-up completion and other daemon status changes - #include "sd-daemon.h" + #include <systemd/sd-daemon.h> int sd_notify @@ -77,9 +78,9 @@ notification. If the unset_environment - parameter is non-zero sd_notify() + parameter is non-zero, sd_notify() will unset the $NOTIFY_SOCKET - environment variable before returning (regardless + environment variable before returning (regardless of whether the function call itself succeeded or not). Further calls to sd_notify() will then fail, but @@ -87,7 +88,7 @@ processes. The state parameter - should contain an newline-separated list of variable + should contain a newline-separated list of variable assignments, similar in style to an environment block. A trailing newline is implied if none is specified. The string may contain any kind of variable @@ -104,7 +105,7 @@ definition file has Type=notify set. The passed argument is a boolean "1" or "0". Since there is little - value in signalling non-readiness, the + value in signaling non-readiness, the only value daemons should send is "READY=1". @@ -151,6 +152,29 @@ itself. Example: "MAINPID=4711" + + + WATCHDOG=1 + + Tells systemd to + update the watchdog timestamp. This is + the keep-alive ping that services need + to issue in regular intervals if + WatchdogSec= is + enabled for it. See + systemd.service5 + for details. It is recommended to send + this message if the + $WATCHDOG_PID + environment variable has been set to + the PID of the service process, in + every half the time interval that is + specified in the + $WATCHDOG_USEC + environment variable. See + sd_watchdog_enabled3 + for details. + It is recommended to prefix variable names that @@ -166,7 +190,7 @@ for details. sd_notifyf() is similar to - sd_notifyf() but takes a + sd_notify() but takes a printf()-like format string plus arguments. @@ -178,64 +202,33 @@ errno-style error code. If $NOTIFY_SOCKET was not set and hence no status data could be sent, 0 is returned. If - the status was sent these functions return with a + the status was sent, these functions return with a positive return value. In order to support both, init systems that implement this scheme and those which - don't, it is generally recommended to ignore the return + do not, it is generally recommended to ignore the return value of this call. Notes - These functions are provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithms - they implement are simple, and can easily be - reimplemented in daemons if it is important to support - this interface without using the reference - implementation. + Internally, these functions send a single datagram with the state string as payload to the - AF_UNIX socket referenced in the + AF_UNIX socket referenced in the $NOTIFY_SOCKET environment variable. If the first character of - $NOTIFY_SOCKET is @ the string is + $NOTIFY_SOCKET is @, the string is understood as Linux abstract namespace socket. The datagram is accompanied by the process credentials of the sending daemon, using SCM_CREDENTIALS. - - For details about the algorithms check the - liberally licensed reference implementation sources: - - resp. - - sd_notify() and - sd_notifyf() are implemented in - the reference implementation's - sd-daemon.c and - sd-daemon.h files. These - interfaces are available as shared library, which can - be compiled and linked to with the - libsystemd-daemon - pkg-config1 - file. Alternatively, applications consuming these APIs - may copy the implementation into their source tree. For - more details about the reference implementation see - sd_daemon7. - - If the reference implementation is used as - drop-in files and -DDISABLE_SYSTEMD is set during - compilation these functions will always return 0 and - otherwise become a NOP. Environment - + $NOTIFY_SOCKET @@ -291,9 +284,10 @@ See Also systemd1, - sd_daemon7, + sd-daemon3, daemon7, - systemd.service5 + systemd.service5, + sd_watchdog_enabled3