chiark / gitweb /
systemctl: add verbs for special units
[elogind.git] / src / 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 #include "mount.h"
31
32 typedef enum SocketState {
33         SOCKET_DEAD,
34         SOCKET_START_PRE,
35         SOCKET_START_POST,
36         SOCKET_LISTENING,
37         SOCKET_RUNNING,
38         SOCKET_STOP_PRE,
39         SOCKET_STOP_PRE_SIGTERM,
40         SOCKET_STOP_PRE_SIGKILL,
41         SOCKET_STOP_POST,
42         SOCKET_FINAL_SIGTERM,
43         SOCKET_FINAL_SIGKILL,
44         SOCKET_MAINTENANCE,
45         _SOCKET_STATE_MAX,
46         _SOCKET_STATE_INVALID = -1
47 } SocketState;
48
49 typedef enum SocketExecCommand {
50         SOCKET_EXEC_START_PRE,
51         SOCKET_EXEC_START_POST,
52         SOCKET_EXEC_STOP_PRE,
53         SOCKET_EXEC_STOP_POST,
54         _SOCKET_EXEC_COMMAND_MAX,
55         _SOCKET_EXEC_COMMAND_INVALID = -1
56 } SocketExecCommand;
57
58 typedef enum SocketType {
59         SOCKET_SOCKET,
60         SOCKET_FIFO,
61         _SOCKET_FIFO_MAX,
62         _SOCKET_FIFO_INVALID = -1
63 } SocketType;
64
65 typedef struct SocketPort {
66         SocketType type;
67         int fd;
68
69         SocketAddress address;
70         char *path;
71         Watch fd_watch;
72
73         LIST_FIELDS(struct SocketPort, port);
74 } SocketPort;
75
76 struct Socket {
77         Meta meta;
78
79         LIST_HEAD(SocketPort, ports);
80
81         /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
82         SocketAddressBindIPv6Only bind_ipv6_only;
83         unsigned backlog;
84
85         usec_t timeout_usec;
86
87         ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
88         ExecContext exec_context;
89
90         Service *service;
91
92         SocketState state, deserialized_state;
93
94         KillMode kill_mode;
95
96         ExecCommand* control_command;
97         SocketExecCommand control_command_id;
98         pid_t control_pid;
99
100         char *bind_to_device;
101         mode_t directory_mode;
102         mode_t socket_mode;
103
104         bool accept;
105         unsigned n_accepted;
106
107         bool failure;
108         Watch timer_watch;
109 };
110
111 /* Called from the service code when collecting fds */
112 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds);
113
114 /* Called from the service when it shut down */
115 void socket_notify_service_dead(Socket *s);
116
117 /* Called from the mount code figure out if a mount is a dependency of
118  * any of the sockets of this socket */
119 int socket_add_one_mount_link(Socket *s, Mount *m);
120
121 extern const UnitVTable socket_vtable;
122
123 const char* socket_state_to_string(SocketState i);
124 SocketState socket_state_from_string(const char *s);
125
126 const char* socket_exec_command_to_string(SocketExecCommand i);
127 SocketExecCommand socket_exec_command_from_string(const char *s);
128
129 #endif