This is the cl-inotify Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:06:20 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-inotifyInotify binding.
Olof-Joachim Frahm <olof@macrolet.net>
Simplified BSD License
Binding to the Linux inotify(7) API.
cffi (system).
binary-types (system).
trivial-utf-8 (system).
osicat (system).
iolib (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-inotify/srccl-inotify (system).
package.lisp (file).
grovel.lisp (file).
inotify.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-inotify/cl-inotify.asdcl-inotify/src/package.lispcl-inotify/src/grovel.lispcl-inotify/src/inotify.lispcl-inotify/src/inotify.lispsrc (module).
close-inotify (function).
do-events (macro).
event-available-p (function).
event-pathname/flags (function).
inotify-add-flag (type).
inotify-add/read-flag (type).
inotify-event-cookie (reader).
(setf inotify-event-cookie) (writer).
inotify-event-mask (reader).
(setf inotify-event-mask) (writer).
inotify-event-name (reader).
(setf inotify-event-name) (writer).
inotify-event-wd (reader).
(setf inotify-event-wd) (writer).
inotify-fd (reader).
(setf inotify-fd) (writer).
inotify-nonblocking (reader).
(setf inotify-nonblocking) (writer).
inotify-read-flag (type).
inotify-stream (reader).
(setf inotify-stream) (writer).
list-watched (function).
make-inotify (function).
make-unregistered-inotify (function).
next-event (function).
next-events (function).
pathname-handle/flags (function).
read-event (function).
read-event-from-stream (function).
read-raw-event-from-stream (function).
unwatch (function).
unwatch-raw (function).
watch (function).
watch-raw (function).
with-inotify (macro).
with-unregistered-inotify (macro).
copy-inotify-event (function).
copy-inotify-instance (function).
copy-registered-inotify-instance (function).
ensure-list (function).
init-endian (function).
init-unregistered-inotify (function).
inotify-add-watch (function).
inotify-event (structure).
inotify-event-p (function).
inotify-handles (reader).
(setf inotify-handles) (writer).
inotify-init (function).
inotify-init1 (function).
inotify-instance (structure).
inotify-instance-p (function).
inotify-pathnames (reader).
(setf inotify-pathnames) (writer).
inotify-rm-watch (function).
int (type).
make-inotify-event (function).
make-inotify-instance (function).
make-registered-inotify-instance (function).
read-new-value (function).
registered-inotify-instance (structure).
registered-inotify-instance-p (function).
sane-user-flags (function).
set-nonblocking (function).
translate-keyword-flags (function).
unix-eagain-p (function).
valid-watch-flag-list-p (function).
valid-watch-flag-p (function).
watch-flag-list (type).
Packages are listed by definition order.
cl-inotifyBinding to the Linux inotify(7) API.
cffi.
common-lisp.
close-inotify (function).
do-events (macro).
event-available-p (function).
event-pathname/flags (function).
inotify-add-flag (type).
inotify-add/read-flag (type).
inotify-event-cookie (reader).
(setf inotify-event-cookie) (writer).
inotify-event-mask (reader).
(setf inotify-event-mask) (writer).
inotify-event-name (reader).
(setf inotify-event-name) (writer).
inotify-event-wd (reader).
(setf inotify-event-wd) (writer).
inotify-fd (reader).
(setf inotify-fd) (writer).
inotify-nonblocking (reader).
(setf inotify-nonblocking) (writer).
inotify-read-flag (type).
inotify-stream (reader).
(setf inotify-stream) (writer).
list-watched (function).
make-inotify (function).
make-unregistered-inotify (function).
next-event (function).
next-events (function).
pathname-handle/flags (function).
read-event (function).
read-event-from-stream (function).
read-raw-event-from-stream (function).
unwatch (function).
unwatch-raw (function).
watch (function).
watch-raw (function).
with-inotify (macro).
with-unregistered-inotify (macro).
copy-inotify-event (function).
copy-inotify-instance (function).
copy-registered-inotify-instance (function).
ensure-list (function).
init-endian (function).
init-unregistered-inotify (function).
inotify-add-watch (function).
inotify-event (structure).
inotify-event-p (function).
inotify-handles (reader).
(setf inotify-handles) (writer).
inotify-init (function).
inotify-init1 (function).
inotify-instance (structure).
inotify-instance-p (function).
inotify-pathnames (reader).
(setf inotify-pathnames) (writer).
inotify-rm-watch (function).
int (type).
make-inotify-event (function).
make-inotify-instance (function).
make-registered-inotify-instance (function).
read-new-value (function).
registered-inotify-instance (structure).
registered-inotify-instance-p (function).
sane-user-flags (function).
set-nonblocking (function).
translate-keyword-flags (function).
unix-eagain-p (function).
valid-watch-flag-list-p (function).
valid-watch-flag-p (function).
watch-flag-list (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Loops BODY with VAR bound to the next events retrieved from INOTIFY. The macro uses NEXT-EVENT, so reading an event won’t block and the loop terminates if no events are available. If BLOCKING-P is set, the loop blocks if no events are available, otherwise it exits as soon as no events were encountered.
Executes BODY with a newly created queue bound to INOTIFY if true.
See MAKE-INOTIFY for more information about possible arguments.
The REST is a list of argument forms for the WATCH function, i.e. one or
more forms (PATHNAME FLAGS &KEY (REPLACE-P T)).
Since the QUEUE is closed on unwinding, this macro doesn’t bother with UNWATCH calls on all WATCHed paths.
Like WITH-INOTIFY, but uses MAKE-UNREGISTERED-INOTIFY and WATCH-RAW instead. Useful if you need to monitor just a fixed set of paths.
Closes the inotify event queue.
Returns T if an event is available on the queue.
Returns two values PATHNAME and FLAGS for an EVENT which were used during registration. If HANDLE is specified EVENT is ignored.
mask.
name.
wd.
fd.
Returns a LIST of all watched pathnames in no particular order.
Creates a new registered INOTIFY instance. In NONBLOCKING mode, the file descriptor is set to non-blocking mode. The resulting object has to be closed with CLOSE-INOTIFY.
Creates a new unregistered INOTIFY instance.
Reads an event from the queue. Returns NIL if none is available.
Reads all available events from the queue. Returns a LIST of events.
Returns a CONS cell with the values HANDLE and FLAGS if PATHNAME is being watched by INOTIFY, else NIL. The match is exact.
Reads an event from the queue. Blocks if no event is available.
Reads a event from the inotify stream and converts bitmasks on reading.
Reads a raw event from the inotify stream.
Disables watching the path associated with the supplied HANDLE (which may be one from a given EVENT) or PATHNAME.
Stops watching the path associated with a HANDLE established by WATCH-RAW.
Adds PATHNAME (either pathname or string) to be watched and records the watched paths. FLAGS (a list of keywords) determines how exactly (see inotify(7) for detailed information). Returns a handle which can be used with UNWATCH and EVENT-PATHNAME/FLAGS. If REPLACE-P is set to T (default), the flags mask is replaced rather than OR-ed to the current mask (if it exists). The :MASK-ADD flag is therefore removed from the FLAGS argument.
Adds PATHNAME (either of type PATHNAME or STRING) to be watched. FLAGS determines how exactly (see inotify(7) for detailed information) and can be of type LIST, KEYWORD or a raw numerical value (which isn’t checked for validity though). Returns a handle which can be used with UNWATCH-RAW.
Initialises the endianess for the BINARY-TYPES library. Is automatically called when the library is loaded.
Creates a new inotify event queue. If NONBLOCKING is set (default), the file descriptor is set to non-blocking I/O.
Watches a path on an event queue.
Initialises a new inotify event queue.
Initialises a new inotify event queue and passes some flags along.
Removes a watched path from an event queue.
READs a value from the STREAM and returns it (wrapped in a list).
Enables or disables NONBLOCKING mode on a file descriptor FD.
Returns T on a file descriptor if trying to read raised an EAGAIN error.
An inotify native event structure.
WD is the watch/file descriptor,
MASK is the (parsed) combination of events,
COOKIE is a unique integer which connects related events,
NAME optionally identifies a file relative to a watched directory.
Contains the stream and file descriptor for a inotify instance.
Additionally to the information in INOTIFY-INSTANCE, records watched paths in a dictionary.
Valid flags argument for the WATCH function, a list of keywords from INOTIFY-ADD-FLAG. Basically only :MASK-ADD and :ONESHOT are removed. The :MASK-ADD behaviour is replicated with the REPLACE-P argument; the :ONESHOT behaviour doesn’t play well with the WATCH function design (and thus should be used only with WATCH-RAW).
| Jump to: | (
C D E F I L M N P R S T U V W |
|---|
| Jump to: | (
C D E F I L M N P R S T U V W |
|---|
| Jump to: | C F H M N P S W |
|---|
| Jump to: | C F H M N P S W |
|---|
| Jump to: | C F G I M P R S T W |
|---|
| Jump to: | C F G I M P R S T W |
|---|