65b2410035eb96b23a17783dd63cf80e28856c55
[cl-inotify.git] / package.lisp
1 (in-package #:cl-user)
2
3 (defpackage cl-inotify
4   (:use #:cl #:cffi)
5   (:export ;;; used types for documentation
6            #:inotify-add/read-flag
7            #:inotify-read-flag
8            #:inotify-add-flag
9
10            ;;; very raw
11            #:read-raw-event-from-stream
12
13            #:close-notify
14
15            ;;; event parsing functions
16            #:make-unregistered-notify
17            #:read-event-from-stream
18            #:watch-raw
19            #:unwatch-raw
20
21            ;;; enhanced functionality
22            #:make-notify
23            #:watchedp
24            #:watch
25            #:unwatch
26            #:event-availablep
27            #:read-event
28            #:next-event
29
30            ;;; convenience functions
31            #:list-watched
32            #:do-events
33            #:read-events
34            )
35   (:documentation "A binding (not only?) for the LINUX inotify(7) API."))