X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_listen_fds.xml;h=6a9e082180670dd1a8f8209083b331606f6f9178;hp=f6a9497d56588744a0ef27a9d2d14b58308fbbea;hb=4cd1214db6cf4b262e8ce6381bc710091b375c96;hpb=34511ca7b166b0e89d08ff9870b0cf2624a7815f diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index f6a9497d5..6a9e08218 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -70,10 +70,10 @@ activation logic. If the unset_environment - parameter is non-zero + parameter is non-zero, sd_listen_fds() will unset the $LISTEN_FDS/$LISTEN_PID - environment variables before returning (regardless + environment variables before returning (regardless of whether the function call itself succeeded or not). Further calls to sd_listen_fds() will then fail, @@ -83,16 +83,16 @@ If a daemon receives more than one file descriptor, they will be passed in the same order as configured in the systemd socket definition - file. Nonetheless it is recommended to verify the + file. Nonetheless, it is recommended to verify the correct socket types before using them. To simplify - this checking the functions + this checking, the functions sd_is_fifo3, sd_is_socket3, sd_is_socket_inet3, sd_is_socket_unix3 - are provided. In order to maximize flexibility it is + are provided. In order to maximize flexibility, it is recommended to make these checks as loose as possible - without allowing incorrect setups. i.e. often the + without allowing incorrect setups. i.e. often, the actual port number a socket is bound to matters little for the service to work, hence it should not be verified. On the other hand, whether a socket is a @@ -112,7 +112,7 @@ $LISTEN_FDS/$LISTEN_PID was not set or was not correctly set for this daemon and hence no file descriptors were received, 0 is - returned. Otherwise the number of file descriptors + returned. Otherwise, the number of file descriptors passed is returned. The application may find them starting with file descriptor SD_LISTEN_FDS_START, i.e. file descriptor 3. @@ -132,43 +132,42 @@ Internally, this function checks whether the $LISTEN_PID environment variable equals the daemon PID. If not, it returns - immediately. Otherwise it parses the number passed in + immediately. Otherwise, it parses the number passed in the $LISTEN_FDS environment variable, then sets the FD_CLOEXEC flag for the parsed number of file descriptors starting from - SD_LISTEN_FDS_START. Finally it returns the parsed + SD_LISTEN_FDS_START. Finally, it returns the parsed number. For details about the algorithm check the liberally licensed reference implementation sources: - - resp. + and sd_listen_fds() is implemented in the reference implementation's sd-daemon.c and sd-daemon.h files. These - interfaces are available as shared library, which can + interfaces are available as a shared library, which can be compiled and linked to with the - libsystemd-daemon - pkg-config1 + 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 + implementation, see sd-daemon3. If the reference implementation is used as drop-in files and -DDISABLE_SYSTEMD is set during - compilation this function will always return 0 and + compilation, this function will always return 0 and otherwise become a NOP. Environment - + $LISTEN_PID $LISTEN_FDS