The cl-rrd Reference Manual

Table of Contents

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

The cl-rrd Reference Manual

This is the cl-rrd Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:16:16 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


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

1.1 cl-rrd

Author

Harry Bock <harry@oshean.org>

Description

A Common Lisp interface to the RRDTool graphing system.

Long Description
Version

0.1

Dependency

cffi

Source

cl-rrd.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


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

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 cl-rrd.asd

Location

cl-rrd.asd

Systems

cl-rrd (system)

Packages

cl-rrd-asd

Exported Definitions

*cl-rrd-version* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 cl-rrd/packages.lisp

Parent

cl-rrd (system)

Location

packages.lisp

Packages

cl-rrd


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 cl-rrd/specials.lisp

Dependency

packages.lisp (file)

Parent

cl-rrd (system)

Location

specials.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.4 cl-rrd/utility.lisp

Dependency

specials.lisp (file)

Parent

cl-rrd (system)

Location

utility.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.5 cl-rrd/librrd-ffi.lisp

Dependency

utility.lisp (file)

Parent

cl-rrd (system)

Location

librrd-ffi.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.6 cl-rrd/rpn.lisp

Dependency

librrd-ffi.lisp (file)

Parent

cl-rrd (system)

Location

rpn.lisp

Exported Definitions

compile-rpn (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.7 cl-rrd/cl-rrd.lisp

Dependency

rpn.lisp (file)

Parent

cl-rrd (system)

Location

cl-rrd.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

2.1.8 cl-rrd/graph.lisp

Dependency

cl-rrd.lisp (file)

Parent

cl-rrd (system)

Location

graph.lisp

Exported Definitions

generate-graph (macro)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


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

3.1 cl-rrd-asd

Source

cl-rrd.asd

Use List
Exported Definitions

*cl-rrd-version* (special variable)


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

3.2 cl-rrd

Source

packages.lisp (file)

Nickname

rrd

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


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

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Special variables

Special Variable: *cl-rrd-version*
Package

cl-rrd-asd

Source

cl-rrd.asd


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Macros

Macro: generate-graph FILENAME (&rest OPTIONS) GRAPH-DEFINITIONS
Package

cl-rrd

Source

graph.lisp (file)

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Functions

Function: compile-rpn EXPRESSION

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

Package

cl-rrd

Source

rpn.lisp (file)

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 (file)

Function: rrd-call-graph PARAMETERS

Call the rrd_graph library function.

Package

cl-rrd

Source

librrd-ffi.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.4 Generic functions

Generic Function: create RRD
Package

cl-rrd

Methods
Method: create (RRD database)
Source

cl-rrd.lisp (file)

Generic Function: update RRD UPDATE-LIST &key TEMPLATE
Package

cl-rrd

Methods
Method: update (RRD database) UPDATE-LIST &key TEMPLATE
Source

cl-rrd.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.5 Classes

Class: database ()
Package

cl-rrd

Source

cl-rrd.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: file
Initargs

:file

Initform

#p""

Readers

rrd-file (generic function)

Writers

(setf rrd-file) (generic function)

Slot: start
Initargs

:start

Initform

0

Readers

rrd-start (generic function)

Writers

(setf rrd-start) (generic function)

Slot: step
Initargs

:step

Readers

rrd-step (generic function)

Writers

(setf rrd-step) (generic function)

Slot: data-sources
Initargs

:data-sources

Readers

rrd-data-sources (generic function)

Writers

(setf rrd-data-sources) (generic function)

Slot: archives
Initargs

:archives

Readers

rrd-archives (generic function)

Writers

(setf rrd-archives) (generic function)


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

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Constants

Constant: +unix-epoch+
Package

cl-rrd

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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 (file)

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

Hash table holding special RPN values.

Package

cl-rrd

Source

specials.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Macros

Macro: def-rpn-operators OPERATOR-LIST ARITY
Package

cl-rrd

Source

specials.lisp (file)

Macro: def-rpn-special-values SPECIAL-LIST
Package

cl-rrd

Source

specials.lisp (file)

Macro: without-fp-traps &body BODY
Package

cl-rrd

Source

librrd-ffi.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Functions

Function: %rrd-clear-error ()
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-create ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-dump ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-fetch ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-get-error ()
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-graph ARGC ARGV PRINTOUT WIDTH HEIGHT STREAM YMIN YMAX
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-test-error ()
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: %rrd-update ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: cdef-string NAME RPN
Package

cl-rrd

Source

graph.lisp (file)

Function: def-string DEFNAME RRDFILE DS-NAME CF &key STEP START END REDUCE
Package

cl-rrd

Source

graph.lisp (file)

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 (file)

Function: escape STRING

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

Package

cl-rrd

Source

graph.lisp (file)

Function: flatten TREE
Package

cl-rrd

Source

utility.lisp (file)

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 (file)

Function: parse-graph-options &rest ARGUMENTS
Package

cl-rrd

Source

graph.lisp (file)

Function: parse-rpn EXPRESSION
Package

cl-rrd

Source

rpn.lisp (file)

Function: rra-string CONSOLIDATION-FUNCTION &key XFF STEPS ROWS
Package

cl-rrd

Source

cl-rrd.lisp (file)

Function: rrd-last ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: rrd-resize ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: rrd-restore ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: rrd-tune ARGC ARGV
Package

cl-rrd

Source

librrd-ffi.lisp (file)

Function: strcat &rest STRINGS
Package

cl-rrd

Source

utility.lisp (file)

Function: to-string VALUE
Package

cl-rrd

Source

utility.lisp (file)

Function: to-variable-name NAME
Package

cl-rrd

Source

rpn.lisp (file)

Function: unix-time &optional TIME
Package

cl-rrd

Source

utility.lisp (file)

Function: update-template-string TEMPLATE-LIST
Package

cl-rrd

Source

cl-rrd.lisp (file)

Function: update-value-string UPDATE-SPEC
Package

cl-rrd

Source

cl-rrd.lisp (file)

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 (file)

Function: valid-rpn-special SPECIAL
Package

cl-rrd

Source

rpn.lisp (file)

Function: valid-variable-name NAME
Package

cl-rrd

Source

rpn.lisp (file)

Function: vdef-string NAME RPN
Package

cl-rrd

Source

graph.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.5 Generic functions

Generic Function: rrd-archives OBJECT
Generic Function: (setf rrd-archives) NEW-VALUE OBJECT
Package

cl-rrd

Methods
Method: rrd-archives (DATABASE database)

automatically generated reader method

Source

cl-rrd.lisp (file)

Method: (setf rrd-archives) NEW-VALUE (DATABASE database)

automatically generated writer method

Source

cl-rrd.lisp (file)

Generic Function: rrd-data-sources OBJECT
Generic Function: (setf rrd-data-sources) NEW-VALUE OBJECT
Package

cl-rrd

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

automatically generated reader method

Source

cl-rrd.lisp (file)

Method: (setf rrd-data-sources) NEW-VALUE (DATABASE database)

automatically generated writer method

Source

cl-rrd.lisp (file)

Generic Function: rrd-file OBJECT
Generic Function: (setf rrd-file) NEW-VALUE OBJECT
Package

cl-rrd

Methods
Method: rrd-file (DATABASE database)

automatically generated reader method

Source

cl-rrd.lisp (file)

Method: (setf rrd-file) NEW-VALUE (DATABASE database)

automatically generated writer method

Source

cl-rrd.lisp (file)

Generic Function: rrd-start OBJECT
Generic Function: (setf rrd-start) NEW-VALUE OBJECT
Package

cl-rrd

Methods
Method: rrd-start (DATABASE database)

automatically generated reader method

Source

cl-rrd.lisp (file)

Method: (setf rrd-start) NEW-VALUE (DATABASE database)

automatically generated writer method

Source

cl-rrd.lisp (file)

Generic Function: rrd-step OBJECT
Generic Function: (setf rrd-step) NEW-VALUE OBJECT
Package

cl-rrd

Methods
Method: rrd-step (DATABASE database)

automatically generated reader method

Source

cl-rrd.lisp (file)

Method: (setf rrd-step) NEW-VALUE (DATABASE database)

automatically generated writer method

Source

cl-rrd.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.6 Classes

Class: archive ()
Package

cl-rrd

Source

cl-rrd.lisp (file)

Direct superclasses

standard-object (class)

Direct slots
Slot: cf-name
Initargs

:cf-name

Slot: xff
Initargs

:xff

Slot: steps
Initargs

:steps

Slot: rows
Initargs

:rows


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-rrd.asd: The cl-rrd<dot>asd file
cl-rrd/cl-rrd.lisp: The cl-rrd/cl-rrd<dot>lisp file
cl-rrd/graph.lisp: The cl-rrd/graph<dot>lisp file
cl-rrd/librrd-ffi.lisp: The cl-rrd/librrd-ffi<dot>lisp file
cl-rrd/packages.lisp: The cl-rrd/packages<dot>lisp file
cl-rrd/rpn.lisp: The cl-rrd/rpn<dot>lisp file
cl-rrd/specials.lisp: The cl-rrd/specials<dot>lisp file
cl-rrd/utility.lisp: The cl-rrd/utility<dot>lisp file

F
File, Lisp, cl-rrd.asd: The cl-rrd<dot>asd file
File, Lisp, cl-rrd/cl-rrd.lisp: The cl-rrd/cl-rrd<dot>lisp file
File, Lisp, cl-rrd/graph.lisp: The cl-rrd/graph<dot>lisp file
File, Lisp, cl-rrd/librrd-ffi.lisp: The cl-rrd/librrd-ffi<dot>lisp file
File, Lisp, cl-rrd/packages.lisp: The cl-rrd/packages<dot>lisp file
File, Lisp, cl-rrd/rpn.lisp: The cl-rrd/rpn<dot>lisp file
File, Lisp, cl-rrd/specials.lisp: The cl-rrd/specials<dot>lisp file
File, Lisp, cl-rrd/utility.lisp: The cl-rrd/utility<dot>lisp file

L
Lisp File, cl-rrd.asd: The cl-rrd<dot>asd file
Lisp File, cl-rrd/cl-rrd.lisp: The cl-rrd/cl-rrd<dot>lisp file
Lisp File, cl-rrd/graph.lisp: The cl-rrd/graph<dot>lisp file
Lisp File, cl-rrd/librrd-ffi.lisp: The cl-rrd/librrd-ffi<dot>lisp file
Lisp File, cl-rrd/packages.lisp: The cl-rrd/packages<dot>lisp file
Lisp File, cl-rrd/rpn.lisp: The cl-rrd/rpn<dot>lisp file
Lisp File, cl-rrd/specials.lisp: The cl-rrd/specials<dot>lisp file
Lisp File, cl-rrd/utility.lisp: The cl-rrd/utility<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

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

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

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

C
cdef-string: Internal functions
compile-rpn: Exported functions
create: Exported generic functions
create: Exported generic functions

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

E
escape: Internal functions

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

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

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

P
parse-graph-options: Internal functions
parse-rpn: Internal functions

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

S
strcat: Internal functions

T
to-string: Internal functions
to-variable-name: Internal functions

U
unix-time: Internal functions
update: Exported generic functions
update: Exported generic functions
update-template-string: Internal functions
update-value-string: Internal functions

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

W
with-database: Exported macros
without-fp-traps: Internal macros

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

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

A.3 Variables

Jump to:   *   +  
A   C   D   F   R   S   X  
Index Entry  Section

*
*cl-rrd-version*: Exported special variables
*rpn-operator-map*: Internal special variables
*rpn-special-value-list*: Internal special variables

+
+unix-epoch+: Internal constants

A
archives: Exported classes

C
cf-name: Internal classes
Constant, +unix-epoch+: Internal constants

D
data-sources: Exported classes

F
file: Exported classes

R
rows: Internal classes

S
Slot, archives: Exported classes
Slot, cf-name: Internal classes
Slot, data-sources: Exported classes
Slot, file: Exported classes
Slot, rows: Internal classes
Slot, start: Exported classes
Slot, step: Exported classes
Slot, steps: Internal classes
Slot, xff: Internal classes
Special Variable, *cl-rrd-version*: Exported special variables
Special Variable, *rpn-operator-map*: Internal special variables
Special Variable, *rpn-special-value-list*: Internal special variables
start: Exported classes
step: Exported classes
steps: Internal classes

X
xff: Internal classes

Jump to:   *   +  
A   C   D   F   R   S   X  

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

A.4 Data types

Jump to:   A   C   D   P   S  
Index Entry  Section

A
archive: Internal classes

C
cl-rrd: The cl-rrd system
cl-rrd: The cl-rrd package
cl-rrd-asd: The cl-rrd-asd package
Class, archive: Internal classes
Class, database: Exported classes

D
database: Exported classes

P
Package, cl-rrd: The cl-rrd package
Package, cl-rrd-asd: The cl-rrd-asd package

S
System, cl-rrd: The cl-rrd system

Jump to:   A   C   D   P   S