This is the cl-fam Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:10:51 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-famWraps libfam (File access monitor) API. Needs gamin-devel or fam-devel package
Max Mikhanosha <max@openchat.com>
Apache
1.0
cffi-grovel (system).
cffi (system).
cffi-grovel (system).
trivial-garbage (system).
package.lisp (file).
fam-grovel.lisp (file).
cl-fam.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-fam/fam-grovel.lisppackage.lisp (file).
cl-fam (system).
cl-fam/cl-fam.lispfam-grovel.lisp (file).
cl-fam (system).
*fam* (special variable).
fam-cancel-monitor (function).
fam-close (function).
fam-code (reader method).
fam-connection (reader method).
fam-connection (reader method).
fam-connection (class).
fam-fd (function).
fam-filename (reader method).
fam-filename (reader method).
fam-hostname (reader method).
fam-init (function).
fam-monitor-directory (function).
fam-monitor-file (function).
fam-next-event (function).
fam-open (function).
fam-open-p (function).
fam-pending-p (function).
fam-request (reader method).
fam-request (class).
fam-request-number (reader method).
fam-requests (function).
fam-status (reader method).
%fam-cancel-monitor (function).
%fam-close (function).
%fam-errno (symbol macro).
%fam-monitor-directory (function).
%fam-monitor-file (function).
%fam-next-event (function).
%fam-open-2 (function).
%fam-pending (function).
%fam-resume-monitor (function).
%fam-suspend-monitor (function).
%var-accessor-%fam-errno (function).
(setf %var-accessor-%fam-errno) (function).
check-connection (function).
fam-directory-request (class).
fam-event (class).
fam-file-request (class).
fam-monitor-any (function).
fam-resume-monitor (function).
fam-suspend-monitor (function).
translate-fam-code (function).
Packages are listed by definition order.
cl-famcffi.
common-lisp.
trivial-garbage.
*fam* (special variable).
fam-cancel-monitor (function).
fam-close (function).
fam-code (generic reader).
fam-connection (generic reader).
fam-connection (class).
fam-fd (function).
fam-filename (generic reader).
fam-hostname (generic reader).
fam-init (function).
fam-monitor-directory (function).
fam-monitor-file (function).
fam-next-event (function).
fam-open (function).
fam-open-p (function).
fam-pending-p (function).
fam-request (generic reader).
fam-request (class).
fam-request-number (generic reader).
fam-requests (function).
fam-status (generic reader).
%fam-cancel-monitor (function).
%fam-close (function).
%fam-errno (symbol macro).
%fam-monitor-directory (function).
%fam-monitor-file (function).
%fam-next-event (function).
%fam-open-2 (function).
%fam-pending (function).
%fam-resume-monitor (function).
%fam-suspend-monitor (function).
%var-accessor-%fam-errno (function).
(setf %var-accessor-%fam-errno) (function).
check-connection (function).
fam-directory-request (class).
fam-event (class).
fam-file-request (class).
fam-monitor-any (function).
fam-resume-monitor (function).
fam-suspend-monitor (function).
translate-fam-code (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Cancel monitoring request.
Close the FAM connection
Return FAM file handle
Open default FAM connection if its not already opened, same as (FAM-OPEN app-name T)
Monitor directory for changes. Returns FAM-DIRECTORY-REQUEST
object, which can be used to cancel or suspend the request. The same
request object will be returned as a slot of FAM-NEXT-EVENT.
In case the directory is already being monitored, return the existing
request rather then starting a new one, unless FORCE-DUP is also
specified.
The second returned value will be T if new request was created
Monitor file for changes. Returns FAM-FILE-REQUEST object, which
can be used to cancel or suspend the request. The same request object
will be returned as a slot of FAM-NEXT-EVENT.
In case the directory is already being monitored, return the existing
request rather then starting a new one, unless FORCE-DUP is also
specified.
The second returned value will be T if new request was created
Return queued FAM event from the specified connection, if no events
are pending will wait for one. By default the event is returned as an
instance of FAM-EVENT class.
The FAM-CODE is translated into the keyword,
With USE-VALUES flag returns event code, filename and FAM-REQUEST object as three values.
Optionally open new FAM connection and return it.
With REUSE flag return default connection if its open, or create a new
connection and make it default. Default connection is stored in *FAM*
special variable.
Without REUSE flag, unconditionally create new connection, and return it without storing it in *FAM*.
Return T if connection is open
Return number of events pending on FAM connection or NIL if none are.
Return all the active requests for the connection
fam-event)) ¶automatically generated reader method
fam-request)) ¶automatically generated reader method
fam-event)) ¶automatically generated reader method
fam-request)) ¶automatically generated reader method
fam-request)) ¶automatically generated reader method
fam-request)) ¶automatically generated reader method
Stores information about FAM connection. If garbage collected then C level FAM connection will be automatically closed
Base class for FAM request
:request-number
This slot is read-only.
:filename
This slot is read-only.
cl-fam:fam-connection
:connection
This slot is read-only.
This slot is read-only.
Throw error unless connection is non-NIL and open
Common code for FAM-MONITOR-DIRECTORY and FAM-MONITOR-FILE
Resume monitoring request.
Suspend monitoring request.
Return FAM keyword for code
FAM request to monitor a directory
Contains information about FAM event, is returned by FAM-NEXT-EVENT
:hostname
This slot is read-only.
:filename
This slot is read-only.
cl-fam:fam-request
:request
This slot is read-only.
cl-fam:fam-connection
:connection
This slot is read-only.
FAM request to monitor a file
| Jump to: | %
(
C F G M T |
|---|
| Jump to: | %
(
C F G M T |
|---|
| Jump to: | %
*
C F H R S |
|---|
| Jump to: | %
*
C F H R S |
|---|
| Jump to: | C F P S |
|---|
| Jump to: | C F P S |
|---|