Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The file-lock Reference Manual

This is the file-lock Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:24:54 2024 GMT+0.

Next: Systems, Previous: The file-lock Reference Manual, Up: The file-lock Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The file-lock Reference Manual [Contents][Index]

2 Systems

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

file-lock

Previous: Systems, Up: Systems [Contents][Index]

2.1 `file-lock`

File lock library on POSIX systems

Author

Arnold Noronha <arnold@screenshotbot.io>

License

MIT License

Version

0.0.1

Dependencies

cffi (system)., for feature (:not :lispworks)
easy-macros (system).
log4cl (system).

Source

file-lock.asd.

Child Component

file-lock.lisp (file).

Next: Packages, Previous: Systems, Up: The file-lock Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: file-lock/file-lock.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `file-lock/file-lock.asd`

Source: file-lock.asd.
Parent Component: file-lock (system).
ASDF Systems: file-lock.

Previous: file-lock/file-lock.asd, Up: Lisp [Contents][Index]

3.1.2 `file-lock/file-lock.lisp`

Source

file-lock.asd.

Parent Component

file-lock (system).

Packages

util/file-lock.

Public Interface

file-lock (class).
initialize-instance (method).
make-file-lock (function).
release-file-lock (method).
release-file-lock (method).
with-file-lock (macro).

Internals

acquire-file-lock (method).
acquire-file-lock (method).
call-with-file-lock (function).
could-not-get-lock (condition).
ensure-stream (method).
file-handle (method).
file-lock-stream (reader method).
(setf file-lock-stream) (writer method).
filename (reader method).
flock (function).
get-unix-error (function).
lock-ex (constant).
lock-nb (constant).
lock-not-held (condition).
lock-sh (constant).
lock-un (constant).
noop-file-lock (class).

Next: Definitions, Previous: Files, Up: The file-lock Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

util/file-lock

Previous: Packages, Up: Packages [Contents][Index]

4.1 `util/file-lock`

Source

file-lock.lisp.

Nickname

file-lock

Use List

common-lisp.

Public Interface

file-lock (class).
make-file-lock (function).
release-file-lock (generic function).
with-file-lock (macro).

Internals

acquire-file-lock (generic function).
call-with-file-lock (function).
could-not-get-lock (condition).
ensure-stream (generic function).
file-handle (generic function).
file-lock-stream (generic reader).
(setf file-lock-stream) (generic writer).
filename (generic reader).
flock (function).
get-unix-error (function).
lock-ex (constant).
lock-nb (constant).
lock-not-held (condition).
lock-sh (constant).
lock-un (constant).
noop-file-lock (class).

Next: Indexes, Previous: Packages, Up: The file-lock Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Standalone methods
Classes

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: with-file-lock ((&rest fn-arg-values) &body macro-body) ¶

Package: util/file-lock.
Source: file-lock.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: make-file-lock (&rest args &key file &allow-other-keys) ¶

Package: util/file-lock.
Source: file-lock.lisp.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Function: release-file-lock (self) ¶

Package

util/file-lock.

Methods

Method: release-file-lock ((self noop-file-lock)) ¶

Source: file-lock.lisp.

Method: release-file-lock ((self file-lock)) ¶

Source: file-lock.lisp.

Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.4 Standalone methods

Method: initialize-instance :after ((self file-lock) &key file sharedp acquire timeout) ¶

Source: file-lock.lisp.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.5 Classes

Class: file-lock ¶

Package

util/file-lock.

Source

file-lock.lisp.

Direct methods

acquire-file-lock.
ensure-stream.
file-handle.
(setf file-lock-stream).
file-lock-stream.
filename.
initialize-instance.
release-file-lock.

Direct slots

Slot: file ¶

Initargs: :file
Readers: filename.
Writers: This slot is read-only.

Slot: stream ¶

Package: common-lisp.
Readers: file-lock-stream.
Writers: (setf file-lock-stream).

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Constants
Ordinary functions
Generic functions
Conditions
Classes

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Constants

Constant: lock-ex ¶

Exclusive lock.

Package: util/file-lock.
Source: file-lock.lisp.

Constant: lock-nb ¶

Don’t block when locking.

Package: util/file-lock.
Source: file-lock.lisp.

Constant: lock-sh ¶

Shared lock.

Package: util/file-lock.
Source: file-lock.lisp.

Constant: lock-un ¶

Unlock.

Package: util/file-lock.
Source: file-lock.lisp.

Next: Generic functions, Previous: Constants, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: call-with-file-lock (fn &key file) ¶

Package: util/file-lock.
Source: file-lock.lisp.

Function: flock (fd operation) ¶

Package: util/file-lock.
Source: file-lock.lisp.

Function: get-unix-error () ¶

Package: util/file-lock.
Source: file-lock.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.3 Generic functions

Generic Function: acquire-file-lock (self &key sharedp timeout &allow-other-keys) ¶

Package

util/file-lock.

Methods

Method: acquire-file-lock ((self noop-file-lock) &key &allow-other-keys) ¶

Source: file-lock.lisp.

Method: acquire-file-lock ((self file-lock) &key sharedp timeout) ¶

Source: file-lock.lisp.

Generic Function: ensure-stream (self) ¶

Package

util/file-lock.

Methods

Method: ensure-stream ((self file-lock)) ¶

Source: file-lock.lisp.

Generic Function: file-handle (self) ¶

Package

util/file-lock.

Methods

Method: file-handle ((self file-lock)) ¶

Source: file-lock.lisp.

Generic Reader: file-lock-stream (object) ¶

Package

util/file-lock.

Methods

Reader Method: file-lock-stream ((file-lock file-lock)) ¶

automatically generated reader method

Source: file-lock.lisp.
Target Slot: stream.

Generic Writer: (setf file-lock-stream) (object) ¶

Package

util/file-lock.

Methods

Writer Method: (setf file-lock-stream) ((file-lock file-lock)) ¶

automatically generated writer method

Source: file-lock.lisp.
Target Slot: stream.

Generic Reader: filename (object) ¶

Package

util/file-lock.

Methods

Reader Method: filename ((file-lock file-lock)) ¶

automatically generated reader method

Source: file-lock.lisp.
Target Slot: file.

Next: Classes, Previous: Generic functions, Up: Internals [Contents][Index]

5.2.4 Conditions

Condition: could-not-get-lock ¶

Package: util/file-lock.
Source: file-lock.lisp.
Direct superclasses: error.

Condition: lock-not-held ¶

Package: util/file-lock.
Source: file-lock.lisp.
Direct superclasses: error.

Previous: Conditions, Up: Internals [Contents][Index]

5.2.5 Classes

Class: noop-file-lock ¶

Package

util/file-lock.

Source

file-lock.lisp.

Direct methods

acquire-file-lock.
release-file-lock.

Direct slots

Slot: file ¶

Initargs: :file

Previous: Definitions, Up: The file-lock Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	( A C E F G I M R W

	Index Entry	Section

(
	`(setf file-lock-stream)`:	Private generic functions
	`(setf file-lock-stream)`:	Private generic functions

A
	`acquire-file-lock`:	Private generic functions
	`acquire-file-lock`:	Private generic functions
	`acquire-file-lock`:	Private generic functions

C
	`call-with-file-lock`:	Private ordinary functions

E
	`ensure-stream`:	Private generic functions
	`ensure-stream`:	Private generic functions

F
	`file-handle`:	Private generic functions
	`file-handle`:	Private generic functions
	`file-lock-stream`:	Private generic functions
	`file-lock-stream`:	Private generic functions
	`filename`:	Private generic functions
	`filename`:	Private generic functions
	`flock`:	Private ordinary functions
	`Function, call-with-file-lock`:	Private ordinary functions
	`Function, flock`:	Private ordinary functions
	`Function, get-unix-error`:	Private ordinary functions
	`Function, make-file-lock`:	Public ordinary functions

G
	`Generic Function, (setf file-lock-stream)`:	Private generic functions
	`Generic Function, acquire-file-lock`:	Private generic functions
	`Generic Function, ensure-stream`:	Private generic functions
	`Generic Function, file-handle`:	Private generic functions
	`Generic Function, file-lock-stream`:	Private generic functions
	`Generic Function, filename`:	Private generic functions
	`Generic Function, release-file-lock`:	Public generic functions
	`get-unix-error`:	Private ordinary functions

I
	`initialize-instance`:	Public standalone methods

M
	`Macro, with-file-lock`:	Public macros
	`make-file-lock`:	Public ordinary functions
	`Method, (setf file-lock-stream)`:	Private generic functions
	`Method, acquire-file-lock`:	Private generic functions
	`Method, acquire-file-lock`:	Private generic functions
	`Method, ensure-stream`:	Private generic functions
	`Method, file-handle`:	Private generic functions
	`Method, file-lock-stream`:	Private generic functions
	`Method, filename`:	Private generic functions
	`Method, initialize-instance`:	Public standalone methods
	`Method, release-file-lock`:	Public generic functions
	`Method, release-file-lock`:	Public generic functions

R
	`release-file-lock`:	Public generic functions
	`release-file-lock`:	Public generic functions
	`release-file-lock`:	Public generic functions

W
	`with-file-lock`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	C F L S

	Index Entry	Section

C
	`Constant, lock-ex`:	Private constants
	`Constant, lock-nb`:	Private constants
	`Constant, lock-sh`:	Private constants
	`Constant, lock-un`:	Private constants

F
	`file`:	Public classes
	`file`:	Private classes

L
	`lock-ex`:	Private constants
	`lock-nb`:	Private constants
	`lock-sh`:	Private constants
	`lock-un`:	Private constants

S
	`Slot, file`:	Public classes
	`Slot, file`:	Private classes
	`Slot, stream`:	Public classes
	`stream`:	Public classes

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F L N P S U

	Index Entry	Section

C
	`Class, file-lock`:	Public classes
	`Class, noop-file-lock`:	Private classes
	`Condition, could-not-get-lock`:	Private conditions
	`Condition, lock-not-held`:	Private conditions
	`could-not-get-lock`:	Private conditions

F
	`File, file-lock.asd`:	The file-lock/file-lock․asd file
	`File, file-lock.lisp`:	The file-lock/file-lock․lisp file
	`file-lock`:	The file-lock system
	`file-lock`:	Public classes
	`file-lock.asd`:	The file-lock/file-lock․asd file
	`file-lock.lisp`:	The file-lock/file-lock․lisp file

L
	`lock-not-held`:	Private conditions

N
	`noop-file-lock`:	Private classes

P
	`Package, util/file-lock`:	The util/file-lock package

S
	`System, file-lock`:	The file-lock system

U
	`util/file-lock`:	The util/file-lock package

The file-lock Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 file-lock

3 Files

3.1 Lisp

3.1.1 file-lock/file-lock.asd

3.1.2 file-lock/file-lock.lisp

4 Packages

4.1 util/file-lock

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Standalone methods

5.1.5 Classes

5.2 Internals

5.2.1 Constants

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Conditions

5.2.5 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `file-lock`

3.1.1 `file-lock/file-lock.asd`

3.1.2 `file-lock/file-lock.lisp`

4.1 `util/file-lock`