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 *read_callback;
39 struct ev_io *write_callback;
40 struct ev_timer *timeout;
44 TAILQ_ENTRY(ipc_client)
49 * Callback type for the different message types.
51 * message is the raw packet, as received from the UNIX domain socket. size
52 * is the remaining size of bytes for this packet.
54 * message_size is the size of the message as the sender specified it.
55 * message_type is the type of the message as the sender specified it.
58 typedef void (*handler_t)(ipc_client *, uint8_t *, int, uint32_t, uint32_t);
60 /* Macro to declare a callback */
61 #define IPC_HANDLER(name) \
62 static void handle_##name(ipc_client *client, uint8_t *message, \
63 int size, uint32_t message_size, \
64 uint32_t message_type)
67 * Handler for activity on the listening socket, meaning that a new client
68 * has just connected and we should accept() him. Sets up the event handler
69 * for activity on the new connection and inserts the file descriptor into
70 * the list of clients.
73 void ipc_new_client(EV_P_ struct ev_io *w, int revents);
76 * Creates the UNIX domain socket at the given path, sets it to non-blocking
77 * mode, bind()s and listen()s on it.
80 int ipc_create_socket(const char *filename);
83 * Sends the specified event to all IPC clients which are currently connected
84 * and subscribed to this kind of event.
87 void ipc_send_event(const char *event, uint32_t message_type, const char *payload);
90 * Calls to ipc_shutdown() should provide a reason for the shutdown.
93 SHUTDOWN_REASON_RESTART,
98 * Calls shutdown() on each socket and closes it.
101 void ipc_shutdown(shutdown_reason_t reason);
103 void dump_node(yajl_gen gen, Con *con, bool inplace_restart);
106 * Generates a json workspace event. Returns a dynamically allocated yajl
107 * generator. Free with yajl_gen_free().
109 yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old);
112 * For the workspace events we send, along with the usual "change" field, also
113 * the workspace container in "current". For focus events, we send the
114 * previously focused workspace in "old".
116 void ipc_send_workspace_event(const char *change, Con *current, Con *old);
119 * For the window events we send, along the usual "change" field,
120 * also the window container, in "container".
122 void ipc_send_window_event(const char *property, Con *con);
125 * For the barconfig update events, we send the serialized barconfig.
127 void ipc_send_barconfig_update_event(Barconfig *barconfig);
130 * For the binding events, we send the serialized binding struct.
132 void ipc_send_binding_event(const char *event_type, Binding *bind);
135 * Set the maximum duration that we allow for a connection with an unwriteable
138 void ipc_set_kill_timeout(ev_tstamp new);