core: rename struct timestamp to dual_timestamp to avoid name clash with IP system...

[elogind.git] / src / sd-daemon.h

diff --git a/src/sd-daemon.h b/src/sd-daemon.h
index dc18f42eaa3ac9c0085f8021a1891e4d3f6f0154..fd6221f277ac4ae4bbebd8c0ac571de8854baf5d 100644 (file)
--- a/src/sd-daemon.h
+++ b/src/sd-daemon.h
@@ -49,7 +49,7 @@ extern "C" {
   - Detection of systemd boots
 
   You may compile this with -DDISABLE_SYSTEMD to disable systemd
   - Detection of systemd boots
 
   You may compile this with -DDISABLE_SYSTEMD to disable systemd

-  support. This make all those calls NOPs that are directly related to
+  support. This makes all those calls NOPs that are directly related to

   systemd (i.e. only sd_is_xxx() will stay useful).
 
   Since this is drop-in code we don't want any of our symbols to be
   systemd (i.e. only sd_is_xxx() will stay useful).
 
   Since this is drop-in code we don't want any of our symbols to be


@@ -63,6 +63,8 @@ extern "C" {
 
   This should compile on non-Linux systems, too, but with the
   exception of the sd_is_xxx() calls all functions will become NOPs.
 
   This should compile on non-Linux systems, too, but with the
   exception of the sd_is_xxx() calls all functions will become NOPs.

+
+  See sd-daemon(7) for more information.

 */
 
 #if __GNUC__ >= 4
 */
 
 #if __GNUC__ >= 4


@@ -76,7 +78,7 @@ extern "C" {
 /*
   Log levels for usage on stderr:
 
 /*
   Log levels for usage on stderr:
 

-          fprintf(stderr, SD_NOTICE "Hello World!");
+          fprintf(stderr, SD_NOTICE "Hello World!\n");

 
   This is similar to printk() usage in the kernel.
 */
 
   This is similar to printk() usage in the kernel.
 */


@@ -104,6 +106,8 @@ extern "C" {
   sure they are not passed on to child processes. If FD_CLOEXEC shall
   not be set, the caller needs to unset it after this call for all file
   descriptors that are used.
   sure they are not passed on to child processes. If FD_CLOEXEC shall
   not be set, the caller needs to unset it after this call for all file
   descriptors that are used.

+
+  See sd_listen_fds(3) for more information.

 */
 int sd_listen_fds(int unset_environment) _sd_hidden_;
 
 */
 int sd_listen_fds(int unset_environment) _sd_hidden_;
 


@@ -114,6 +118,8 @@ int sd_listen_fds(int unset_environment) _sd_hidden_;
   not be done and the call only verifies if the file descriptor
   refers to a FIFO. Returns a negative errno style error code on
   failure.
   not be done and the call only verifies if the file descriptor
   refers to a FIFO. Returns a negative errno style error code on
   failure.

+
+  See sd_is_fifo(3) for more information.

 */
 int sd_is_fifo(int fd, const char *path) _sd_hidden_;
 
 */
 int sd_is_fifo(int fd, const char *path) _sd_hidden_;
 


@@ -128,6 +134,8 @@ int sd_is_fifo(int fd, const char *path) _sd_hidden_;
   been called) If listening is == 0 it is verified that the socket is
   not in listening mode. If listening is < 0 no listening mode check
   is done. Returns a negative errno style error code on failure.
   been called) If listening is == 0 it is verified that the socket is
   not in listening mode. If listening is < 0 no listening mode check
   is done. Returns a negative errno style error code on failure.

+
+  See sd_is_socket(3) for more information.

 */
 int sd_is_socket(int fd, int family, int type, int listening) _sd_hidden_;
 
 */
 int sd_is_socket(int fd, int family, int type, int listening) _sd_hidden_;
 


@@ -140,6 +148,8 @@ int sd_is_socket(int fd, int family, int type, int listening) _sd_hidden_;
   done. If port is 0 a socket port check will not be done. The
   listening flag is used the same way as in sd_is_socket(). Returns a
   negative errno style error code on failure.
   done. If port is 0 a socket port check will not be done. 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_inet(3) for more information.

 */
 int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port) _sd_hidden_;
 
 */
 int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port) _sd_hidden_;
 


@@ -154,13 +164,15 @@ int sd_is_socket_inet(int fd, int family, int type, int listening, uint16_t port
   socket path in path (including the initial 0 byte). The listening
   flag is used the same way as in sd_is_socket(). Returns a negative
   errno style error code on failure.
   socket path in path (including the initial 0 byte). 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_unix(3) for more information.

 */
 int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length) _sd_hidden_;
 
 /*
 */
 int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length) _sd_hidden_;
 
 /*

-  Informs systemd about changed daemon state. This takes a numeber of
+  Informs systemd about changed daemon state. This takes a number of

   newline seperated environment-style variable assignments in a
   newline seperated environment-style variable assignments in a

-  string. The following strings are known:
+  string. The following variables are known:

 
      READY=1      Tells systemd that daemon startup is finished (only
                   relevant for services of Type=notify). The passed
 
      READY=1      Tells systemd that daemon startup is finished (only
                   relevant for services of Type=notify). The passed


@@ -185,7 +197,8 @@ int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t
      MAINPID=...  The main pid of a daemon, in case systemd did not
                   fork off the process itself. Example: "MAINPID=4711"
 
      MAINPID=...  The main pid of a daemon, in case systemd did not
                   fork off the process itself. Example: "MAINPID=4711"
 

-  Daemons can choose to send additional variables.
+  Daemons can choose to send additional variables. However, it is
+  recommened to prefix variable names not listed above with X_.

 
   Returns a negative errno-style error code on failure. Returns > 0
   if systemd could be notified, 0 if it couldn't possibly because
 
   Returns a negative errno-style error code on failure. Returns > 0
   if systemd could be notified, 0 if it couldn't possibly because


@@ -197,6 +210,8 @@ int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t
      sd_notify(0, "READY=1");
 
   See sd_notifyf() for more complete examples.
      sd_notify(0, "READY=1");
 
   See sd_notifyf() for more complete examples.

+
+  See sd_notify(3) for more information.

 */
 int sd_notify(int unset_environment, const char *state) _sd_hidden_;
 
 */
 int sd_notify(int unset_environment, const char *state) _sd_hidden_;
 


@@ -217,6 +232,8 @@ int sd_notify(int unset_environment, const char *state) _sd_hidden_;
                    "ERRNO=%i",
                    strerror(errno),
                    errno);
                    "ERRNO=%i",
                    strerror(errno),
                    errno);

+
+  See sd_notifyf(3) for more information.

 */
 int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_attr_(2,3) _sd_hidden_;
 
 */
 int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_attr_(2,3) _sd_hidden_;
 


@@ -228,6 +245,8 @@ int sd_notifyf(int unset_environment, const char *format, ...) _sd_printf_attr_(
   note that this function checks whether the system, not the user
   session is controlled by systemd. However the functions above work
   for both session and system services.
   note that this function checks whether the system, not the user
   session is controlled by systemd. However the functions above work
   for both session and system services.

+
+  See sd_booted(3) for more information.

 */
 int sd_booted(void) _sd_hidden_;
 
 */
 int sd_booted(void) _sd_hidden_;