The inotify Reference Manual

This is the inotify Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:44:31 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 inotify

Interface to linux inotify(7)

Author

Stas Boukarev

License

Public Domain

Dependencies
  • cffi (system).
  • iolib (system).
Source

inotify.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 inotify/inotify.asd

Source

inotify.asd.

Parent Component

inotify (system).

ASDF Systems

inotify.


3.1.2 inotify/packages.lisp

Source

inotify.asd.

Parent Component

inotify (system).

Packages

inotify.


3.1.3 inotify/grovel.lisp

Dependency

packages.lisp (file).

Source

inotify.asd.

Parent Component

inotify (system).


3.1.4 inotify/inotify.lisp

Dependency

grovel.lisp (file).

Source

inotify.asd.

Parent Component

inotify (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 inotify

Source

packages.lisp.

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: with-inotify ((name paths-with-masks) &body body)
Package

inotify.

Source

inotify.lisp.


5.1.2 Ordinary functions

Function: add-watch (inotify pathname mask)
Package

inotify.

Source

inotify.lisp.

Function: close-inotify (inotify)
Package

inotify.

Source

inotify.lisp.

Reader: event-cookie (instance)
Writer: (setf event-cookie) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

cookie.

Function: event-full-name (event)
Package

inotify.

Source

inotify.lisp.

Reader: event-mask (instance)
Writer: (setf event-mask) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

mask.

Reader: event-name (instance)
Writer: (setf event-name) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

name.

Reader: event-watch (instance)
Writer: (setf event-watch) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

watch.

Reader: inotify-watches (instance)
Writer: (setf inotify-watches) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

watches.

Function: make-inotify (&optional buffer-count)
Package

inotify.

Source

inotify.lisp.

Function: mask-to-names (mask)
Package

inotify.

Source

inotify.lisp.

Function: read-events (inotify &key time-out)
Package

inotify.

Source

inotify.lisp.

Reader: watch-inotify (instance)
Writer: (setf watch-inotify) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

inotify.

Reader: watch-mask (instance)
Writer: (setf watch-mask) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

mask.

Reader: watch-pathname (instance)
Writer: (setf watch-pathname) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

pathname.


5.1.3 Generic functions

Generic Function: find-watch (inotify id)
Package

inotify.

Source

inotify.lisp.

Methods
Method: find-watch (inotify (pathname string))
Method: find-watch (inotify (pathname pathname))
Method: find-watch (inotify (id integer))
Generic Function: remove-watch (intofy watch)
Package

inotify.

Source

inotify.lisp.

Methods
Method: remove-watch (inotify (watch watch))
Method: remove-watch (inotify id)

5.1.4 Standalone methods

Method: print-object ((event event) stream)
Source

inotify.lisp.

Method: print-object ((watch watch) stream)
Source

inotify.lisp.


5.1.5 Structures

Structure: event
Package

inotify.

Source

inotify.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: watch
Readers

event-watch.

Writers

(setf event-watch).

Slot: mask
Readers

event-mask.

Writers

(setf event-mask).

Readers

event-cookie.

Writers

(setf event-cookie).

Slot: name
Readers

event-name.

Writers

(setf event-name).

Structure: inotify
Package

inotify.

Source

inotify.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: fd
Readers

inotify-fd.

Writers

(setf inotify-fd).

Slot: buffer-size
Readers

inotify-buffer-size.

Writers

(setf inotify-buffer-size).

Slot: buffer
Readers

inotify-buffer.

Writers

(setf inotify-buffer).

Slot: watches
Readers

inotify-watches.

Writers

(setf inotify-watches).

Structure: watch
Package

inotify.

Source

inotify.lisp.

Direct superclasses

structure-object.

Direct methods
Direct slots
Slot: id
Readers

watch-id.

Writers

(setf watch-id).

Slot: inotify
Readers

watch-inotify.

Writers

(setf watch-inotify).

Slot: pathname
Package

common-lisp.

Readers

watch-pathname.

Writers

(setf watch-pathname).

Slot: mask
Readers

watch-mask.

Writers

(setf watch-mask).


5.2 Internals


5.2.1 Special variables

Special Variable: *masks*
Package

inotify.

Source

inotify.lisp.


5.2.2 Ordinary functions

Function: %make-inotify (&key fd buffer-size buffer watches)
Package

inotify.

Source

inotify.lisp.

Function: copy-event (instance)
Package

inotify.

Source

inotify.lisp.

Function: copy-inotify (instance)
Package

inotify.

Source

inotify.lisp.

Function: copy-watch (instance)
Package

inotify.

Source

inotify.lisp.

Function: event-p (object)
Package

inotify.

Source

inotify.lisp.

Function: inotify-add-watch (fd path flags)
Package

inotify.

Source

inotify.lisp.

Reader: inotify-buffer (instance)
Writer: (setf inotify-buffer) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

buffer.

Reader: inotify-buffer-size (instance)
Writer: (setf inotify-buffer-size) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

buffer-size.

Reader: inotify-fd (instance)
Writer: (setf inotify-fd) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

fd.

Function: inotify-init ()
Package

inotify.

Source

inotify.lisp.

Function: inotify-p (object)
Package

inotify.

Source

inotify.lisp.

Function: inotify-rm-watch (fd watch-descriptor)
Package

inotify.

Source

inotify.lisp.

Function: make-event (&key watch mask cookie name)
Package

inotify.

Source

inotify.lisp.

Function: make-inotify-with-watches (paths-with-masks)
Package

inotify.

Source

inotify.lisp.

Function: make-watch (&key id inotify pathname mask)
Package

inotify.

Source

inotify.lisp.

Function: parse-event-name (event)
Package

inotify.

Source

inotify.lisp.

Function: read-event (inotify buffer)
Package

inotify.

Source

inotify.lisp.

Reader: watch-id (instance)
Writer: (setf watch-id) (instance)
Package

inotify.

Source

inotify.lisp.

Target Slot

id.

Function: watch-p (object)
Package

inotify.

Source

inotify.lisp.


5.2.3 Classes

Class: inotify-event-tclass
Package

inotify.

Source

inotify.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   E   F   G   I   M   P   R   W  
Index Entry  Section

%
%make-inotify: Private ordinary functions

(
(setf event-cookie): Public ordinary functions
(setf event-mask): Public ordinary functions
(setf event-name): Public ordinary functions
(setf event-watch): Public ordinary functions
(setf inotify-buffer): Private ordinary functions
(setf inotify-buffer-size): Private ordinary functions
(setf inotify-fd): Private ordinary functions
(setf inotify-watches): Public ordinary functions
(setf watch-id): Private ordinary functions
(setf watch-inotify): Public ordinary functions
(setf watch-mask): Public ordinary functions
(setf watch-pathname): Public ordinary functions

A
add-watch: Public ordinary functions

C
close-inotify: Public ordinary functions
copy-event: Private ordinary functions
copy-inotify: Private ordinary functions
copy-watch: Private ordinary functions

E
event-cookie: Public ordinary functions
event-full-name: Public ordinary functions
event-mask: Public ordinary functions
event-name: Public ordinary functions
event-p: Private ordinary functions
event-watch: Public ordinary functions

F
find-watch: Public generic functions
find-watch: Public generic functions
find-watch: Public generic functions
find-watch: Public generic functions
Function, %make-inotify: Private ordinary functions
Function, (setf event-cookie): Public ordinary functions
Function, (setf event-mask): Public ordinary functions
Function, (setf event-name): Public ordinary functions
Function, (setf event-watch): Public ordinary functions
Function, (setf inotify-buffer): Private ordinary functions
Function, (setf inotify-buffer-size): Private ordinary functions
Function, (setf inotify-fd): Private ordinary functions
Function, (setf inotify-watches): Public ordinary functions
Function, (setf watch-id): Private ordinary functions
Function, (setf watch-inotify): Public ordinary functions
Function, (setf watch-mask): Public ordinary functions
Function, (setf watch-pathname): Public ordinary functions
Function, add-watch: Public ordinary functions
Function, close-inotify: Public ordinary functions
Function, copy-event: Private ordinary functions
Function, copy-inotify: Private ordinary functions
Function, copy-watch: Private ordinary functions
Function, event-cookie: Public ordinary functions
Function, event-full-name: Public ordinary functions
Function, event-mask: Public ordinary functions
Function, event-name: Public ordinary functions
Function, event-p: Private ordinary functions
Function, event-watch: Public ordinary functions
Function, inotify-add-watch: Private ordinary functions
Function, inotify-buffer: Private ordinary functions
Function, inotify-buffer-size: Private ordinary functions
Function, inotify-fd: Private ordinary functions
Function, inotify-init: Private ordinary functions
Function, inotify-p: Private ordinary functions
Function, inotify-rm-watch: Private ordinary functions
Function, inotify-watches: Public ordinary functions
Function, make-event: Private ordinary functions
Function, make-inotify: Public ordinary functions
Function, make-inotify-with-watches: Private ordinary functions
Function, make-watch: Private ordinary functions
Function, mask-to-names: Public ordinary functions
Function, parse-event-name: Private ordinary functions
Function, read-event: Private ordinary functions
Function, read-events: Public ordinary functions
Function, watch-id: Private ordinary functions
Function, watch-inotify: Public ordinary functions
Function, watch-mask: Public ordinary functions
Function, watch-p: Private ordinary functions
Function, watch-pathname: Public ordinary functions

G
Generic Function, find-watch: Public generic functions
Generic Function, remove-watch: Public generic functions

I
inotify-add-watch: Private ordinary functions
inotify-buffer: Private ordinary functions
inotify-buffer-size: Private ordinary functions
inotify-fd: Private ordinary functions
inotify-init: Private ordinary functions
inotify-p: Private ordinary functions
inotify-rm-watch: Private ordinary functions
inotify-watches: Public ordinary functions

M
Macro, with-inotify: Public macros
make-event: Private ordinary functions
make-inotify: Public ordinary functions
make-inotify-with-watches: Private ordinary functions
make-watch: Private ordinary functions
mask-to-names: Public ordinary functions
Method, find-watch: Public generic functions
Method, find-watch: Public generic functions
Method, find-watch: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, remove-watch: Public generic functions
Method, remove-watch: Public generic functions

P
parse-event-name: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods

R
read-event: Private ordinary functions
read-events: Public ordinary functions
remove-watch: Public generic functions
remove-watch: Public generic functions
remove-watch: Public generic functions

W
watch-id: Private ordinary functions
watch-inotify: Public ordinary functions
watch-mask: Public ordinary functions
watch-p: Private ordinary functions
watch-pathname: Public ordinary functions
with-inotify: Public macros