Enhanced functionality and more convenience.
[cl-inotify.git] / package.lisp
index 4ec662d..0f7b202 100644 (file)
@@ -1,17 +1,32 @@
 (in-package #:cl-user)
 
 (defpackage cl-notify
-  (:use #:cl #:cffi)
-  (:export #:inotify-event
-          #:inotify-event-wd
-          #:inotify-event-mask
-          #:inotify-event-cookie
-          #:inotify-event-name
+  (:use #:cl #:cffi #:utils-frahm #:anaphora)
+  (:export ;;; used types for documentation
+          #:inotify-add/read-flag
+          #:inotify-read-flag
+          #:inotify-add-flag
 
-          #:inotify-read-raw-event
-          #:inotify-read-event
-          #:make-inotify
           #:close-notify
+
+          ;;; event parsing functions
+          #:make-unregistered-notify
+          #:read-raw-event
+          #:watch-raw
+          #:unwatch-raw
+
+          ;;; enhanced functionality
+          #:make-notify
+          #:watchedp
           #:watch
           #:unwatch
-          ))
+          #:event-availablep
+          #:read-event
+          #:next-event
+
+          ;;; convenience functions
+          #:list-watched
+          #:do-events
+          #:read-events
+          )
+  (:documentation "A binding for the LINUX inotify(7) API."))