The cl-rlimit Reference Manual

This is the cl-rlimit Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:37:47 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-rlimit

Simple interface to Unix getrlimit and setrlimit.

Author

Masataro Asai

Contact

License

LLGPL

Defsystem Dependency

cffi-grovel (system).

Dependency

cffi (system).

Source

cl-rlimit.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-rlimit/src

Source

cl-rlimit.asd.

Parent Component

cl-rlimit (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 cl-rlimit/cl-rlimit.asd

Source

cl-rlimit.asd.

Parent Component

cl-rlimit (system).

ASDF Systems

cl-rlimit.


4.1.2 cl-rlimit/src/packages.lisp

Source

cl-rlimit.asd.

Parent Component

src (module).

Packages

cl-rlimit.


4.1.3 cl-rlimit/src/grovel.lisp

Dependency

packages.lisp (file).

Source

cl-rlimit.asd.

Parent Component

src (module).


4.1.4 cl-rlimit/src/rlimit.lisp

Dependency

grovel.lisp (file).

Source

cl-rlimit.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 cl-rlimit/src/rusage.lisp

Dependency

rlimit.lisp (file).

Source

cl-rlimit.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-rlimit

Source

packages.lisp.

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

6 Definitions

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


6.1 Public Interface


6.1.1 Setf expanders

Setf Expander: (setf rlimit) (resource)
Package

cl-rlimit.

Source

rlimit.lisp.

Reader

rlimit (function).

Writer

set-rlimit (function).


6.1.2 Ordinary functions

Function: rlimit (resource)
Package

cl-rlimit.

Source

rlimit.lisp.

Setf expander for this function

(setf rlimit).

Function: rusage (&optional who)
Package

cl-rlimit.

Source

rusage.lisp.

Reader: rusage-idrss (instance)
Writer: (setf rusage-idrss) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

idrss.

Reader: rusage-inblock (instance)
Writer: (setf rusage-inblock) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

inblock.

Reader: rusage-isrss (instance)
Writer: (setf rusage-isrss) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

isrss.

Reader: rusage-ixrss (instance)
Writer: (setf rusage-ixrss) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

ixrss.

Reader: rusage-majflt (instance)
Writer: (setf rusage-majflt) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

majflt.

Reader: rusage-maxrss (instance)
Writer: (setf rusage-maxrss) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

maxrss.

Reader: rusage-minflt (instance)
Writer: (setf rusage-minflt) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

minflt.

Reader: rusage-msgrcv (instance)
Writer: (setf rusage-msgrcv) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

msgrcv.

Reader: rusage-msgsnd (instance)
Writer: (setf rusage-msgsnd) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

msgsnd.

Reader: rusage-nivcsw (instance)
Writer: (setf rusage-nivcsw) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

nivcsw.

Reader: rusage-nsignals (instance)
Writer: (setf rusage-nsignals) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

nsignals.

Reader: rusage-nswap (instance)
Writer: (setf rusage-nswap) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

nswap.

Reader: rusage-nvcsw (instance)
Writer: (setf rusage-nvcsw) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

nvcsw.

Reader: rusage-oublock (instance)
Writer: (setf rusage-oublock) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

oublock.

Reader: rusage-stime (instance)
Writer: (setf rusage-stime) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

stime.

Reader: rusage-utime (instance)
Writer: (setf rusage-utime) (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Target Slot

utime.


6.1.3 Structures

Structure: rusage
Package

cl-rlimit.

Source

rusage.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: utime
Type

integer

Initform

0

Readers

rusage-utime.

Writers

(setf rusage-utime).

Slot: stime
Type

integer

Initform

0

Readers

rusage-stime.

Writers

(setf rusage-stime).

Slot: maxrss
Type

integer

Initform

0

Readers

rusage-maxrss.

Writers

(setf rusage-maxrss).

Slot: ixrss
Type

integer

Initform

0

Readers

rusage-ixrss.

Writers

(setf rusage-ixrss).

Slot: idrss
Type

integer

Initform

0

Readers

rusage-idrss.

Writers

(setf rusage-idrss).

Slot: isrss
Type

integer

Initform

0

Readers

rusage-isrss.

Writers

(setf rusage-isrss).

Slot: minflt
Type

integer

Initform

0

Readers

rusage-minflt.

Writers

(setf rusage-minflt).

Slot: majflt
Type

integer

Initform

0

Readers

rusage-majflt.

Writers

(setf rusage-majflt).

Slot: nswap
Type

integer

Initform

0

Readers

rusage-nswap.

Writers

(setf rusage-nswap).

Slot: inblock
Type

integer

Initform

0

Readers

rusage-inblock.

Writers

(setf rusage-inblock).

Slot: oublock
Type

integer

Initform

0

Readers

rusage-oublock.

Writers

(setf rusage-oublock).

Slot: msgsnd
Type

integer

Initform

0

Readers

rusage-msgsnd.

Writers

(setf rusage-msgsnd).

Slot: msgrcv
Type

integer

Initform

0

Readers

rusage-msgrcv.

Writers

(setf rusage-msgrcv).

Slot: nsignals
Type

integer

Initform

0

Readers

rusage-nsignals.

Writers

(setf rusage-nsignals).

Slot: nvcsw
Type

integer

Initform

0

Readers

rusage-nvcsw.

Writers

(setf rusage-nvcsw).

Slot: nivcsw
Type

integer

Initform

0

Readers

rusage-nivcsw.

Writers

(setf rusage-nivcsw).


6.2 Internals


6.2.1 Ordinary functions

Function: %getrlimit (resource rlimit)
Package

cl-rlimit.

Source

rlimit.lisp.

Function: %getrusage (who rusage)
Package

cl-rlimit.

Source

rusage.lisp.

Function: %setrlimit (resource rlimit)
Package

cl-rlimit.

Source

rlimit.lisp.

Function: copy-rusage (instance)
Package

cl-rlimit.

Source

rusage.lisp.

Function: make-rusage (&key utime stime maxrss ixrss idrss isrss minflt majflt nswap inblock oublock msgsnd msgrcv nsignals nvcsw nivcsw)
Package

cl-rlimit.

Source

rusage.lisp.

Function: rusage-p (object)
Package

cl-rlimit.

Source

rusage.lisp.

Function: set-rlimit (resource size)
Package

cl-rlimit.

Source

rlimit.lisp.

Setf expanders to this function

(setf rlimit).

Function: timeval->microsec (timeval)
Package

cl-rlimit.

Source

rusage.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   F   M   R   S   T  
Index Entry  Section

%
%getrlimit: Private ordinary functions
%getrusage: Private ordinary functions
%setrlimit: Private ordinary functions

(
(setf rlimit): Public setf expanders
(setf rusage-idrss): Public ordinary functions
(setf rusage-inblock): Public ordinary functions
(setf rusage-isrss): Public ordinary functions
(setf rusage-ixrss): Public ordinary functions
(setf rusage-majflt): Public ordinary functions
(setf rusage-maxrss): Public ordinary functions
(setf rusage-minflt): Public ordinary functions
(setf rusage-msgrcv): Public ordinary functions
(setf rusage-msgsnd): Public ordinary functions
(setf rusage-nivcsw): Public ordinary functions
(setf rusage-nsignals): Public ordinary functions
(setf rusage-nswap): Public ordinary functions
(setf rusage-nvcsw): Public ordinary functions
(setf rusage-oublock): Public ordinary functions
(setf rusage-stime): Public ordinary functions
(setf rusage-utime): Public ordinary functions

C
copy-rusage: Private ordinary functions

F
Function, %getrlimit: Private ordinary functions
Function, %getrusage: Private ordinary functions
Function, %setrlimit: Private ordinary functions
Function, (setf rusage-idrss): Public ordinary functions
Function, (setf rusage-inblock): Public ordinary functions
Function, (setf rusage-isrss): Public ordinary functions
Function, (setf rusage-ixrss): Public ordinary functions
Function, (setf rusage-majflt): Public ordinary functions
Function, (setf rusage-maxrss): Public ordinary functions
Function, (setf rusage-minflt): Public ordinary functions
Function, (setf rusage-msgrcv): Public ordinary functions
Function, (setf rusage-msgsnd): Public ordinary functions
Function, (setf rusage-nivcsw): Public ordinary functions
Function, (setf rusage-nsignals): Public ordinary functions
Function, (setf rusage-nswap): Public ordinary functions
Function, (setf rusage-nvcsw): Public ordinary functions
Function, (setf rusage-oublock): Public ordinary functions
Function, (setf rusage-stime): Public ordinary functions
Function, (setf rusage-utime): Public ordinary functions
Function, copy-rusage: Private ordinary functions
Function, make-rusage: Private ordinary functions
Function, rlimit: Public ordinary functions
Function, rusage: Public ordinary functions
Function, rusage-idrss: Public ordinary functions
Function, rusage-inblock: Public ordinary functions
Function, rusage-isrss: Public ordinary functions
Function, rusage-ixrss: Public ordinary functions
Function, rusage-majflt: Public ordinary functions
Function, rusage-maxrss: Public ordinary functions
Function, rusage-minflt: Public ordinary functions
Function, rusage-msgrcv: Public ordinary functions
Function, rusage-msgsnd: Public ordinary functions
Function, rusage-nivcsw: Public ordinary functions
Function, rusage-nsignals: Public ordinary functions
Function, rusage-nswap: Public ordinary functions
Function, rusage-nvcsw: Public ordinary functions
Function, rusage-oublock: Public ordinary functions
Function, rusage-p: Private ordinary functions
Function, rusage-stime: Public ordinary functions
Function, rusage-utime: Public ordinary functions
Function, set-rlimit: Private ordinary functions
Function, timeval->microsec: Private ordinary functions

M
make-rusage: Private ordinary functions

R
rlimit: Public ordinary functions
rusage: Public ordinary functions
rusage-idrss: Public ordinary functions
rusage-inblock: Public ordinary functions
rusage-isrss: Public ordinary functions
rusage-ixrss: Public ordinary functions
rusage-majflt: Public ordinary functions
rusage-maxrss: Public ordinary functions
rusage-minflt: Public ordinary functions
rusage-msgrcv: Public ordinary functions
rusage-msgsnd: Public ordinary functions
rusage-nivcsw: Public ordinary functions
rusage-nsignals: Public ordinary functions
rusage-nswap: Public ordinary functions
rusage-nvcsw: Public ordinary functions
rusage-oublock: Public ordinary functions
rusage-p: Private ordinary functions
rusage-stime: Public ordinary functions
rusage-utime: Public ordinary functions

S
set-rlimit: Private ordinary functions
Setf Expander, (setf rlimit): Public setf expanders

T
timeval->microsec: Private ordinary functions