3 * $Id: fwatch.h,v 1.2 2004/04/08 01:36:11 mdw Exp $
5 * Watch a file for changes
7 * (c) 2001 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
14 * mLib is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * mLib is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with mLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 /*----- Header files ------------------------------------------------------*/
39 #include <sys/types.h>
42 /*----- Data structures ---------------------------------------------------*/
44 typedef struct fwatch {
55 /*----- Functions provided ------------------------------------------------*/
57 /* --- @fwatch_init@, @fwatch_update@, etc --- *
59 * Arguments: @fwatch *f@ = pointer to an @fwatch@ structure
60 * @const char *name@ = name of the file to watch
61 * @int fd@ = a file descriptor to watch
63 * Returns: The @update@ functions return nonzero if the file has
66 * Use: Stores information about a file which can be used to watch
67 * for changes. The structures may be freed without telling
71 extern void fwatch_init(fwatch */*f*/, const char */*name*/);
72 extern void fwatch_initfd(fwatch */*f*/, int /*fd*/);
73 extern int fwatch_update(fwatch */*f*/, const char */*name*/);
74 extern int fwatch_updatefd(fwatch */*f*/, int /*fd*/);
76 /*----- That's all, folks -------------------------------------------------*/