The eventfd Reference Manual

This is the eventfd Reference Manual, version 0.3, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:44:49 2018 GMT+0.

1 Introduction

eventfd() creates an "eventfd object" that can be used as an event wait/notify mechanism by user-space applications, and by the kernel to notify user-space applications of events. The object contains an unsigned 64-bit integer (uint64_t) counter that is maintained by the kernel. This counter is initialized with the value specified in the argument initval.

2 Systems

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

2.1 `eventfd`

Maintainer

Ilya Khaprov <ilya.khaprov@publitechs.com>

Author

Ilya Khaprov <ilya.khaprov@publitechs.com>

License

MIT

Description

IOLib based eventfd bindings

Version

0.3

Dependencies

iolib
alexandria

Source

eventfd.asd (file)

Components

src/package.lisp (file)
src/grovel.lisp (file)
src/eventfd.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `eventfd.asd`

Location: eventfd.asd
Systems: eventfd (system)
Packages: eventfd-system

3.1.2 `eventfd/src/package.lisp`

Parent: eventfd (system)
Location: src/package.lisp
Packages: eventfd

3.1.3 `eventfd/src/grovel.lisp`

Dependency: src/package.lisp (file)
Parent: eventfd (system)
Location: src/grovel.lisp

3.1.4 `eventfd/src/eventfd.lisp`

Dependency

src/grovel.lisp (file)

Parent

eventfd (system)

Location

src/eventfd.lisp

Exported Definitions

eventfd.close (function)
eventfd.new (function)
eventfd.notify (function)
eventfd.notify-1 (function)
eventfd.read (function)

Internal Definitions

+1-octets+ (constant)
eventfd (function)
eventfd.notify% (function)
int64-to-octet (function)
octet-to-uint64 (function)
to-val (function)

4 Packages

Packages are listed by definition order.

4.1 `eventfd-system`

Source

eventfd.asd

Use List

asdf/interface
common-lisp

4.2 `eventfd`

Source

src/package.lisp (file)

Use List

common-lisp

Exported Definitions

eventfd.close (function)
eventfd.new (function)
eventfd.notify (function)
eventfd.notify-1 (function)
eventfd.read (function)

Internal Definitions

+1-octets+ (constant)
+efd-cloexec+ (constant)
+efd-nonblock+ (constant)
+efd-semaphore+ (constant)
eventfd (function)
eventfd.notify% (function)
int64-to-octet (function)
octet-to-uint64 (function)
to-val (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: eventfd.close FD

Package: eventfd
Source: src/eventfd.lisp (file)

Function: eventfd.new INITVAL &key CLOEXEC NONBLOCK SEMAPHORE

Package: eventfd
Source: src/eventfd.lisp (file)

Function: eventfd.notify FD VAL

Package: eventfd
Source: src/eventfd.lisp (file)

Function: eventfd.notify-1 FD

Package: eventfd
Source: src/eventfd.lisp (file)

Function: eventfd.read FD

Returns number of notifications or zero

Package: eventfd
Source: src/eventfd.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +1-octets+

Package: eventfd
Source: src/eventfd.lisp (file)

Constant: +efd-cloexec+

Package: eventfd
Source: /home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/eventfd-20171130-git/src/grovel.processed-grovel-file

Constant: +efd-nonblock+

Package: eventfd
Source: /home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/eventfd-20171130-git/src/grovel.processed-grovel-file

Constant: +efd-semaphore+

Package: eventfd
Source: /home/quickref/.cache/common-lisp/sbcl-1.4.0-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/eventfd-20171130-git/src/grovel.processed-grovel-file

5.2.2 Functions

Function: eventfd INITVAL FLAGS

Create a file descriptor for event notification

Package: eventfd
Source: src/eventfd.lisp (file)

Function: eventfd.notify% FD BYTES

Package: eventfd
Source: src/eventfd.lisp (file)

Function: int64-to-octet VAL

Package: eventfd
Source: src/eventfd.lisp (file)

Function: octet-to-uint64 VEC

Package: eventfd
Source: src/eventfd.lisp (file)

Function: to-val VEC SIZE

Package: eventfd
Source: src/eventfd.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	E F L

	Index Entry	Section

E
	`eventfd.asd`:	The eventfd<dot>asd file
	`eventfd/src/eventfd.lisp`:	The eventfd/src/eventfd<dot>lisp file
	`eventfd/src/grovel.lisp`:	The eventfd/src/grovel<dot>lisp file
	`eventfd/src/package.lisp`:	The eventfd/src/package<dot>lisp file

F
	File, Lisp, `eventfd.asd`:	The eventfd<dot>asd file
	File, Lisp, `eventfd/src/eventfd.lisp`:	The eventfd/src/eventfd<dot>lisp file
	File, Lisp, `eventfd/src/grovel.lisp`:	The eventfd/src/grovel<dot>lisp file
	File, Lisp, `eventfd/src/package.lisp`:	The eventfd/src/package<dot>lisp file

L
	Lisp File, `eventfd.asd`:	The eventfd<dot>asd file
	Lisp File, `eventfd/src/eventfd.lisp`:	The eventfd/src/eventfd<dot>lisp file
	Lisp File, `eventfd/src/grovel.lisp`:	The eventfd/src/grovel<dot>lisp file
	Lisp File, `eventfd/src/package.lisp`:	The eventfd/src/package<dot>lisp file

Jump to:	E F L

A.2 Functions

Jump to:	E F I O T

	Index Entry	Section

E
	`eventfd`:	Internal functions
	`eventfd.close`:	Exported functions
	`eventfd.new`:	Exported functions
	`eventfd.notify`:	Exported functions
	`eventfd.notify%`:	Internal functions
	`eventfd.notify-1`:	Exported functions
	`eventfd.read`:	Exported functions

F
	`Function, eventfd`:	Internal functions
	`Function, eventfd.close`:	Exported functions
	`Function, eventfd.new`:	Exported functions
	`Function, eventfd.notify`:	Exported functions
	`Function, eventfd.notify%`:	Internal functions
	`Function, eventfd.notify-1`:	Exported functions
	`Function, eventfd.read`:	Exported functions
	`Function, int64-to-octet`:	Internal functions
	`Function, octet-to-uint64`:	Internal functions
	`Function, to-val`:	Internal functions

I
	`int64-to-octet`:	Internal functions

O
	`octet-to-uint64`:	Internal functions

T
	`to-val`:	Internal functions

Jump to:	E F I O T

A.3 Variables

Jump to:	+ C

	Index Entry	Section

+
	`+1-octets+`:	Internal constants
	`+efd-cloexec+`:	Internal constants
	`+efd-nonblock+`:	Internal constants
	`+efd-semaphore+`:	Internal constants

C
	`Constant, +1-octets+`:	Internal constants
	`Constant, +efd-cloexec+`:	Internal constants
	`Constant, +efd-nonblock+`:	Internal constants
	`Constant, +efd-semaphore+`:	Internal constants

Jump to:	+ C

A.4 Data types

Jump to:	E P S

	Index Entry	Section

E
	`eventfd`:	The eventfd system
	`eventfd`:	The eventfd package
	`eventfd-system`:	The eventfd-system package

P
	`Package, eventfd`:	The eventfd package
	`Package, eventfd-system`:	The eventfd-system package

S
	`System, eventfd`:	The eventfd system

Jump to:	E P S

• Introduction:		What eventfd is all about
• Systems:		The systems documentation
• Files:		The files documentation
• Packages:		The packages documentation
• Definitions:		The symbols documentation
• Indexes:		Concepts, functions, variables and data types

• The eventfd.asd file:
• The eventfd/src/package.lisp file:
• The eventfd/src/grovel.lisp file:
• The eventfd/src/eventfd.lisp file:

• Concept index:
• Function index:
• Variable index:
• Data type index:

The eventfd Reference Manual

Table of Contents

The eventfd Reference Manual

1 Introduction

2 Systems

2.1 eventfd

3 Files

3.1 Lisp

3.1.1 eventfd.asd

3.1.2 eventfd/src/package.lisp

3.1.3 eventfd/src/grovel.lisp

3.1.4 eventfd/src/eventfd.lisp

4 Packages

4.1 eventfd-system

4.2 eventfd

5 Definitions

5.1 Exported definitions

5.1.1 Functions

5.2 Internal definitions

5.2.1 Constants

5.2.2 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `eventfd`

3.1.1 `eventfd.asd`

3.1.2 `eventfd/src/package.lisp`

3.1.3 `eventfd/src/grovel.lisp`

3.1.4 `eventfd/src/eventfd.lisp`

4.1 `eventfd-system`

4.2 `eventfd`