chiark / gitweb /
sd-daemon: add API to verify socket types
[elogind.git] / src / sd-daemon.h
index c7f5c1d..b7100bc 100644 (file)
@@ -27,6 +27,8 @@
   SOFTWARE.
 ***/
 
+#include <inttypes.h>
+
 /* Reference implementation of a few systemd related interfaces for
  * writing daemons. These interfaces are trivial to implement, however
  * to simplify porting we provide this reference
 
 /* Returns how many file descriptors have been passed, or a negative
  * errno code on failure. Optionally removes the $LISTEN_FDS and
- * $LISTEN_PID file descriptors from the environment (recommended). */
+ * $LISTEN_PID file descriptors from the environment
+ * (recommended). You'll find the file descriptors passed as fds
+ * SD_LISTEN_FDS_START to SD_LISTEN_FDS_START+r-1 if r is the return
+ * value of this functioin. Returns a negative errno style error code
+ * on failure. */
 int sd_listen_fds(int unset_environment);
 
+/* Helper call for identifying a passed file descriptor. Returns 1 if
+ * the file descriptor is a FIFO in the file system stored under the
+ * specified path, 0 otherwise. If path is NULL a path name check will
+ * 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. */
+int sd_is_fifo(int fd, const char *path);
+
+/* Helper call for identifying a passed file descriptor. Returns 1 if
+ * the file descriptor is a socket of the specified type (SOCK_DGRAM,
+ * SOCK_STREAM, ...), 0 otherwise. If type is 0 a socket type check
+ * will not be done and the call only verifies if the file descriptor
+ * refers to a socket. Returns a negative errno style error code on
+ * failure. */
+int sd_is_socket(int fd, int type, int listening);
+
+/* Helper call for identifying a passed file descriptor. Returns 1 if
+ * the file descriptor is an Internet socket (either AF_INET or
+ * AF_INET6) of the specified type (SOCK_DGRAM, SOCK_STREAM, ...), 0
+ * otherwise. If type is 0 a socket type check will not be done. If
+ * port is 0 a socket port check will not be done. Returns a negative
+ * errno style error code on failure. */
+int sd_is_socket_inet(int fd, int type, int listening, uint16_t port);
+
+/* Helper call for identifying a passed file descriptor. Returns 1 if
+ * the file descriptor is an AF_UNIX socket of the specified type
+ * (SOCK_DGRAM, SOCK_STREAM, ...) and path, 0 otherwise. If type is 0
+ * a socket type check will not be done. If path is NULL a socket path
+ * check will not be done. For normal AF_UNIX sockets set length to
+ * 0. For abstract namespace sockets set length to the length of the
+ * socket name (excluding the initial 0 byte). Returns a negative
+ * errno style error code on failure. */
+int sd_is_socket_unix(int fd, int type, int listening, const char *path, size_t length);
+
 #endif