The cl-inotify Reference Manual

Table of Contents

The cl-inotify Reference Manual

This is the cl-inotify Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:11:08 2018 GMT+0.

1 Introduction

CL-INOTIFY - Binding to the Linux inotify(7) API.

Copyright (C) 2011-15 Olof-Joachim Frahm

Released under a Simplified BSD license.

Working, but unfinished.

Uses CFFI, binary-types (from my Github or see CLiki) and trivial-utf-8. Doesn't require iolib, because I don't need most of the functionality, although it might add some implementation independence (patches which can be conditionally compiled are most welcome; in any case patches are always welcome). The tests require fiveam.

Similar packages are inotify and cl-fsnotify.

This document helps only with the aspects of this binding, so reading the man-page and other information on the inotify-facility may be needed. Reading the next sections and the docstrings of exported symbols should get you going, otherwise the source itself may also be of some value.

REPLSHOT

Macros make keeping track easier, so the following example is straightforward:

> (with-inotify (inotify T ("." :all-events))
>   (do-events (event inotify :blocking-p T)
>     (format T "~A~%" event)))
> =>
> #S(CL-INOTIFY::INOTIFY-EVENT :WD 1 :MASK (CREATE) :COOKIE 0 :NAME .zshist.LOCK)
> #S(CL-INOTIFY::INOTIFY-EVENT :WD 1 :MASK (OPEN) :COOKIE 0 :NAME .zshist)
> #S(CL-INOTIFY::INOTIFY-EVENT :WD 1 :MASK (MODIFY) :COOKIE 0 :NAME .zshist)
> #S(CL-INOTIFY::INOTIFY-EVENT :WD 1 :MASK (CLOSE-WRITE) :COOKIE 0 :NAME .zshist)
> #S(CL-INOTIFY::INOTIFY-EVENT :WD 1 :MASK (DELETE) :COOKIE 0 :NAME .zshist.LOCK)
> ...

(Tilde-expansion has to happen at another level, else I would've used that.)

The first parameter is (per convention) the symbol to which the queue is bound, the second is the parameter to MAKE-INOTIFY. The &REST list consists of parameter lists for the WATCH-function, which is called for every list before the &BODY is executed. We don't actually need to UNWATCH every watched path as closing the queue will also take care of that.

LOWER-LEVEL USAGE EXAMPLE

You don't have to use macros: all functionality is available in function form, although some care should be taken as currently no cleanup handler is registered for opened queues, or rather their file handles.

> (use-package '#:cl-inotify)
> (defvar *tmp*)
> (setf *tmp* (make-notify))
> (watch *tmp* "/var/tmp/" :all-events)
> (next-events *tmp*)
> (close-inotify *tmp*)

HOWTO

So this section deals in depth with the various bits which make the examples above tick.

After loading the library use MAKE-INOTIFY to create a new event queue. The NONBLOCKING argument sets the SB-POSIX:O-NONBLOCK bit on the stream so we don't block while reading. Nevertheless, EVENT-AVAILABLE-P works either way (by using CL:LISTEN, or a custom function which works directly on the file descriptor).

The result of MAKE-INOTIFY is used with WATCH and UNWATCH, the first being used to watch a file or directory, the second to stop watching it. The FLAGS parameter of WATCH is described in the notify(7) man-page; you can use a combination of the flags (as keywords) to create a suitable bitmask. The types INOTIFY-ADD/READ-FLAG, INOTIFY-READ-FLAG and INOTIFY-ADD-FLAG are also defined and can be examined.

For example, to watch for modified or closed files in a directory, call (WATCH inotify "foo/" '(:modify :close)).

The result of WATCH is a handle (currently a FIXNUM, but I wouldn't rely on that) which can be fed to UNWATCH and can be translated from events with EVENT-PATHNAME/FLAGS.

To finally get the events from the queue, use READ-EVENT (which blocks) or NEXT-EVENT (which doesn't block). EVENT-AVAILABLE-P does what it should do, NEXT-EVENTS retrieves all currently available events as a list and DO-EVENTS (nonblocking) iterates over available events.

The enhanced API registers all watched paths in a hashtable, so you can use PATHNAME-HANDLE/FLAGS to check if a pathname (exact match) is being watched and LIST-WATCHED to return all watched paths as a list. EVENT-PATHNAME/FLAGS may be used to get the pathname and flags for a read event.

UNWATCH has to be called with the path or the handle of the watched file or directory (a path will be looked up in the same table as with PATHNAME-HANDLE/FLAGS).

The raw API, which doesn't register watched paths, consists of READ-RAW-EVENT-FROM-STREAM, READ-EVENT-FROM-STREAM, WATCH-RAW and UNWATCH-RAW. They are just a thin wrapper around the C functions, but they're exported in case someone doesn't like the upper layers.

EVENT-BASED PROCESSING

In case you want to use epoll or select on the event queue you can access the file descriptor yourself and then use the normal functions afterwards. Currently no such functionality is integrated here, however the following sketch shows how something can be accomplished using iolib:

(with-unregistered-inotify (inotify T ("." :all-events))
  (flet ((inotify-input (&rest rest)
           (declare (ignore rest))
           (format T "~{~A~%~}" (next-events inotify))))
    (iolib:with-event-base (event-base)
      (iolib:set-io-handler event-base (inotify-fd inotify) :read #'inotify-input)
      (iolib:event-dispatch event-base))))

Note that we perform all inotify business only when something happens in that directory, so instead of doing nothing, we could actually do useful work, e.g. communicating with a process: This snippet was extracted from a function which uses behaviour to monitor a LaTeX process for written files to get the output file name without relying on heuristics about the generated filename. As it stands you have to split this into threads, or use IOLIB:EVENT-DISPATCH with a timeout while periodically checking the process status.

REFERENCE

Here follows a list of valid keywords for the INOTIFY-FLAG type:

• :ACCESS
• :MODIFY
• :ATTRIB
• :CLOSE-WRITE
• :CLOSE-NOWRITE
• :CLOSE
• :OPEN
• :MOVED-FROM
• :MOVED-TO
• :MOVE
• :CREATE
• :DELETE
• :DELETE-SELF
• :MOVE-SELF
• :UNMOUNT
• :Q-OVERFLOW
• :IGNORED
• :ONLYDIR
• :DONT-FOLLOW
• :MASK-ADD
• :ISDIR
• :ONESHOT
• :ALL-EVENTS

The INOTIFY-EVENT structure has the slots WD, MASK, COOKIE and NAME (with default CONC-NAME: INOTIFY-EVENT-).

The INOTIFY-INSTANCE structure has the slots FD, STREAM and NONBLOCKING with CONC-NAME INOTIFY-.

The REGISTERED-INOTIFY-INSTANCE includes the previous structure and only adds the WATCHED slot under the same CONC-NAME.

TODO

• more functionality to examine read events
• extend to other APIs?
• make things more implementation independent (partly done, still needs fd-streams everywhere, or skip them entirely)
• (maybe) don't use the libc for this, direct syscall
• (maybe) add iolib replacement for io functions
• the nonblocking mode is pretty useless, because for one the READ functions still block and also LISTEN seems to work just fine and it's not even needed for multiplexing, so why keep this in?

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-inotify

Author

Olof-Joachim Frahm <olof@macrolet.net>

License

Simplified BSD License

Description

Inotify binding.

Long Description

Binding to the Linux inotify(7) API.

Dependencies

• cffi
• binary-types
• trivial-utf-8
• osicat
• iolib

Source

cl-inotify.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-inotify/src

Parent

cl-inotify (system)

Location

src/

Components

• package.lisp (file)
• grovel.lisp (file)
• inotify.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-inotify.asd

Location

cl-inotify.asd

Systems

cl-inotify (system)

4.1.2 cl-inotify/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-inotify

4.1.3 cl-inotify/src/grovel.lisp

Parent

src (module)

Location

src/grovel.lisp

4.1.4 cl-inotify/src/inotify.lisp

Parent

src (module)

Location

src/inotify.lisp

Exported Definitions

• 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 (function)
• (setf inotify-event-cookie) (function)
• inotify-event-mask (function)
• (setf inotify-event-mask) (function)
• inotify-event-name (function)
• (setf inotify-event-name) (function)
• inotify-event-wd (function)
• (setf inotify-event-wd) (function)
• inotify-fd (function)
• (setf inotify-fd) (function)
• inotify-nonblocking (function)
• (setf inotify-nonblocking) (function)
• inotify-read-flag (type)
• inotify-stream (function)
• (setf inotify-stream) (function)
• 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)

Internal Definitions

• 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 (function)
• (setf inotify-handles) (function)
• inotify-init (function)
• inotify-init1 (function)
• inotify-instance (structure)
• inotify-instance-p (function)
• inotify-pathnames (function)
• (setf inotify-pathnames) (function)
• 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)

5 Packages

Packages are listed by definition order.

5.1 cl-inotify

Binding to the Linux inotify(7) API.

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• 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 (function)
• (setf inotify-event-cookie) (function)
• inotify-event-mask (function)
• (setf inotify-event-mask) (function)
• inotify-event-name (function)
• (setf inotify-event-name) (function)
• inotify-event-wd (function)
• (setf inotify-event-wd) (function)
• inotify-fd (function)
• (setf inotify-fd) (function)
• inotify-nonblocking (function)
• (setf inotify-nonblocking) (function)
• inotify-read-flag (type)
• inotify-stream (function)
• (setf inotify-stream) (function)
• 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)

Internal Definitions

• copy-inotify-event (function)
• copy-inotify-instance (function)
• copy-registered-inotify-instance (function)
• ensure-list (function)
• in-access (constant)
• in-all-events (constant)
• in-attrib (constant)
• in-cloexec (constant)
• in-close (constant)
• in-close-nowrite (constant)
• in-close-write (constant)
• in-create (constant)
• in-delete (constant)
• in-delete-self (constant)
• in-dont-follow (constant)
• in-ignored (constant)
• in-isdir (constant)
• in-mask-add (constant)
• in-modify (constant)
• in-move (constant)
• in-move-self (constant)
• in-moved-from (constant)
• in-moved-to (constant)
• in-nonblock (constant)
• in-oneshot (constant)
• in-onlydir (constant)
• in-open (constant)
• in-q-overflow (constant)
• in-unmount (constant)
• init-endian (function)
• init-unregistered-inotify (function)
• inotify-add-watch (function)
• inotify-event (structure)
• inotify-event-p (function)
• inotify-handles (function)
• (setf inotify-handles) (function)
• inotify-init (function)
• inotify-init1 (function)
• inotify-instance (structure)
• inotify-instance-p (function)
• inotify-pathnames (function)
• (setf inotify-pathnames) (function)
• 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)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Macros

Macro: do-events (VAR INOTIFY &key BLOCKING-P) &body BODY

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.

Package

cl-inotify

Source

inotify.lisp (file)

Macro: with-inotify (INOTIFY &optional NONBLOCKING &rest REST) &body BODY

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.

Package

cl-inotify

Source

inotify.lisp (file)

Macro: with-unregistered-inotify (INOTIFY &optional NONBLOCKING &rest REST) &body BODY

Like WITH-INOTIFY, but uses MAKE-UNREGISTERED-INOTIFY and WATCH-RAW instead. Useful if you need to monitor just a fixed set of paths.

Package

cl-inotify

Source

inotify.lisp (file)

6.1.2 Functions

Function: close-inotify INOTIFY

Closes the inotify event queue.

Package

cl-inotify

Source

inotify.lisp (file)

Function: event-available-p INOTIFY

Returns T if an event is available on the queue.

Package

cl-inotify

Source

inotify.lisp (file)

Function: event-pathname/flags INOTIFY EVENT &optional HANDLE

Returns two values PATHNAME and FLAGS for an EVENT which were used during registration. If HANDLE is specified EVENT is ignored.

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-event-cookie INSTANCE

Function: (setf inotify-event-cookie) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-event-mask INSTANCE

Function: (setf inotify-event-mask) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-event-name INSTANCE

Function: (setf inotify-event-name) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-event-wd INSTANCE

Function: (setf inotify-event-wd) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-fd INSTANCE

Function: (setf inotify-fd) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-nonblocking INSTANCE

Function: (setf inotify-nonblocking) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-stream INSTANCE

Function: (setf inotify-stream) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: list-watched INOTIFY

Returns a LIST of all watched pathnames in no particular order.

Package

cl-inotify

Source

inotify.lisp (file)

Function: make-inotify &optional NONBLOCKING

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.

Package

cl-inotify

Source

inotify.lisp (file)

Function: make-unregistered-inotify &optional NONBLOCKING

Creates a new unregistered INOTIFY instance.

Package

cl-inotify

Source

inotify.lisp (file)

Function: next-event INOTIFY

Reads an event from the queue. Returns NIL if none is available.

Package

cl-inotify

Source

inotify.lisp (file)

Function: next-events INOTIFY

Reads all available events from the queue. Returns a LIST of events.

Package

cl-inotify

Source

inotify.lisp (file)

Function: pathname-handle/flags INOTIFY PATHNAME

Returns a CONS cell with the values HANDLE and FLAGS if PATHNAME is being watched by INOTIFY, else NIL. The match is exact.

Package

cl-inotify

Source

inotify.lisp (file)

Function: read-event INOTIFY

Reads an event from the queue. Blocks if no event is available.

Package

cl-inotify

Source

inotify.lisp (file)

Function: read-event-from-stream STREAM

Reads a event from the inotify stream and converts bitmasks on reading.

Package

cl-inotify

Source

inotify.lisp (file)

Function: read-raw-event-from-stream STREAM

Reads a raw event from the inotify stream.

Package

cl-inotify

Source

inotify.lisp (file)

Function: unwatch INOTIFY &key PATHNAME EVENT HANDLE

Disables watching the path associated with the supplied HANDLE (which may be one from a given EVENT) or PATHNAME.

Package

cl-inotify

Source

inotify.lisp (file)

Function: unwatch-raw INOTIFY HANDLE

Stops watching the path associated with a HANDLE established by WATCH-RAW.

Package

cl-inotify

Source

inotify.lisp (file)

Function: watch INOTIFY PATHNAME FLAGS &key REPLACE-P

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.

Package

cl-inotify

Source

inotify.lisp (file)

Function: watch-raw INOTIFY PATHNAME FLAGS

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.

Package

cl-inotify

Source

inotify.lisp (file)

6.1.3 Types

Type: inotify-add-flag ()

Valid flags for the WATCH-RAW function.

Package

cl-inotify

Source

inotify.lisp (file)

Type: inotify-add/read-flag ()

Shared valid flags for the WATCH-RAW and READ-EVENT functions.

Package

cl-inotify

Source

inotify.lisp (file)

Type: inotify-read-flag ()

Valid flags which are returned from READ-EVENT.

Package

cl-inotify

Source

inotify.lisp (file)

6.2 Internal definitions

6.2.1 Constants

Constant: in-access

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-all-events

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-attrib

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-cloexec

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-close

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-close-nowrite

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-close-write

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-create

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-delete

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-delete-self

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-dont-follow

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-ignored

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-isdir

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-mask-add

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-modify

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-move

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-move-self

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-moved-from

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-moved-to

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-nonblock

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-oneshot

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-onlydir

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-open

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-q-overflow

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

Constant: in-unmount

Package

cl-inotify

Source

/home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-inotify-20180228-git/src/grovel.processed-grovel-file

6.2.2 Functions

Function: copy-inotify-event INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: copy-inotify-instance INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: copy-registered-inotify-instance INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: ensure-list ARG

Package

cl-inotify

Source

inotify.lisp (file)

Function: init-endian ()

Initialises the endianess for the BINARY-TYPES library. Is automatically called when the library is loaded.

Package

cl-inotify

Source

inotify.lisp (file)

Function: init-unregistered-inotify INOTIFY &optional NONBLOCKING

Creates a new inotify event queue. If NONBLOCKING is set (default), the file descriptor is set to non-blocking I/O.

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-add-watch FD PATHNAME MASK

Watches a path on an event queue.

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-event-p OBJECT

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-handles INSTANCE

Function: (setf inotify-handles) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-init ()

Initialises a new inotify event queue.

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-init1 FLAGS

Initialises a new inotify event queue and passes some flags along.

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-instance-p OBJECT

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-pathnames INSTANCE

Function: (setf inotify-pathnames) VALUE INSTANCE

Package

cl-inotify

Source

inotify.lisp (file)

Function: inotify-rm-watch FD WD

Removes a watched path from an event queue.

Package

cl-inotify

Source

inotify.lisp (file)

Function: make-inotify-event &key (WD WD) (MASK MASK) (COOKIE COOKIE) (NAME NAME)

Package

cl-inotify

Source

inotify.lisp (file)

Function: make-inotify-instance ()

Package

cl-inotify

Source

inotify.lisp (file)

Function: make-registered-inotify-instance ()

Package

cl-inotify

Source

inotify.lisp (file)

Function: read-new-value &optional STREAM

READs a value from the STREAM and returns it (wrapped in a list).

Package

cl-inotify

Source

inotify.lisp (file)

Function: registered-inotify-instance-p OBJECT

Package

cl-inotify

Source

inotify.lisp (file)

Function: sane-user-flags INOTIFY PATHNAME FLAGS &key REPLACE-P

Package

cl-inotify

Source

inotify.lisp (file)

Function: set-nonblocking FD NONBLOCKING

Enables or disables NONBLOCKING mode on a file descriptor FD.

Package

cl-inotify

Source

inotify.lisp (file)

Function: translate-keyword-flags FLAGS

Package

cl-inotify

Source

inotify.lisp (file)

Function: unix-eagain-p FD

Returns T on a file descriptor if trying to read raised an EAGAIN error.

Package

cl-inotify

Source

inotify.lisp (file)

Function: valid-watch-flag-list-p LIST

Package

cl-inotify

Source

inotify.lisp (file)

Function: valid-watch-flag-p X

Package

cl-inotify

Source

inotify.lisp (file)

6.2.3 Structures

Structure: inotify-event ()

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.

Package

cl-inotify

Source

inotify.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: wd

Initform

0

Readers

inotify-event-wd (function)

Writers

(setf inotify-event-wd) (function)

Slot: mask

Initform

0

Readers

inotify-event-mask (function)

Writers

(setf inotify-event-mask) (function)

Slot: cookie

Initform

0

Readers

inotify-event-cookie (function)

Writers

(setf inotify-event-cookie) (function)

Slot: name

Readers

inotify-event-name (function)

Writers

(setf inotify-event-name) (function)

Structure: inotify-instance ()

Contains the stream and file descriptor for a inotify instance.

Package

cl-inotify

Source

inotify.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

registered-inotify-instance (structure)

Direct slots

Slot: fd

Readers

inotify-fd (function)

Writers

(setf inotify-fd) (function)

Slot: stream

Readers

inotify-stream (function)

Writers

(setf inotify-stream) (function)

Slot: nonblocking

Readers

inotify-nonblocking (function)

Writers

(setf inotify-nonblocking) (function)

Structure: registered-inotify-instance ()

Additionally to the information in INOTIFY-INSTANCE, records watched paths in a dictionary.

Package

cl-inotify

Source

inotify.lisp (file)

Direct superclasses

inotify-instance (structure)

Direct slots

Slot: pathnames

Readers

inotify-pathnames (function)

Writers

(setf inotify-pathnames) (function)

Slot: handles

Readers

inotify-handles (function)

Writers

(setf inotify-handles) (function)

6.2.4 Types

Type: int ()

Package

cl-inotify

Source

inotify.lisp (file)

Type: watch-flag-list ()

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).

Package

cl-inotify

Source

inotify.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types