The eventfd Reference Manual

This is the eventfd Reference Manual, version 0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 04:30:08 2022 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.

eventfd

2.1 `eventfd`

IOLib based eventfd bindings

Maintainer

Ilya Khaprov <ilya.khaprov@publitechs.com>

Author

Ilya Khaprov <ilya.khaprov@publitechs.com>

License

MIT

Version

0.3

Dependencies

iolib (system).
alexandria (system).

Source

eventfd.asd.

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

Lisp

3.1.1 `eventfd/eventfd.asd`

Source: eventfd.asd.
Parent Component: eventfd (system).
ASDF Systems: eventfd.
Packages: eventfd-system.

3.1.2 `eventfd/src/package.lisp`

Source: eventfd.asd.
Parent Component: eventfd (system).
Packages: eventfd.

3.1.3 `eventfd/src/grovel.lisp`

Dependency: src/package.lisp (file).
Source: eventfd.asd.
Parent Component: eventfd (system).

3.1.4 `eventfd/src/eventfd.lisp`

Dependency

src/grovel.lisp (file).

Source

eventfd.asd.

Parent Component

eventfd (system).

Public Interface

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

Internals

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

eventfd-system
eventfd

4.1 `eventfd-system`

Source

eventfd.asd.

Use List

asdf/interface.
common-lisp.

4.2 `eventfd`

Source

src/package.lisp.

Use List

common-lisp.

Public Interface

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

Internals

+1-octets+ (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.

Public Interface
Internals

5.1 Public Interface

Ordinary functions

5.1.1 Ordinary functions

Function: eventfd.close (fd) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: eventfd.new (initval &key cloexec nonblock semaphore) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: eventfd.notify (fd val) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: eventfd.notify-1 (fd) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: eventfd.read (fd) ¶

Returns number of notifications or zero

Package: eventfd.
Source: src/eventfd.lisp.

5.2 Internals

Constants
Ordinary functions

5.2.1 Constants

Constant: +1-octets+ ¶

Package: eventfd.
Source: src/eventfd.lisp.

5.2.2 Ordinary functions

Function: eventfd (initval flags) ¶

Create a file descriptor for event notification

Package: eventfd.
Source: src/eventfd.lisp.

Function: eventfd.notify% (fd bytes) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: int64-to-octet (val) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: octet-to-uint64 (vec) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Function: to-val (vec size) ¶

Package: eventfd.
Source: src/eventfd.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	E F I O T

	Index Entry	Section

E
	`eventfd`:	Private ordinary functions
	`eventfd.close`:	Public ordinary functions
	`eventfd.new`:	Public ordinary functions
	`eventfd.notify`:	Public ordinary functions
	`eventfd.notify%`:	Private ordinary functions
	`eventfd.notify-1`:	Public ordinary functions
	`eventfd.read`:	Public ordinary functions

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

I
	`int64-to-octet`:	Private ordinary functions

O
	`octet-to-uint64`:	Private ordinary functions

T
	`to-val`:	Private ordinary functions

Jump to:	E F I O T

A.3 Variables

Jump to:	+ C

	Index Entry	Section

+
	`+1-octets+`:	Private constants

C
	`Constant, +1-octets+`:	Private constants

Jump to:	+ C

A.4 Data types

Jump to:	E F P S

	Index Entry	Section

E
	`eventfd`:	The eventfd system
	`eventfd`:	The eventfd package
	`eventfd-system`:	The eventfd-system package
	`eventfd.asd`:	The eventfd/eventfd․asd file

F
	`File, eventfd.asd`:	The eventfd/eventfd․asd file
	`File, src/eventfd.lisp`:	The eventfd/src/eventfd․lisp file
	`File, src/grovel.lisp`:	The eventfd/src/grovel․lisp file
	`File, src/package.lisp`:	The eventfd/src/package․lisp file

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

S
	`src/eventfd.lisp`:	The eventfd/src/eventfd․lisp file
	`src/grovel.lisp`:	The eventfd/src/grovel․lisp file
	`src/package.lisp`:	The eventfd/src/package․lisp file
	`System, eventfd`:	The eventfd system

Jump to:	E F P S

The eventfd Reference Manual

The eventfd Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 eventfd

3 Files

3.1 Lisp

3.1.1 eventfd/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 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Constants

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `eventfd`

3.1.1 `eventfd/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`