chiark / gitweb /
tree-wide: remove Lennart's copyright lines
[elogind.git] / src / systemd / sd-daemon.h
index 2d573fde982ed6e443355a5486e7c5227fa63ab4..232c4b876040e40af7989ce8ba4151f50836f0dc 100644 (file)
@@ -1,12 +1,8 @@
-/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
-
+/* SPDX-License-Identifier: LGPL-2.1+ */
 #ifndef foosddaemonhfoo
 #define foosddaemonhfoo
 
 /***
-  This file is part of systemd.
-
-  Copyright 2013 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   under the terms of the GNU Lesser General Public License as published by
@@ -22,8 +18,9 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 ***/
 
-#include <sys/types.h>
 #include <inttypes.h>
+#include <sys/types.h>
+#include <sys/socket.h>
 
 #include "_sd-common.h"
 
@@ -74,9 +71,9 @@ _SD_BEGIN_DECLARATIONS;
 
   See sd_listen_fds(3) for more information.
 */
-// UNNEEDED int sd_listen_fds(int unset_environment);
+int sd_listen_fds(int unset_environment);
 
-// UNNEEDED int sd_listen_fds_with_names(int unset_environment, char ***names);
+int sd_listen_fds_with_names(int unset_environment, char ***names);
 
 /*
   Helper call for identifying a passed file descriptor. Returns 1 if
@@ -88,7 +85,7 @@ _SD_BEGIN_DECLARATIONS;
 
   See sd_is_fifo(3) for more information.
 */
-// UNNEEDED int sd_is_fifo(int fd, const char *path);
+int sd_is_fifo(int fd, const char *path);
 
 /*
   Helper call for identifying a passed file descriptor. Returns 1 if
@@ -100,7 +97,7 @@ _SD_BEGIN_DECLARATIONS;
 
   See sd_is_special(3) for more information.
 */
-// UNNEEDED int sd_is_special(int fd, const char *path);
+int sd_is_special(int fd, const char *path);
 
 /*
   Helper call for identifying a passed file descriptor. Returns 1 if
@@ -130,7 +127,19 @@ int sd_is_socket(int fd, int family, int type, int listening);
 
   See sd_is_socket_inet(3) for more information.
 */
-// UNNEEDED int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port);
+int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port);
+
+/*
+  Helper call for identifying a passed file descriptor. Returns 1 if the
+  file descriptor is an Internet socket of the specified type
+  (SOCK_DGRAM, SOCK_STREAM, ...), and if the address of the socket is
+  the same as the address specified by addr. The listening flag is used
+  the same way as in sd_is_socket(). Returns a negative errno style
+  error code on failure.
+
+  See sd_is_socket_sockaddr(3) for more information.
+*/
+int sd_is_socket_sockaddr(int fd, int type, const struct sockaddr* addr, unsigned addr_len, int listening);
 
 /*
   Helper call for identifying a passed file descriptor. Returns 1 if
@@ -146,8 +155,9 @@ int sd_is_socket(int fd, int family, int type, int listening);
 
   See sd_is_socket_unix(3) for more information.
 */
-// UNNEEDED int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length);
+int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length);
 
+#if 0 /** UNNEEDED by elogind **/
 /*
   Helper call for identifying a passed file descriptor. Returns 1 if
   the file descriptor is a POSIX Message Queue of the specified name,
@@ -156,19 +166,30 @@ int sd_is_socket(int fd, int family, int type, int listening);
 
   See sd_is_mq(3) for more information.
 */
-// UNNEEDED int sd_is_mq(int fd, const char *path);
+int sd_is_mq(int fd, const char *path);
+#endif /** 0 **/
 
 /*
   Informs systemd about changed daemon state. This takes a number of
   newline separated environment-style variable assignments in a
   string. The following variables are known:
 
-     READY=1      Tells systemd that daemon startup is finished (only
-                  relevant for services of Type=notify). The passed
-                  argument is a boolean "1" or "0". Since there is
-                  little value in signaling non-readiness the only
+     MAINPID=...  The main PID of a daemon, in case elogind did not
+                  fork off the process itself. Example: "MAINPID=4711"
+
+     READY=1      Tells elogind that daemon startup or daemon reload
+                  is finished (only relevant for services of Type=notify).
+                  The passed argument is a boolean "1" or "0". Since there
+                  is little value in signaling non-readiness the only
                   value daemons should send is "READY=1".
 
+     RELOADING=1  Tell elogind that the daemon began reloading its
+                  configuration. When the configuration has been
+                  reloaded completely, READY=1 should be sent to inform
+                  elogind about this.
+
+     STOPPING=1   Tells elogind that the daemon is about to go down.
+
      STATUS=...   Passes a single-line status string back to systemd
                   that describes the daemon state. This is free-form
                   and can be used for various purposes: general state
@@ -183,21 +204,32 @@ int sd_is_socket(int fd, int family, int type, int listening);
      BUSERROR=... If a daemon fails, the D-Bus error-style error
                   code. Example: "BUSERROR=org.freedesktop.DBus.Error.TimedOut"
 
-     MAINPID=...  The main pid of a daemon, in case systemd did not
-                  fork off the process itself. Example: "MAINPID=4711"
-
      WATCHDOG=1   Tells systemd to update the watchdog timestamp.
                   Services using this feature should do this in
                   regular intervals. A watchdog framework can use the
                   timestamps to detect failed services. Also see
                   sd_watchdog_enabled() below.
 
+     WATCHDOG_USEC=...
+                  Reset watchdog_usec value during runtime.
+                  To reset watchdog_usec value, start the service again.
+                  Example: "WATCHDOG_USEC=20000000"
+
      FDSTORE=1    Store the file descriptors passed along with the
                   message in the per-service file descriptor store,
                   and pass them to the main process again on next
                   invocation. This variable is only supported with
                   sd_pid_notify_with_fds().
 
+     FDSTOREREMOVE=1
+                  Remove one or more file descriptors from the file
+                  descriptor store, identified by the name specified
+                  in FDNAME=, see below.
+
+     FDNAME=      A name to assign to new file descriptors stored in the
+                  file descriptor store, or the name of the file descriptors
+                  to remove in case of FDSTOREREMOVE=1.
+
   Daemons can choose to send additional variables. However, it is
   recommended to prefix variable names not listed above with X_.
 
@@ -236,19 +268,19 @@ int sd_notify(int unset_environment, const char *state);
 
   See sd_notifyf(3) for more information.
 */
-// UNNEEDED int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_(2,3);
+int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_(2,3);
 
 /*
   Similar to sd_notify(), but send the message on behalf of another
   process, if the appropriate permissions are available.
 */
-// UNNEEDED int sd_pid_notify(pid_t pid, int unset_environment, const char *state);
+int sd_pid_notify(pid_t pid, int unset_environment, const char *state);
 
 /*
   Similar to sd_notifyf(), but send the message on behalf of another
   process, if the appropriate permissions are available.
 */
-// UNNEEDED int sd_pid_notifyf(pid_t pid, int unset_environment, const char *format, ...) _sd_printf_(3,4);
+int sd_pid_notifyf(pid_t pid, int unset_environment, const char *format, ...) _sd_printf_(3,4);
 
 /*
   Similar to sd_pid_notify(), but also passes the specified fd array
@@ -268,7 +300,7 @@ int sd_pid_notify_with_fds(pid_t pid, int unset_environment, const char *state,
 
   See sd_booted(3) for more information.
 */
-// UNNEEDED int sd_booted(void);
+int sd_booted(void);
 
 /*
   Returns > 0 if the service manager expects watchdog keep-alive