This is the cl-flowd Reference Manual, version 0.5.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 12:07:30 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-flowdNative Lisp interface to Netflow data stores created by
the Netflow collect flowd (http://www.mindrot.org/projects/flowd/)
Mike Maul <mike.maul@gmail.com>
BSD
0.5.0
cl-annot (system).
package.lisp (file).
flowd.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-flowd/flowd.lisppackage.lisp (file).
cl-flowd (system).
agent-addr (reader method).
(setf agent-addr) (writer method).
close-log (function).
dst-addr (reader method).
(setf dst-addr) (writer method).
dst-as (reader method).
(setf dst-as) (writer method).
dst-mask (reader method).
(setf dst-mask) (writer method).
dst-net (function).
dst-port (reader method).
(setf dst-port) (writer method).
engine-id (reader method).
(setf engine-id) (writer method).
engine-type (reader method).
(setf engine-type) (writer method).
fields (reader method).
fields (reader method).
(setf fields) (writer method).
flow (class).
flow-finish (reader method).
(setf flow-finish) (writer method).
flow-sequence (reader method).
(setf flow-sequence) (writer method).
flow-start (reader method).
(setf flow-start) (writer method).
flow-v2 (class).
flow-v2.agent-addr (reader method).
(setf flow-v2.agent-addr) (writer method).
flow-v2.dst-addr (reader method).
(setf flow-v2.dst-addr) (writer method).
flow-v2.dst-as (reader method).
(setf flow-v2.dst-as) (writer method).
flow-v2.dst-mask (reader method).
(setf flow-v2.dst-mask) (writer method).
flow-v2.dst-port (reader method).
(setf flow-v2.dst-port) (writer method).
flow-v2.engine-id (reader method).
(setf flow-v2.engine-id) (writer method).
flow-v2.engine-type (reader method).
(setf flow-v2.engine-type) (writer method).
flow-v2.fields (reader method).
(setf flow-v2.fields) (writer method).
flow-v2.flow-finish (reader method).
(setf flow-v2.flow-finish) (writer method).
flow-v2.flow-sequence (reader method).
(setf flow-v2.flow-sequence) (writer method).
flow-v2.flow-start (reader method).
(setf flow-v2.flow-start) (writer method).
flow-v2.gateway-addr (reader method).
(setf flow-v2.gateway-addr) (writer method).
flow-v2.if-index-in (reader method).
(setf flow-v2.if-index-in) (writer method).
flow-v2.if-index-out (reader method).
(setf flow-v2.if-index-out) (writer method).
flow-v2.netflow-version (reader method).
(setf flow-v2.netflow-version) (writer method).
flow-v2.octets (reader method).
(setf flow-v2.octets) (writer method).
flow-v2.packets (reader method).
(setf flow-v2.packets) (writer method).
flow-v2.protocol (reader method).
(setf flow-v2.protocol) (writer method).
flow-v2.recv-time (reader method).
(setf flow-v2.recv-time) (writer method).
flow-v2.src-addr (reader method).
(setf flow-v2.src-addr) (writer method).
flow-v2.src-as (reader method).
(setf flow-v2.src-as) (writer method).
flow-v2.src-mask (reader method).
(setf flow-v2.src-mask) (writer method).
flow-v2.src-port (reader method).
(setf flow-v2.src-port) (writer method).
flow-v2.sys-uptime-ms (reader method).
(setf flow-v2.sys-uptime-ms) (writer method).
flow-v2.tag (reader method).
(setf flow-v2.tag) (writer method).
flow-v2.tcp-flags (reader method).
(setf flow-v2.tcp-flags) (writer method).
flow-v2.time-nanosec (reader method).
(setf flow-v2.time-nanosec) (writer method).
flow-v2.time-sec (reader method).
(setf flow-v2.time-sec) (writer method).
flow-v2.tos (reader method).
(setf flow-v2.tos) (writer method).
format-flow (function).
format-ipv4 (function).
gateway-addr (reader method).
(setf gateway-addr) (writer method).
hex (function).
if-index-in (reader method).
(setf if-index-in) (writer method).
if-index-out (reader method).
(setf if-index-out) (writer method).
len-words (reader method).
netflow-version (reader method).
(setf netflow-version) (writer method).
octets (reader method).
(setf octets) (writer method).
open-log (function).
open-log-v2 (function).
packets (reader method).
(setf packets) (writer method).
protocol (reader method).
(setf protocol) (writer method).
read-flow (function).
read-flow-v2 (function).
recv-time (reader method).
(setf recv-time) (writer method).
recv-time-usecs (reader method).
(setf recv-time-usecs) (writer method).
reserved (reader method).
src-addr (reader method).
(setf src-addr) (writer method).
src-as (reader method).
(setf src-as) (writer method).
src-mask (reader method).
(setf src-mask) (writer method).
src-net (function).
src-port (reader method).
(setf src-port) (writer method).
store-header (class).
store-header-v2 (class).
store-header-v2.flags (reader method).
store-header-v2.magic (reader method).
store-header-v2.start-time (reader method).
store-header-v2.stream (reader method).
store-header-v2.version (reader method).
stream (reader method).
sys-uptime-ms (reader method).
(setf sys-uptime-ms) (writer method).
tag (reader method).
(setf tag) (writer method).
tcp-flags (reader method).
(setf tcp-flags) (writer method).
time-nanosec (reader method).
(setf time-nanosec) (writer method).
time-sec (reader method).
(setf time-sec) (writer method).
tos (reader method).
(setf tos) (writer method).
version (reader method).
with-open-log (macro).
*ipv4-netmasks* (special variable).
+store-field-agent-addr4+ (constant).
+store-field-agent-addr6+ (constant).
+store-field-agent-info+ (constant).
+store-field-all+ (constant).
+store-field-as-info+ (constant).
+store-field-crc32+ (constant).
+store-field-dst-addr4+ (constant).
+store-field-dst-addr6+ (constant).
+store-field-flow-engine-info+ (constant).
+store-field-flow-times+ (constant).
+store-field-gateway-addr4+ (constant).
+store-field-gateway-addr6+ (constant).
+store-field-if-indices+ (constant).
+store-field-octets+ (constant).
+store-field-packets+ (constant).
+store-field-proto-flags-tos+ (constant).
+store-field-recv-time+ (constant).
+store-field-src-addr4+ (constant).
+store-field-src-addr6+ (constant).
+store-field-srcdst-port+ (constant).
+store-field-tag+ (constant).
+store-magic+ (constant).
+store-version+ (constant).
address (reader method).
(setf address) (writer method).
format-addr (function).
formatted-addr (macro).
ipaddr (class).
ipv4 (class).
ipv6 (class).
make-ipv4 (function).
make-ipv6 (function).
read-header (function).
read-n-bytes (function).
when-flagged (macro).
Packages are listed by definition order.
cl-flowdcl-annot.
cl-annot.class.
common-lisp.
agent-addr (generic reader).
(setf agent-addr) (generic writer).
close-log (function).
dst-addr (generic reader).
(setf dst-addr) (generic writer).
dst-as (generic reader).
(setf dst-as) (generic writer).
dst-mask (generic reader).
(setf dst-mask) (generic writer).
dst-net (function).
dst-port (generic reader).
(setf dst-port) (generic writer).
engine-id (generic reader).
(setf engine-id) (generic writer).
engine-type (generic reader).
(setf engine-type) (generic writer).
fields (generic reader).
(setf fields) (generic writer).
flow (class).
flow-finish (generic reader).
(setf flow-finish) (generic writer).
flow-sequence (generic reader).
(setf flow-sequence) (generic writer).
flow-start (generic reader).
(setf flow-start) (generic writer).
flow-v2 (class).
flow-v2.agent-addr (generic reader).
(setf flow-v2.agent-addr) (generic writer).
flow-v2.dst-addr (generic reader).
(setf flow-v2.dst-addr) (generic writer).
flow-v2.dst-as (generic reader).
(setf flow-v2.dst-as) (generic writer).
flow-v2.dst-mask (generic reader).
(setf flow-v2.dst-mask) (generic writer).
flow-v2.dst-port (generic reader).
(setf flow-v2.dst-port) (generic writer).
flow-v2.engine-id (generic reader).
(setf flow-v2.engine-id) (generic writer).
flow-v2.engine-type (generic reader).
(setf flow-v2.engine-type) (generic writer).
flow-v2.fields (generic reader).
(setf flow-v2.fields) (generic writer).
flow-v2.flow-finish (generic reader).
(setf flow-v2.flow-finish) (generic writer).
flow-v2.flow-sequence (generic reader).
(setf flow-v2.flow-sequence) (generic writer).
flow-v2.flow-start (generic reader).
(setf flow-v2.flow-start) (generic writer).
flow-v2.gateway-addr (generic reader).
(setf flow-v2.gateway-addr) (generic writer).
flow-v2.if-index-in (generic reader).
(setf flow-v2.if-index-in) (generic writer).
flow-v2.if-index-out (generic reader).
(setf flow-v2.if-index-out) (generic writer).
flow-v2.netflow-version (generic reader).
(setf flow-v2.netflow-version) (generic writer).
flow-v2.octets (generic reader).
(setf flow-v2.octets) (generic writer).
flow-v2.packets (generic reader).
(setf flow-v2.packets) (generic writer).
flow-v2.protocol (generic reader).
(setf flow-v2.protocol) (generic writer).
flow-v2.recv-time (generic reader).
(setf flow-v2.recv-time) (generic writer).
flow-v2.src-addr (generic reader).
(setf flow-v2.src-addr) (generic writer).
flow-v2.src-as (generic reader).
(setf flow-v2.src-as) (generic writer).
flow-v2.src-mask (generic reader).
(setf flow-v2.src-mask) (generic writer).
flow-v2.src-port (generic reader).
(setf flow-v2.src-port) (generic writer).
flow-v2.sys-uptime-ms (generic reader).
(setf flow-v2.sys-uptime-ms) (generic writer).
flow-v2.tag (generic reader).
(setf flow-v2.tag) (generic writer).
flow-v2.tcp-flags (generic reader).
(setf flow-v2.tcp-flags) (generic writer).
flow-v2.time-nanosec (generic reader).
(setf flow-v2.time-nanosec) (generic writer).
flow-v2.time-sec (generic reader).
(setf flow-v2.time-sec) (generic writer).
flow-v2.tos (generic reader).
(setf flow-v2.tos) (generic writer).
format-flow (function).
format-ipv4 (function).
gateway-addr (generic reader).
(setf gateway-addr) (generic writer).
hex (function).
if-index-in (generic reader).
(setf if-index-in) (generic writer).
if-index-out (generic reader).
(setf if-index-out) (generic writer).
len-words (generic reader).
netflow-version (generic reader).
(setf netflow-version) (generic writer).
octets (generic reader).
(setf octets) (generic writer).
open-log (function).
open-log-v2 (function).
packets (generic reader).
(setf packets) (generic writer).
protocol (generic reader).
(setf protocol) (generic writer).
read-flow (function).
read-flow-v2 (function).
recv-time (generic reader).
(setf recv-time) (generic writer).
recv-time-usecs (generic reader).
(setf recv-time-usecs) (generic writer).
reserved (generic reader).
src-addr (generic reader).
(setf src-addr) (generic writer).
src-as (generic reader).
(setf src-as) (generic writer).
src-mask (generic reader).
(setf src-mask) (generic writer).
src-net (function).
src-port (generic reader).
(setf src-port) (generic writer).
store-header (class).
store-header-v2 (class).
store-header-v2.flags (generic reader).
store-header-v2.magic (generic reader).
store-header-v2.start-time (generic reader).
store-header-v2.stream (generic reader).
store-header-v2.version (generic reader).
stream (generic reader).
sys-uptime-ms (generic reader).
(setf sys-uptime-ms) (generic writer).
tag (generic reader).
(setf tag) (generic writer).
tcp-flags (generic reader).
(setf tcp-flags) (generic writer).
time-nanosec (generic reader).
(setf time-nanosec) (generic writer).
time-sec (generic reader).
(setf time-sec) (generic writer).
tos (generic reader).
(setf tos) (generic writer).
version (generic reader).
with-open-log (macro).
*ipv4-netmasks* (special variable).
+store-field-agent-addr4+ (constant).
+store-field-agent-addr6+ (constant).
+store-field-agent-info+ (constant).
+store-field-all+ (constant).
+store-field-as-info+ (constant).
+store-field-crc32+ (constant).
+store-field-dst-addr4+ (constant).
+store-field-dst-addr6+ (constant).
+store-field-flow-engine-info+ (constant).
+store-field-flow-times+ (constant).
+store-field-gateway-addr4+ (constant).
+store-field-gateway-addr6+ (constant).
+store-field-if-indices+ (constant).
+store-field-octets+ (constant).
+store-field-packets+ (constant).
+store-field-proto-flags-tos+ (constant).
+store-field-recv-time+ (constant).
+store-field-src-addr4+ (constant).
+store-field-src-addr6+ (constant).
+store-field-srcdst-port+ (constant).
+store-field-tag+ (constant).
+store-magic+ (constant).
+store-version+ (constant).
address (generic reader).
(setf address) (generic writer).
format-addr (function).
formatted-addr (macro).
ipaddr (class).
ipv4 (class).
ipv6 (class).
make-ipv4 (function).
make-ipv6 (function).
read-header (function).
read-n-bytes (function).
when-flagged (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Use open-log to obtain a store-header to flowd log located at <filename>
This function closes the log file associated with a storage header.
(dst-net flow-obj &optional stream formatted-p)
This function extracts the destination network and masks it against the relevant IPv4 netmask and returns the network part. If given a STREAM and FORMATTED-P is not null, the resulting netblock is emitted using FORMAT-IPV4 to the indicated stream.
formats a string representing the next entry in the flowd log <stream> can be stream to write to or nil to return string
(format-ipv4 binary-chunk &optiona stream mask)
This function outputs an IPv4 address as a dotted quad to STREAM. If a netmask is passed in, it’s outputted with the dotted quad in CIDR notation.
Sends string hex value of <v> to <stream>
(open-log <file name>
This function opens a new flowd log file > v2 and returns a header structure containing the relevant file header information.
(open-log <file name>
This function opens a new flowd v2 log file and returns a header structure containing the relevant file header information.
(read-flow <flow-header> &optional flow-object)
This function reads one flow entry from a log file (return value from OPEN-LOG) and returns it. If a flow object is passed in as an optional parameter, this flow object is re-used for storage instead of allocating a new instance.
(read-flow <flow-header> &optional flow-object)
This function reads one flow entry from a flowd log < v2 file (return value from
OPEN-LOG) and returns it. If a flow object is passed in as an optional
parameter, this flow object is re-used for storage instead of allocating
a new instance.
(src-net flow-obj &optional stream formatted-p)
This function extracts the source network and masks it against the relevant IPv4 netmask and returns the network part. If given a STREAM and FORMATTED-P is not null, the resulting netblock is emitted using FORMAT-IPV4 to the indicated stream.
store-header)) ¶automatically generated reader method
store-header)) ¶automatically generated reader method
store-header)) ¶automatically generated reader method
store-header-v2)) ¶automatically generated reader method
store-header-v2)) ¶automatically generated reader method
store-header-v2)) ¶automatically generated reader method
store-header-v2)) ¶automatically generated reader method
store-header-v2)) ¶automatically generated reader method
store-header)) ¶automatically generated reader method
store-header)) ¶automatically generated reader method
(setf agent-addr).
agent-addr.
(setf dst-addr).
dst-addr.
(setf dst-as).
dst-as.
(setf dst-mask).
dst-mask.
(setf dst-port).
dst-port.
(setf engine-id).
engine-id.
(setf engine-type).
engine-type.
(setf fields).
fields.
(setf flow-finish).
flow-finish.
(setf flow-sequence).
flow-sequence.
(setf flow-start).
flow-start.
(setf gateway-addr).
gateway-addr.
(setf if-index-in).
if-index-in.
(setf if-index-out).
if-index-out.
(setf netflow-version).
netflow-version.
(setf octets).
octets.
(setf packets).
packets.
(setf protocol).
protocol.
(setf recv-time).
recv-time.
(setf recv-time-usecs).
recv-time-usecs.
(setf src-addr).
src-addr.
(setf src-as).
src-as.
(setf src-mask).
src-mask.
(setf src-port).
src-port.
(setf sys-uptime-ms).
sys-uptime-ms.
(setf tag).
tag.
(setf tcp-flags).
tcp-flags.
(setf time-nanosec).
time-nanosec.
(setf time-sec).
time-sec.
(setf tos).
tos.
:fields
:recv-time
:recv-time-usecs
:tcp-flags
:protocol
:agent-addr
:src-addr
:dst-addr
:gateway-addr
:src-port
:dst-port
:packets
:octets
:if-index-in
:if-index-out
:sys-uptime-ms
:time-sec
:time-nanosec
:netflow-version
:flow-start
:flow-finish
:src-as
:dst-as
:src-mask
:dst-mask
:engine-type
:engine-id
:flow-sequence
(setf flow-v2.agent-addr).
flow-v2.agent-addr.
(setf flow-v2.dst-addr).
flow-v2.dst-addr.
(setf flow-v2.dst-as).
flow-v2.dst-as.
(setf flow-v2.dst-mask).
flow-v2.dst-mask.
(setf flow-v2.dst-port).
flow-v2.dst-port.
(setf flow-v2.engine-id).
flow-v2.engine-id.
(setf flow-v2.engine-type).
flow-v2.engine-type.
(setf flow-v2.fields).
flow-v2.fields.
(setf flow-v2.flow-finish).
flow-v2.flow-finish.
(setf flow-v2.flow-sequence).
flow-v2.flow-sequence.
(setf flow-v2.flow-start).
flow-v2.flow-start.
(setf flow-v2.gateway-addr).
flow-v2.gateway-addr.
(setf flow-v2.if-index-in).
flow-v2.if-index-in.
(setf flow-v2.if-index-out).
flow-v2.if-index-out.
(setf flow-v2.netflow-version).
flow-v2.netflow-version.
(setf flow-v2.octets).
flow-v2.octets.
(setf flow-v2.packets).
flow-v2.packets.
(setf flow-v2.protocol).
flow-v2.protocol.
(setf flow-v2.recv-time).
flow-v2.recv-time.
(setf flow-v2.src-addr).
flow-v2.src-addr.
(setf flow-v2.src-as).
flow-v2.src-as.
(setf flow-v2.src-mask).
flow-v2.src-mask.
(setf flow-v2.src-port).
flow-v2.src-port.
(setf flow-v2.sys-uptime-ms).
flow-v2.sys-uptime-ms.
(setf flow-v2.tag).
flow-v2.tag.
(setf flow-v2.tcp-flags).
flow-v2.tcp-flags.
(setf flow-v2.time-nanosec).
flow-v2.time-nanosec.
(setf flow-v2.time-sec).
flow-v2.time-sec.
(setf flow-v2.tos).
flow-v2.tos.
:fields
:tag
:recv-time
:tcp-flags
:protocol
:tos
:agent-addr
:src-addr
:dst-addr
:gateway-addr
:src-port
:dst-port
:packets
:octets
:if-index-in
:if-index-out
:sys-uptime-ms
:time-sec
:time-nanosec
:netflow-version
:flow-start
:flow-finish
:src-as
:dst-as
:src-mask
:dst-mask
:engine-type
:engine-id
:flow-sequence
:magic
This slot is read-only.
:version
This slot is read-only.
:start-time
This slot is read-only.
:flags
This slot is read-only.
:stream
This slot is read-only.
Checks if a given flag is set. The flag field is expected to be named FIELDS and is for use inside READ-FLOW only!
This function is currently a no-op
This function is currently a no-op
Read from STREAM a total of N bytes, mung them together as a single integer. Expects 8-bit bytes.
| Jump to: | (
A C D E F G H I L M N O P R S T V W |
|---|
| Jump to: | (
A C D E F G H I L M N O P R S T V W |
|---|
| Jump to: | *
+
A C D E F G I L M N O P R S T V |
|---|
| Jump to: | *
+
A C D E F G I L M N O P R S T V |
|---|
| Jump to: | C F I P S |
|---|
| Jump to: | C F I P S |
|---|