diff --git a/server/client.h b/server/client.h index d59a5ec..cc55a83 100644 --- a/server/client.h +++ b/server/client.h @@ -1,6 +1,8 @@ -/* - * client.h - * This file is part of LCDd, the lcdproc server. +/** \file client.h + * Defines all the client data and actions. + */ + +/* This file is part of LCDd, the lcdproc server. * * This file is released under the GNU General Public License. Refer to the * COPYING file distributed with this package. @@ -8,7 +10,6 @@ * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn * - * Defines all the client data and actions. */ #include "menu.h" @@ -23,12 +24,15 @@ #define CLIENT_NAME_SIZE 256 +/** Possible states of a client. */ typedef enum _clientstate { - NEW, - ACTIVE, - GONE + NEW, /**< Client did not yet send \c hello. */ + ACTIVE, /**< Client sent \c hello, but not yet \c bye. */ + GONE /**< Client sent \c bye. */ } ClientState; + +/** The structure representing a client in the server. */ typedef struct Client { char *name; ClientState state; @@ -36,17 +40,13 @@ typedef struct Client { int backlight; int heartbeat; - /* Messages that the client generated */ - LinkedList *messages; - - /* The list of screens */ - LinkedList *screenlist; - - /* Maybe it has created a menu */ - Menu *menu; + LinkedList *messages; /**< Messages that the client sent. */ + LinkedList *screenlist; /**< List of client's screens. */ + Menu *menu; /**< Menu hierarchy, if any */ } Client; + #include "screen.h" /* When a new client connects, set up a new client data struct */