Linux Manual Pages

Free Software * Books

Source Code

Free Media

Linux

SD_LISTEN_FDS

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
NOTES
ENVIRONMENT
SEE ALSO
AUTHOR

NAME

sd_listen_fds − Check for file descriptors passed by the init system.

SYNOPSIS

#include "sd−daemon.h"

#define SD_LISTEN_FDS_START 3

int sd_listen_fds(int unset_environment);

DESCRIPTION

sd_listen_fds() shall be called by a daemon to check for file descriptors passed by the init system as part of the socket−based activation logic.

If the unset_environment parameter is non−zero sd_listen_fds() will unset the $LISTEN_FDS/$LISTEN_PID environment variables before returning (regardless whether the function call itself succeeded or not). Further calls to sd_listen_fds() will then fail, but the variables are no longer inherited by child processes.

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 correct socket types before using them. To simplify this checking the functions sd_is_fifo(3), sd_is_socket(3), sd_is_socket_inet(3), sd_is_socket_unix(3) 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 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 datagram or stream socket matters a lot for the most common program logics and should be checked.

This function call will set the FD_CLOEXEC flag for all passed file descriptors to avoid further inheritance to children of the calling process.

RETURN VALUE

On failure, this call returns a negative errno−style error code. If $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 passed is returned. The application may find them starting with file descriptor SD_LISTEN_FDS_START, i.e. file descriptor 3.

NOTES

This function is provided by the reference implementation of APIs for new−style daemons and distributed with the systemd package. The algorithm it implements is simple, and can easily be reimplemented in daemons if it is important to support this interface without using the reference implementation.

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 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 number.

For details about the algorithm check the liberally licensed reference implementation sources: http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c resp. http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h

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 be compiled and linked to with the libsystemd−daemon pkg-config(1) file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For more details about the reference implementation see sd-daemon(7).

If the reference implementation is used as drop−in files and −DDISABLE_SYSTEMD is set during compilation this function will always return 0 and otherwise become a NOP.

ENVIRONMENT

$LISTEN_PID, $LISTEN_FDS

Set by the init system for supervised processes that use socket−based activation. This environment variable specifies the data sd_listen_fds() parses. See above for details.

AUTHOR

Lennart Poettering <lennart@poettering.net>

Developer

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.