Removed TODO.
[cl-inotify.git] / package.lisp
index a67d037..5978614 100644 (file)
@@ -1,4 +1,35 @@
 (in-package #:cl-user)
 
 (defpackage cl-notify
-  (:use #:cl #:cffi))
+  (:use #:cl #:cffi #:utils-frahm #:anaphora)
+  (:export ;;; used types for documentation
+          #:inotify-add/read-flag
+          #:inotify-read-flag
+          #:inotify-add-flag
+
+          ;;; very raw
+          #:read-raw-event-from-stream
+
+          #:close-notify
+
+          ;;; event parsing functions
+          #:make-unregistered-notify
+          #:read-event-from-stream
+          #: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."))