2 * vim:ts=4:sw=4:expandtab
4 * i3 - an improved dynamic tiling window manager
5 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
7 * ipc.c: UNIX domain socket IPC (initialization, client handling, protocol).
16 #include <yajl/yajl_gen.h>
17 #include <yajl/yajl_parse.h>
21 #include "configuration.h"
25 extern char *current_socketpath;
27 typedef struct ipc_client {
30 /* The events which this client wants to receive */
34 /* For clients which subscribe to the tick event: whether the first tick
35 * event has been sent by i3. */
38 struct ev_io *callback;
39 struct ev_timer *timeout;
43 TAILQ_ENTRY(ipc_client)
48 * Callback type for the different message types.
50 * message is the raw packet, as received from the UNIX domain socket. size
51 * is the remaining size of bytes for this packet.
53 * message_size is the size of the message as the sender specified it.
54 * message_type is the type of the message as the sender specified it.
57 typedef void (*handler_t)(int, uint8_t *, int, uint32_t, uint32_t);
59 /* Macro to declare a callback */
60 #define IPC_HANDLER(name) \
61 static void handle_##name(int fd, uint8_t *message, \
62 int size, uint32_t message_size, \
63 uint32_t message_type)
66 * Handler for activity on the listening socket, meaning that a new client
67 * has just connected and we should accept() him. Sets up the event handler
68 * for activity on the new connection and inserts the file descriptor into
69 * the list of clients.
72 void ipc_new_client(EV_P_ struct ev_io *w, int revents);
75 * Creates the UNIX domain socket at the given path, sets it to non-blocking
76 * mode, bind()s and listen()s on it.
79 int ipc_create_socket(const char *filename);
82 * Sends the specified event to all IPC clients which are currently connected
83 * and subscribed to this kind of event.
86 void ipc_send_event(const char *event, uint32_t message_type, const char *payload);
89 * Calls to ipc_shutdown() should provide a reason for the shutdown.
92 SHUTDOWN_REASON_RESTART,
97 * Calls shutdown() on each socket and closes it.
100 void ipc_shutdown(shutdown_reason_t reason);
102 void dump_node(yajl_gen gen, Con *con, bool inplace_restart);
105 * Generates a json workspace event. Returns a dynamically allocated yajl
106 * generator. Free with yajl_gen_free().
108 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old);
111 * For the workspace events we send, along with the usual "change" field, also
112 * the workspace container in "current". For focus events, we send the
113 * previously focused workspace in "old".
115 void ipc_send_workspace_event(const char *change, Con *current, Con *old);
118 * For the window events we send, along the usual "change" field,
119 * also the window container, in "container".
121 void ipc_send_window_event(const char *property, Con *con);
124 * For the barconfig update events, we send the serialized barconfig.
126 void ipc_send_barconfig_update_event(Barconfig *barconfig);
129 * For the binding events, we send the serialized binding struct.
131 void ipc_send_binding_event(const char *event_type, Binding *bind);
134 * Set the maximum duration that we allow for a connection with an unwriteable
137 void ipc_set_kill_timeout(ev_tstamp new);