The cl-rrd Reference Manual

This is the cl-rrd Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:36:52 2022 GMT+0.

Table of Contents


1 Systems

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


1.1 cl-rrd

A Common Lisp interface to the RRDTool graphing system.

Author

Harry Bock <>

Long Description
Version

0.1

Dependency

cffi (system).

Source

cl-rrd.asd.

Child Components

2 Files

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


2.1 Lisp


2.1.1 cl-rrd/cl-rrd.asd

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

ASDF Systems

cl-rrd.

Packages

cl-rrd-asd.

Public Interface

*cl-rrd-version* (special variable).


2.1.2 cl-rrd/packages.lisp

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Packages

cl-rrd.


2.1.3 cl-rrd/specials.lisp

Dependency

packages.lisp (file).

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Internals

2.1.4 cl-rrd/utility.lisp

Dependency

specials.lisp (file).

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Internals

2.1.5 cl-rrd/librrd-ffi.lisp

Dependency

utility.lisp (file).

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Public Interface
Internals

2.1.6 cl-rrd/rpn.lisp

Dependency

librrd-ffi.lisp (file).

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Public Interface

compile-rpn (function).

Internals

2.1.7 cl-rrd/cl-rrd.lisp

Dependency

rpn.lisp (file).

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Public Interface
Internals

2.1.8 cl-rrd/graph.lisp

Dependency

cl-rrd.lisp (file).

Source

cl-rrd.asd.

Parent Component

cl-rrd (system).

Public Interface

generate-graph (macro).

Internals

3 Packages

Packages are listed by definition order.


3.1 cl-rrd-asd

Source

cl-rrd.asd.

Use List
  • asdf/interface.
  • common-lisp.
Public Interface

*cl-rrd-version* (special variable).


3.2 cl-rrd

Source

packages.lisp.

Nickname

rrd

Use List

common-lisp.

Public Interface
Internals

4 Definitions

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


4.1 Public Interface


4.1.1 Special variables

Special Variable: *cl-rrd-version*
Package

cl-rrd-asd.

Source

cl-rrd.asd.


4.1.2 Macros

Macro: generate-graph (filename (&rest options) graph-definitions)
Package

cl-rrd.

Source

graph.lisp.

Macro: with-database (name (filename &key start step if-does-not-exist if-exists) spec-list &body body)
Package

cl-rrd.

Source

cl-rrd.lisp.


4.1.3 Ordinary functions

Function: compile-rpn (expression)

Create an RPN string from the given Lisp-like RPN expression.

Package

cl-rrd.

Source

rpn.lisp.

Function: rrd-call (cfun parameters &optional &key debug)

Call a standard RRD library function with specified parameters. For use with RRD functions that take argc/argv type parameters only.

Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: rrd-call-graph (parameters)

Call the rrd_graph library function.

Package

cl-rrd.

Source

librrd-ffi.lisp.


4.1.4 Generic functions

Generic Function: create (rrd)
Package

cl-rrd.

Methods
Method: create ((rrd database))
Source

cl-rrd.lisp.

Generic Function: update (rrd update-list &key template)
Package

cl-rrd.

Methods
Method: update ((rrd database) update-list &key template)
Source

cl-rrd.lisp.


4.1.5 Classes

Class: database
Package

cl-rrd.

Source

cl-rrd.lisp.

Direct methods
Direct slots
Slot: file
Initform

#p""

Initargs

:file

Readers

rrd-file.

Writers

(setf rrd-file).

Slot: start
Initform

0

Initargs

:start

Readers

rrd-start.

Writers

(setf rrd-start).

Slot: step
Package

common-lisp.

Initargs

:step

Readers

rrd-step.

Writers

(setf rrd-step).

Slot: data-sources
Initargs

:data-sources

Readers

rrd-data-sources.

Writers

(setf rrd-data-sources).

Slot: archives
Initargs

:archives

Readers

rrd-archives.

Writers

(setf rrd-archives).


4.2 Internals


4.2.1 Constants

Constant: +unix-epoch+
Package

cl-rrd.

Source

specials.lisp.


4.2.2 Special variables

Special Variable: *rpn-operator-map*

Hash table holding RPN operators and their respective arity.

Package

cl-rrd.

Source

specials.lisp.

Special Variable: *rpn-special-value-list*

Hash table holding special RPN values.

Package

cl-rrd.

Source

specials.lisp.


4.2.3 Macros

Macro: def-rpn-operators (operator-list arity)
Package

cl-rrd.

Source

specials.lisp.

Macro: def-rpn-special-values (special-list)
Package

cl-rrd.

Source

specials.lisp.

Macro: without-fp-traps (&body body)
Package

cl-rrd.

Source

librrd-ffi.lisp.


4.2.4 Ordinary functions

Function: %rrd-clear-error ()
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-create (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-dump (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-fetch (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-get-error ()
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-graph (argc argv printout width height stream ymin ymax)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-test-error ()
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: %rrd-update (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: cdef-string (name rpn)
Package

cl-rrd.

Source

graph.lisp.

Function: def-string (defname rrdfile ds-name cf &key step start end reduce)
Package

cl-rrd.

Source

graph.lisp.

Function: ds-string (name type &rest dst-spec)

Create a string used by RRD to define a data source (DS).

Package

cl-rrd.

Source

cl-rrd.lisp.

Function: escape (string)

Escape a string suitable for legend and time arguments to rrdtool commands.

Package

cl-rrd.

Source

graph.lisp.

Function: flatten (tree)
Package

cl-rrd.

Source

utility.lisp.

Function: foreign-alloc-list (list)

Take a list of strings and allocate an array of C-style strings.

Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: parse-graph-options (&rest arguments)
Package

cl-rrd.

Source

graph.lisp.

Function: parse-rpn (expression)
Package

cl-rrd.

Source

rpn.lisp.

Function: rra-string (consolidation-function &key xff steps rows)
Package

cl-rrd.

Source

cl-rrd.lisp.

Function: rrd-last (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: rrd-resize (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: rrd-restore (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: rrd-tune (argc argv)
Package

cl-rrd.

Source

librrd-ffi.lisp.

Function: strcat (&rest strings)
Package

cl-rrd.

Source

utility.lisp.

Function: to-string (value)
Package

cl-rrd.

Source

utility.lisp.

Function: to-variable-name (name)
Package

cl-rrd.

Source

rpn.lisp.

Function: unix-time (&optional time)
Package

cl-rrd.

Source

utility.lisp.

Function: update-template-string (template-list)
Package

cl-rrd.

Source

cl-rrd.lisp.

Function: update-value-string (update-spec)
Package

cl-rrd.

Source

cl-rrd.lisp.

Function: valid-rpn-operator (operator arity)

Returns true if operator is a defined RPN operator with the specified arity.

Package

cl-rrd.

Source

rpn.lisp.

Function: valid-rpn-special (special)
Package

cl-rrd.

Source

rpn.lisp.

Function: valid-variable-name (name)
Package

cl-rrd.

Source

rpn.lisp.

Function: vdef-string (name rpn)
Package

cl-rrd.

Source

graph.lisp.


4.2.5 Generic functions

Generic Reader: rrd-archives (object)
Package

cl-rrd.

Methods
Reader Method: rrd-archives ((database database))

automatically generated reader method

Source

cl-rrd.lisp.

Target Slot

archives.

Generic Writer: (setf rrd-archives) (object)
Package

cl-rrd.

Methods
Writer Method: (setf rrd-archives) ((database database))

automatically generated writer method

Source

cl-rrd.lisp.

Target Slot

archives.

Generic Reader: rrd-data-sources (object)
Package

cl-rrd.

Methods
Reader Method: rrd-data-sources ((database database))

automatically generated reader method

Source

cl-rrd.lisp.

Target Slot

data-sources.

Generic Writer: (setf rrd-data-sources) (object)
Package

cl-rrd.

Methods
Writer Method: (setf rrd-data-sources) ((database database))

automatically generated writer method

Source

cl-rrd.lisp.

Target Slot

data-sources.

Generic Reader: rrd-file (object)
Package

cl-rrd.

Methods
Reader Method: rrd-file ((database database))

automatically generated reader method

Source

cl-rrd.lisp.

Target Slot

file.

Generic Writer: (setf rrd-file) (object)
Package

cl-rrd.

Methods
Writer Method: (setf rrd-file) ((database database))

automatically generated writer method

Source

cl-rrd.lisp.

Target Slot

file.

Generic Reader: rrd-start (object)
Package

cl-rrd.

Methods
Reader Method: rrd-start ((database database))

automatically generated reader method

Source

cl-rrd.lisp.

Target Slot

start.

Generic Writer: (setf rrd-start) (object)
Package

cl-rrd.

Methods
Writer Method: (setf rrd-start) ((database database))

automatically generated writer method

Source

cl-rrd.lisp.

Target Slot

start.

Generic Reader: rrd-step (object)
Package

cl-rrd.

Methods
Reader Method: rrd-step ((database database))

automatically generated reader method

Source

cl-rrd.lisp.

Target Slot

step.

Generic Writer: (setf rrd-step) (object)
Package

cl-rrd.

Methods
Writer Method: (setf rrd-step) ((database database))

automatically generated writer method

Source

cl-rrd.lisp.

Target Slot

step.


4.2.6 Classes

Class: archive
Package

cl-rrd.

Source

cl-rrd.lisp.

Direct slots
Slot: cf-name
Initargs

:cf-name

Slot: xff
Initargs

:xff

Slot: steps
Initargs

:steps

Slot: rows
Initargs

:rows


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   E   F   G   M   P   R   S   T   U   V   W  
Index Entry  Section

%
%rrd-clear-error: Private ordinary functions
%rrd-create: Private ordinary functions
%rrd-dump: Private ordinary functions
%rrd-fetch: Private ordinary functions
%rrd-get-error: Private ordinary functions
%rrd-graph: Private ordinary functions
%rrd-test-error: Private ordinary functions
%rrd-update: Private ordinary functions

(
(setf rrd-archives): Private generic functions
(setf rrd-archives): Private generic functions
(setf rrd-data-sources): Private generic functions
(setf rrd-data-sources): Private generic functions
(setf rrd-file): Private generic functions
(setf rrd-file): Private generic functions
(setf rrd-start): Private generic functions
(setf rrd-start): Private generic functions
(setf rrd-step): Private generic functions
(setf rrd-step): Private generic functions

C
cdef-string: Private ordinary functions
compile-rpn: Public ordinary functions
create: Public generic functions
create: Public generic functions

D
def-rpn-operators: Private macros
def-rpn-special-values: Private macros
def-string: Private ordinary functions
ds-string: Private ordinary functions

E
escape: Private ordinary functions

F
flatten: Private ordinary functions
foreign-alloc-list: Private ordinary functions
Function, %rrd-clear-error: Private ordinary functions
Function, %rrd-create: Private ordinary functions
Function, %rrd-dump: Private ordinary functions
Function, %rrd-fetch: Private ordinary functions
Function, %rrd-get-error: Private ordinary functions
Function, %rrd-graph: Private ordinary functions
Function, %rrd-test-error: Private ordinary functions
Function, %rrd-update: Private ordinary functions
Function, cdef-string: Private ordinary functions
Function, compile-rpn: Public ordinary functions
Function, def-string: Private ordinary functions
Function, ds-string: Private ordinary functions
Function, escape: Private ordinary functions
Function, flatten: Private ordinary functions
Function, foreign-alloc-list: Private ordinary functions
Function, parse-graph-options: Private ordinary functions
Function, parse-rpn: Private ordinary functions
Function, rra-string: Private ordinary functions
Function, rrd-call: Public ordinary functions
Function, rrd-call-graph: Public ordinary functions
Function, rrd-last: Private ordinary functions
Function, rrd-resize: Private ordinary functions
Function, rrd-restore: Private ordinary functions
Function, rrd-tune: Private ordinary functions
Function, strcat: Private ordinary functions
Function, to-string: Private ordinary functions
Function, to-variable-name: Private ordinary functions
Function, unix-time: Private ordinary functions
Function, update-template-string: Private ordinary functions
Function, update-value-string: Private ordinary functions
Function, valid-rpn-operator: Private ordinary functions
Function, valid-rpn-special: Private ordinary functions
Function, valid-variable-name: Private ordinary functions
Function, vdef-string: Private ordinary functions

G
generate-graph: Public macros
Generic Function, (setf rrd-archives): Private generic functions
Generic Function, (setf rrd-data-sources): Private generic functions
Generic Function, (setf rrd-file): Private generic functions
Generic Function, (setf rrd-start): Private generic functions
Generic Function, (setf rrd-step): Private generic functions
Generic Function, create: Public generic functions
Generic Function, rrd-archives: Private generic functions
Generic Function, rrd-data-sources: Private generic functions
Generic Function, rrd-file: Private generic functions
Generic Function, rrd-start: Private generic functions
Generic Function, rrd-step: Private generic functions
Generic Function, update: Public generic functions

M
Macro, def-rpn-operators: Private macros
Macro, def-rpn-special-values: Private macros
Macro, generate-graph: Public macros
Macro, with-database: Public macros
Macro, without-fp-traps: Private macros
Method, (setf rrd-archives): Private generic functions
Method, (setf rrd-data-sources): Private generic functions
Method, (setf rrd-file): Private generic functions
Method, (setf rrd-start): Private generic functions
Method, (setf rrd-step): Private generic functions
Method, create: Public generic functions
Method, rrd-archives: Private generic functions
Method, rrd-data-sources: Private generic functions
Method, rrd-file: Private generic functions
Method, rrd-start: Private generic functions
Method, rrd-step: Private generic functions
Method, update: Public generic functions

P
parse-graph-options: Private ordinary functions
parse-rpn: Private ordinary functions

R
rra-string: Private ordinary functions
rrd-archives: Private generic functions
rrd-archives: Private generic functions
rrd-call: Public ordinary functions
rrd-call-graph: Public ordinary functions
rrd-data-sources: Private generic functions
rrd-data-sources: Private generic functions
rrd-file: Private generic functions
rrd-file: Private generic functions
rrd-last: Private ordinary functions
rrd-resize: Private ordinary functions
rrd-restore: Private ordinary functions
rrd-start: Private generic functions
rrd-start: Private generic functions
rrd-step: Private generic functions
rrd-step: Private generic functions
rrd-tune: Private ordinary functions

S
strcat: Private ordinary functions

T
to-string: Private ordinary functions
to-variable-name: Private ordinary functions

U
unix-time: Private ordinary functions
update: Public generic functions
update: Public generic functions
update-template-string: Private ordinary functions
update-value-string: Private ordinary functions

V
valid-rpn-operator: Private ordinary functions
valid-rpn-special: Private ordinary functions
valid-variable-name: Private ordinary functions
vdef-string: Private ordinary functions

W
with-database: Public macros
without-fp-traps: Private macros