ipc.h

Go to the documentation of this file.

/*
 * vim:ts=4:sw=4:expandtab
 *
 * i3 - an improved dynamic tiling window manager
 * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
 *
 * ipc.c: UNIX domain socket IPC (initialization, client handling, protocol).
 *
 */
#pragma once
 
#include <config.h>
 
#include <ev.h>
#include <stdbool.h>
#include <yajl/yajl_gen.h>
#include <yajl/yajl_parse.h>
 
#include "data.h"
#include "tree.h"
#include "configuration.h"
 
#include "i3/ipc.h"
 
extern char *current_socketpath;
 
typedef struct ipc_client {
    int fd;
 
    /* The events which this client wants to receive */
    int num_events;
    char **events;
 
    /* For clients which subscribe to the tick event: whether the first tick
     * event has been sent by i3. */
    bool first_tick_sent;
 
    struct ev_io *read_callback;
    struct ev_io *write_callback;
    struct ev_timer *timeout;
    uint8_t *buffer;
    size_t buffer_size;
 
    TAILQ_ENTRY(ipc_client)
    clients;
} ipc_client;
 
/*
 * Callback type for the different message types.
 *
 * message is the raw packet, as received from the UNIX domain socket. size
 * is the remaining size of bytes for this packet.
 *
 * message_size is the size of the message as the sender specified it.
 * message_type is the type of the message as the sender specified it.
 *
 */
typedef void (*handler_t)(ipc_client *, uint8_t *, int, uint32_t, uint32_t);
 
/* Macro to declare a callback */
#define IPC_HANDLER(name)                                           \
    static void handle_##name(ipc_client *client, uint8_t *message, \
                              int size, uint32_t message_size,      \
                              uint32_t message_type)
 
void ipc_new_client(EV_P_ struct ev_io *w, int revents);
 
ipc_client *ipc_new_client_on_fd(EV_P_ int fd);
 
int ipc_create_socket(const char *filename);
 
void ipc_send_event(const char *event, uint32_t message_type, const char *payload);
 
typedef enum {
    SHUTDOWN_REASON_RESTART,
    SHUTDOWN_REASON_EXIT
} shutdown_reason_t;
 
void ipc_shutdown(shutdown_reason_t reason, int exempt_fd);
 
void dump_node(yajl_gen gen, Con *con, bool inplace_restart);
 
yajl_gen ipc_marshal_workspace_event(const char *change, Con *current, Con *old);
 
void ipc_send_workspace_event(const char *change, Con *current, Con *old);
 
void ipc_send_window_event(const char *property, Con *con);
 
void ipc_send_barconfig_update_event(Barconfig *barconfig);
 
void ipc_send_binding_event(const char *event_type, Binding *bind);
 
void ipc_set_kill_timeout(ev_tstamp new);
 
void ipc_confirm_restart(ipc_client *client);