The cl-rrd Reference Manual

Table of Contents

The cl-rrd Reference Manual

This is the cl-rrd Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:32:07 2020 GMT+0.

1 Systems

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

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

• packages.lisp (file)
• specials.lisp (file)
• utility.lisp (file)
• librrd-ffi.lisp (file)
• rpn.lisp (file)
• cl-rrd.lisp (file)
• graph.lisp (file)

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

Location

cl-rrd.asd

Systems

cl-rrd (system)

Packages

cl-rrd-asd

Exported Definitions

*cl-rrd-version* (special variable)

2.1.2 cl-rrd/packages.lisp

Parent

cl-rrd (system)

Location

packages.lisp

Packages

cl-rrd

2.1.3 cl-rrd/specials.lisp

Dependency

packages.lisp (file)

Parent

cl-rrd (system)

Location

specials.lisp

Internal Definitions

• *rpn-operator-map* (special variable)
• *rpn-special-value-list* (special variable)
• +unix-epoch+ (constant)
• def-rpn-operators (macro)
• def-rpn-special-values (macro)

2.1.4 cl-rrd/utility.lisp

Dependency

specials.lisp (file)

Parent

cl-rrd (system)

Location

utility.lisp

Internal Definitions

• flatten (function)
• strcat (function)
• to-string (function)
• unix-time (function)

2.1.5 cl-rrd/librrd-ffi.lisp

Dependency

utility.lisp (file)

Parent

cl-rrd (system)

Location

librrd-ffi.lisp

Exported Definitions

• rrd-call (function)
• rrd-call-graph (function)

Internal Definitions

• %rrd-clear-error (function)
• %rrd-create (function)
• %rrd-dump (function)
• %rrd-fetch (function)
• %rrd-get-error (function)
• %rrd-graph (function)
• %rrd-test-error (function)
• %rrd-update (function)
• foreign-alloc-list (function)
• rrd-last (function)
• rrd-resize (function)
• rrd-restore (function)
• rrd-tune (function)
• without-fp-traps (macro)

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

• parse-rpn (function)
• to-variable-name (function)
• valid-rpn-operator (function)
• valid-rpn-special (function)
• valid-variable-name (function)

2.1.7 cl-rrd/cl-rrd.lisp

Dependency

rpn.lisp (file)

Parent

cl-rrd (system)

Location

cl-rrd.lisp

Exported Definitions

• create (method)
• database (class)
• update (method)
• with-database (macro)

Internal Definitions

• archive (class)
• ds-string (function)
• rra-string (function)
• rrd-archives (method)
• (setf rrd-archives) (method)
• rrd-data-sources (method)
• (setf rrd-data-sources) (method)
• rrd-file (method)
• (setf rrd-file) (method)
• rrd-start (method)
• (setf rrd-start) (method)
• rrd-step (method)
• (setf rrd-step) (method)
• update-template-string (function)
• update-value-string (function)

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

• cdef-string (function)
• def-string (function)
• escape (function)
• parse-graph-options (function)
• vdef-string (function)

3 Packages

Packages are listed by definition order.

3.1 cl-rrd-asd

Source

cl-rrd.asd

Use List

• asdf/interface
• common-lisp

Exported Definitions

*cl-rrd-version* (special variable)

3.2 cl-rrd

Source

packages.lisp (file)

Nickname

rrd

Use List

common-lisp

Exported Definitions

• compile-rpn (function)
• create (generic function)
• create (method)
• database (class)
• generate-graph (macro)
• rrd-call (function)
• rrd-call-graph (function)
• update (generic function)
• update (method)
• with-database (macro)

Internal Definitions

• %rrd-clear-error (function)
• %rrd-create (function)
• %rrd-dump (function)
• %rrd-fetch (function)
• %rrd-get-error (function)
• %rrd-graph (function)
• %rrd-test-error (function)
• %rrd-update (function)
• *rpn-operator-map* (special variable)
• *rpn-special-value-list* (special variable)
• +unix-epoch+ (constant)
• archive (class)
• cdef-string (function)
• def-rpn-operators (macro)
• def-rpn-special-values (macro)
• def-string (function)
• ds-string (function)
• escape (function)
• flatten (function)
• foreign-alloc-list (function)
• parse-graph-options (function)
• parse-rpn (function)
• rra-string (function)
• rrd-archives (generic function)
• rrd-archives (method)
• (setf rrd-archives) (method)
• (setf rrd-archives) (generic function)
• rrd-data-sources (generic function)
• rrd-data-sources (method)
• (setf rrd-data-sources) (method)
• (setf rrd-data-sources) (generic function)
• rrd-file (generic function)
• rrd-file (method)
• (setf rrd-file) (method)
• (setf rrd-file) (generic function)
• rrd-last (function)
• rrd-resize (function)
• rrd-restore (function)
• rrd-start (generic function)
• rrd-start (method)
• (setf rrd-start) (method)
• (setf rrd-start) (generic function)
• rrd-step (generic function)
• rrd-step (method)
• (setf rrd-step) (method)
• (setf rrd-step) (generic function)
• rrd-tune (function)
• strcat (function)
• to-string (function)
• to-variable-name (function)
• unix-time (function)
• update-template-string (function)
• update-value-string (function)
• valid-rpn-operator (function)
• valid-rpn-special (function)
• valid-variable-name (function)
• vdef-string (function)
• without-fp-traps (macro)

4 Definitions

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

4.1 Exported definitions

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

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)

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)

4.1.5 Classes

Class: database ()

Package

cl-rrd

Source

cl-rrd.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• update (method)
• create (method)
• rrd-archives (method)
• rrd-archives (method)
• rrd-data-sources (method)
• rrd-data-sources (method)
• rrd-step (method)
• rrd-step (method)
• rrd-start (method)
• rrd-start (method)
• rrd-file (method)
• rrd-file (method)

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)

4.2 Internal definitions

4.2.1 Constants

Constant: +unix-epoch+

Package

cl-rrd

Source

specials.lisp (file)

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)

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)

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)

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)

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

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types