socket.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   2
   3 #ifndef foosockethfoo
   4 #define foosockethfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 typedef struct Socket Socket;
  26
  27 #include "manager.h"
  28 #include "unit.h"
  29 #include "socket-util.h"
  30
  31 typedef enum SocketState {
  32         SOCKET_DEAD,
  33         SOCKET_START_PRE,
  34         SOCKET_START_POST,
  35         SOCKET_LISTENING,
  36         SOCKET_RUNNING,
  37         SOCKET_STOP_PRE,
  38         SOCKET_STOP_PRE_SIGTERM,
  39         SOCKET_STOP_PRE_SIGKILL,
  40         SOCKET_STOP_POST,
  41         SOCKET_FINAL_SIGTERM,
  42         SOCKET_FINAL_SIGKILL,
  43         SOCKET_MAINTAINANCE,
  44         _SOCKET_STATE_MAX,
  45         _SOCKET_STATE_INVALID = -1
  46 } SocketState;
  47
  48 typedef enum SocketExecCommand {
  49         SOCKET_EXEC_START_PRE,
  50         SOCKET_EXEC_START_POST,
  51         SOCKET_EXEC_STOP_PRE,
  52         SOCKET_EXEC_STOP_POST,
  53         _SOCKET_EXEC_COMMAND_MAX,
  54         _SOCKET_EXEC_COMMAND_INVALID = -1
  55 } SocketExecCommand;
  56
  57 typedef enum SocketType {
  58         SOCKET_SOCKET,
  59         SOCKET_FIFO,
  60         _SOCKET_FIFO_MAX,
  61         _SOCKET_FIFO_INVALID = -1
  62 } SocketType;
  63
  64 typedef struct SocketPort SocketPort;
  65
  66 struct SocketPort {
  67         SocketType type;
  68         int fd;
  69
  70         SocketAddress address;
  71         char *path;
  72
  73         Watch fd_watch;
  74
  75         LIST_FIELDS(SocketPort, port);
  76 };
  77
  78 struct Socket {
  79         Meta meta;
  80
  81         LIST_HEAD(SocketPort, ports);
  82
  83         /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
  84         bool bind_ipv6_only;
  85         unsigned backlog;
  86
  87         usec_t timeout_usec;
  88
  89         ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
  90         ExecContext exec_context;
  91
  92         Service *service;
  93
  94         SocketState state, deserialized_state;
  95
  96         KillMode kill_mode;
  97
  98         ExecCommand* control_command;
  99         SocketExecCommand control_command_id;
 100         pid_t control_pid;
 101
 102         char *bind_to_device;
 103         mode_t directory_mode;
 104         mode_t socket_mode;
 105
 106         bool accept;
 107         unsigned n_accepted;
 108
 109         bool failure;
 110         Watch timer_watch;
 111 };
 112
 113 /* Called from the service code when collecting fds */
 114 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds);
 115
 116 /* Called from the service when it shut down */
 117 void socket_notify_service_dead(Socket *s);
 118
 119 extern const UnitVTable socket_vtable;
 120
 121 const char* socket_state_to_string(SocketState i);
 122 SocketState socket_state_from_string(const char *s);
 123
 124 const char* socket_exec_command_to_string(SocketExecCommand i);
 125 SocketExecCommand socket_exec_command_from_string(const char *s);
 126
 127 #endif