pnotify.h

Go to the documentation of this file.

/*              $Id: $          */

/*
 * Copyright (c) 2007 Mark Heily <devel@heily.com>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef _PNOTIFY_H
#define _PNOTIFY_H

#include <dirent.h>
#include <stdarg.h>
#include <stdint.h>
#include <limits.h>
#include <sys/time.h>
#include <stdarg.h>

/* kqueue(4) in MacOS/X does not support NOTE_TRUNCATE */
#ifndef NOTE_TRUNCATE
# define NOTE_TRUNCATE 0
#endif

/* Opaque structures */
struct pnotify_event;
struct pnotify_ctx;


enum pn_watch_type {
        WATCH_VNODE = 0,

        WATCH_FD,

        WATCH_TIMER,

        WATCH_SIGNAL,
        
        WATCH_FUNCTION
};


union pn_resource_id {
        int fd;

        int signum;

        int interval;

        char *path;
};


enum pn_event_bitmask {

        PN_DEFAULT              = 0,

        PN_ATTRIB               = 0x1 << 0,

        PN_CREATE               = 0x1 << 1,

        PN_DELETE               = 0x1 << 2,

        PN_MODIFY               = 0x1 << 3,

        PN_READ                 = 0x1 << 4,

        PN_WRITE                = 0x1 << 5,

        PN_CLOSE                = 0x1 << 6,

        PN_TIMEOUT              = 0x1 << 7,  

        PN_SIGNAL               = 0x1 << 8,  

        PN_ONESHOT              = 0x1 << 30,

        PN_ERROR                = 0x1 << 31,

};


struct pnotify_watch {

        enum pn_watch_type type;

        enum pn_event_bitmask mask;

        union pn_resource_id ident;

        void (*cb)();
        void *arg;

        struct pnotify_ctx *ctx;
};


struct pnotify_ctx * pnotify_init();

int pnotify_add_watch(struct pnotify_watch *watch);

int pnotify_rm_watch(int wd);


int pnotify_get_event(struct pnotify_event *, struct pnotify_ctx *);

int pnotify_dispatch();

int pnotify_print_event(struct pnotify_event *);


void pnotify_dump(struct pnotify_ctx *);

void pnotify_free(struct pnotify_ctx *ctx);

int pnotify_trap_signal(int signum, void (*cb)(), void *arg);

int pnotify_watch_vnode(const char *path, int mask, void (*cb)(), void *arg);

int pnotify_watch_fd(int fd, int mask, void (*cb)(), void *arg); 

int pnotify_set_timer(int interval, int mask, void (*cb)(), void *arg);

#if TODO
        // experimental
        
#define PNOTIFY_ARG_MAX 12

struct pnotify_func {

        void (*symbol)();

        size_t argc;

        void *argv[PNOTIFY_ARG_MAX + 1];

        void (*cb)();
        void *cbarg;    

        /* -- filled in by the function when it returns -- */

        union {
                int rv_int;
                void *rv_ptr;
        } retval;

        int ret_errno;
};

#define pnotify_set_function(pf, sym, 

int pnotify_call_function(struct );
#endif

#endif /* _PNOTIFY_H */

---