X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_is_fifo.xml;h=4d9cd796000ae5778aa1c40f41aaaff73016df57;hp=f1f6d376eeb9fcabf9bf34773126df0ae9889948;hb=6b46ea73e3b1d8a1e65f58ac04772821bd4a72fb;hpb=160cd5c9aa2301892e13950015de7968c764340d;ds=sidebyside diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index f1f6d376e..4d9cd7960 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -8,16 +8,16 @@ 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 . --> @@ -47,12 +47,14 @@ sd_is_socket sd_is_socket_inet sd_is_socket_unix + sd_is_mq + sd_is_special Check the type of a file descriptor - #include "sd-daemon.h" + #include <systemd/sd-daemon.h> int sd_is_fifo @@ -86,6 +88,18 @@ size_t length + + int sd_is_mq + int fd + const char *path + + + + int sd_is_special + int fd + const char *path + + @@ -94,20 +108,23 @@ sd_is_fifo() may be called to check whether the specified file descriptor refers - to a FIFO or pipe. It the path - parameter is not NULL it is checked whether the FIFO - is bound to the specified file system path. + to a FIFO or pipe. If the path + parameter is not NULL, it is + checked whether the FIFO is bound to the specified + file system path. sd_is_socket() may be called to check whether the specified file descriptor - refers to a socket. It the + refers to a socket. If the family parameter is not - AF_UNSPEC it is checked whether the socket is of the - specified family (AF_UNIX, AF_INET, ...). If the - type parameter is not 0 it is + AF_UNSPEC, it is checked whether + the socket is of the specified family (AF_UNIX, + AF_INET, ...). If the + type parameter is not 0, it is checked whether the socket is of the specified type - (SOCK_STREAM, SOCK_DGRAM, ...). If the - listening parameter is positive + (SOCK_STREAM, + SOCK_DGRAM, ...). If the + listening parameter is positive, it is checked whether the socket is in accepting mode, i.e. listen() has been called for it. If listening is 0, it is @@ -122,20 +139,37 @@ optionally checks the IPv4 or IPv6 port number the socket is bound to, unless port is zero. For this call family - must be passed as either AF_UNSPEC, AF_INET or - AF_INET6. + must be passed as either AF_UNSPEC, AF_INET, or + AF_INET6. sd_is_socket_unix() is - similar to sd_is_socket(), but - optionally checks the AF_UNIX path the socket is bound + similar to sd_is_socket() but + optionally checks the AF_UNIX path the socket is bound to, unless the path parameter - is NULL. For normal file system AF_UNIX sockets set - the length parameter to 0. For - Linux abstract namespace sockets set the + is NULL. For normal file system AF_UNIX sockets, + set the length parameter to 0. For + Linux abstract namespace sockets, set the length to the size of the - address, including the initial 0 byte and set + address, including the initial 0 byte, and set the path to the initial 0 byte of the socket address. + + sd_is_mq() may be called to + check whether the specified file descriptor refers to + a POSIX message queue. If the + path parameter is not + NULL, it is checked whether the + message queue is bound to the specified name. + + sd_is_special() may be + called to check whether the specified file descriptor + refers to a special file. If the + path parameter is not + NULL, it is checked whether file + descriptor is bound to the specified file + name. Special files in this context are character + device nodes and files in /proc + or /sys. @@ -143,7 +177,7 @@ On failure, these calls return a negative errno-style error code. If the file descriptor is of - the specified type and bound to the specified address + the specified type and bound to the specified address, a positive return value is returned, otherwise zero. @@ -154,7 +188,7 @@ 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 + they implement are simple, and they can easily be reimplemented in daemons if it is important to support this interface without using the reference implementation. @@ -164,21 +198,24 @@ getsockname() to check the file descriptor type and where it is bound to. - For details about the algorithm check the + For details about the algorithms, check the liberally licensed reference implementation sources: - - resp. + + and sd_is_fifo() and the related functions are implemented in the reference - implementation's drop-in - sd-daemon.c and - sd-daemon.h files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - sd_daemon7 + 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-daemon3. These functions continue to work as described, even if -DDISABLE_SYSTEMD is set during @@ -189,11 +226,11 @@ See Also systemd1, - sd-daemon7, + sd-daemon3, sd_listen_fds3, systemd.service5, systemd.socket5 - +