]> git.sur5r.net Git - i3/i3/commitdiff
Add docs to include/ipc.h
authorMichael Stapelberg <michael@stapelberg.de>
Tue, 28 Jul 2009 18:58:56 +0000 (20:58 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Tue, 28 Jul 2009 18:58:56 +0000 (20:58 +0200)
include/ipc.h

index 478354b5bedf22d763b1a76ffbec71a37c072a5b..de4e22642274535c657fd9b63aeb4b6d5b987f30 100644 (file)
 
 #include "i3/ipc.h"
 
+/**
+ * Handler for activity on the listening socket, meaning that a new client
+ * has just connected and we should accept() him. Sets up the event handler
+ * for activity on the new connection and inserts the file descriptor into
+ * the list of clients.
+ *
+ */
 void ipc_new_client(EV_P_ struct ev_io *w, int revents);
 
+/**
+ * Creates the UNIX domain socket at the given path, sets it to non-blocking
+ * mode, bind()s and listen()s on it.
+ *
+ */
 int ipc_create_socket(const char *filename);
 
 #endif