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

The cl-etcd Reference Manual

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

Next: Systems, Previous: The cl-etcd Reference Manual, Up: The cl-etcd Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-etcd Reference Manual [Contents][Index]

2 Systems

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

cl-etcd

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

2.1 `cl-etcd`

Run etcd as an asynchronous inferior process.

Author

Anthony Green <green@moxielogic.com>

License

AGPL3

Version

Dependencies

alexandria (system).
async-process (system).
bordeaux-threads (system).
cl-base64 (system).
cl-json (system).
cl-ppcre (system).
str (system).
drakma (system).
flexi-streams (system).
split-sequence (system).

Source

cl-etcd.asd.

Child Components

package.lisp (file).
etcd.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-etcd Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-etcd/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-etcd/cl-etcd.asd`

Source: cl-etcd.asd.
Parent Component: cl-etcd (system).
ASDF Systems: cl-etcd.

Next: cl-etcd/etcd.lisp, Previous: cl-etcd/cl-etcd.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-etcd/package.lisp`

Source: cl-etcd.asd.
Parent Component: cl-etcd (system).
Packages: cl-etcd.

Previous: cl-etcd/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-etcd/etcd.lisp`

Dependency

package.lisp (file).

Source

cl-etcd.asd.

Parent Component

cl-etcd (system).

Public Interface

delete-dir-etcd (function).
delete-etcd (function).
etcd (class).
get-etcd (function).
(setf get-etcd) (function).
id (reader method).
initialize-instance (method).
watch-etcd (function).
with-etcd (macro).

Internals

%get-etcd (function).
+became-regex+ (special variable).
+etcd-member-id-regex+ (special variable).
config (reader method).
delete-process (function).
get-process-output-string (function).
get-put-uri (reader method).
monitor-etcd-output (function).
on-follower (reader method).
on-leader (reader method).
process (reader method).
process (class).
process-buffer-stream (reader method).
process-command (reader method).
process-name (reader method).
process-output-callback (reader method).
process-output-callback-type (reader method).
process-pointer (reader method).
process-read-thread (reader method).
process-send-input (function).
ready (reader method).
role (reader method).
run-process (function).
set-process-read-thread (writer method).
start-semaphore (reader method).
version (reader method).
write-to-buffer (function).

Next: Definitions, Previous: Files, Up: The cl-etcd Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-etcd

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

4.1 `cl-etcd`

Source

package.lisp.

Use List

common-lisp.

Public Interface

delete-dir-etcd (function).
delete-etcd (function).
etcd (class).
get-etcd (function).
(setf get-etcd) (function).
id (generic reader).
watch-etcd (function).
with-etcd (macro).

Internals

%get-etcd (function).
+became-regex+ (special variable).
+etcd-member-id-regex+ (special variable).
config (generic reader).
delete-process (function).
get-process-output-string (function).
get-put-uri (generic reader).
monitor-etcd-output (function).
on-follower (generic reader).
on-leader (generic reader).
process (generic reader).
process (class).
process-buffer-stream (generic reader).
process-command (generic reader).
process-name (generic reader).
process-output-callback (generic reader).
process-output-callback-type (generic reader).
process-pointer (generic reader).
process-read-thread (generic reader).
process-send-input (function).
ready (generic reader).
role (generic reader).
run-process (function).
set-process-read-thread (generic writer).
start-semaphore (generic reader).
version (generic reader).
write-to-buffer (function).

Next: Indexes, Previous: Packages, Up: The cl-etcd Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Macros
Ordinary functions
Generic functions
Standalone methods
Classes

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: with-etcd ((etcd config &key on-leader on-follower) &body body) ¶

Create an etcd subprocess, ETCD. CONFIG is a hashtable of etcd config options: name, initial-advertise-peer-urls, listen-peer-urls, listen-client-urls, advertise-client-urls, initial-cluster, initial-cluster-state, initial-cluster-token. Otherwise, CONFIG is nil and we are creating a non-clustered etcd instance.

Package: cl-etcd.
Source: etcd.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: delete-dir-etcd (dir etcd &key error-on-missing) ¶

Delete the directory DIR recursively from ETCD.

Package: cl-etcd.
Source: etcd.lisp.

Function: delete-etcd (key etcd &key error-on-missing) ¶

Delete the KEY from ETCD.

Package: cl-etcd.
Source: etcd.lisp.

Function: get-etcd (key etcd) ¶

Get the value of KEY from ETCD. Returns NIL if KEY not found. Throws an error on unexpected errors.

Package: cl-etcd.
Source: etcd.lisp.

Function: (setf get-etcd) (key etcd) ¶

Put the KEY/VALUE pair into ETCD.

Package: cl-etcd.
Source: etcd.lisp.

Function: watch-etcd (etcd key) ¶

Like GET-ETCD, but waits until value changes.

Package: cl-etcd.
Source: etcd.lisp.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.3 Generic functions

Generic Reader: id (object) ¶

Package

	Index Entry	Section

%
	`%get-etcd`:	Private ordinary functions

(
	`(setf get-etcd)`:	Public ordinary functions

C
	`config`:	Private generic functions
	`config`:	Private generic functions

D
	`delete-dir-etcd`:	Public ordinary functions
	`delete-etcd`:	Public ordinary functions
	`delete-process`:	Private ordinary functions

F
	`Function, %get-etcd`:	Private ordinary functions
	`Function, (setf get-etcd)`:	Public ordinary functions
	`Function, delete-dir-etcd`:	Public ordinary functions
	`Function, delete-etcd`:	Public ordinary functions
	`Function, delete-process`:	Private ordinary functions
	`Function, get-etcd`:	Public ordinary functions
	`Function, get-process-output-string`:	Private ordinary functions
	`Function, monitor-etcd-output`:	Private ordinary functions
	`Function, process-send-input`:	Private ordinary functions
	`Function, run-process`:	Private ordinary functions
	`Function, watch-etcd`:	Public ordinary functions
	`Function, write-to-buffer`:	Private ordinary functions

G
	`Generic Function, config`:	Private generic functions
	`Generic Function, get-put-uri`:	Private generic functions
	`Generic Function, id`:	Public generic functions
	`Generic Function, on-follower`:	Private generic functions
	`Generic Function, on-leader`:	Private generic functions
	`Generic Function, process`:	Private generic functions
	`Generic Function, process-buffer-stream`:	Private generic functions
	`Generic Function, process-command`:	Private generic functions
	`Generic Function, process-name`:	Private generic functions
	`Generic Function, process-output-callback`:	Private generic functions
	`Generic Function, process-output-callback-type`:	Private generic functions
	`Generic Function, process-pointer`:	Private generic functions
	`Generic Function, process-read-thread`:	Private generic functions
	`Generic Function, ready`:	Private generic functions
	`Generic Function, role`:	Private generic functions
	`Generic Function, set-process-read-thread`:	Private generic functions
	`Generic Function, start-semaphore`:	Private generic functions
	`Generic Function, version`:	Private generic functions
	`get-etcd`:	Public ordinary functions
	`get-process-output-string`:	Private ordinary functions
	`get-put-uri`:	Private generic functions
	`get-put-uri`:	Private generic functions

I
	`id`:	Public generic functions
	`id`:	Public generic functions
	`initialize-instance`:	Public standalone methods

M
	`Macro, with-etcd`:	Public macros
	`Method, config`:	Private generic functions
	`Method, get-put-uri`:	Private generic functions
	`Method, id`:	Public generic functions
	`Method, initialize-instance`:	Public standalone methods
	`Method, on-follower`:	Private generic functions
	`Method, on-leader`:	Private generic functions
	`Method, process`:	Private generic functions
	`Method, process-buffer-stream`:	Private generic functions
	`Method, process-command`:	Private generic functions
	`Method, process-name`:	Private generic functions
	`Method, process-output-callback`:	Private generic functions
	`Method, process-output-callback-type`:	Private generic functions
	`Method, process-pointer`:	Private generic functions
	`Method, process-read-thread`:	Private generic functions
	`Method, ready`:	Private generic functions
	`Method, role`:	Private generic functions
	`Method, set-process-read-thread`:	Private generic functions
	`Method, start-semaphore`:	Private generic functions
	`Method, version`:	Private generic functions
	`monitor-etcd-output`:	Private ordinary functions

O
	`on-follower`:	Private generic functions
	`on-follower`:	Private generic functions
	`on-leader`:	Private generic functions
	`on-leader`:	Private generic functions

P
	`process`:	Private generic functions
	`process`:	Private generic functions
	`process-buffer-stream`:	Private generic functions
	`process-buffer-stream`:	Private generic functions
	`process-command`:	Private generic functions
	`process-command`:	Private generic functions
	`process-name`:	Private generic functions
	`process-name`:	Private generic functions
	`process-output-callback`:	Private generic functions
	`process-output-callback`:	Private generic functions
	`process-output-callback-type`:	Private generic functions
	`process-output-callback-type`:	Private generic functions
	`process-pointer`:	Private generic functions
	`process-pointer`:	Private generic functions
	`process-read-thread`:	Private generic functions
	`process-read-thread`:	Private generic functions
	`process-send-input`:	Private ordinary functions

R
	`ready`:	Private generic functions
	`ready`:	Private generic functions
	`role`:	Private generic functions
	`role`:	Private generic functions
	`run-process`:	Private ordinary functions

S
	`set-process-read-thread`:	Private generic functions
	`set-process-read-thread`:	Private generic functions
	`start-semaphore`:	Private generic functions
	`start-semaphore`:	Private generic functions

V
	`version`:	Private generic functions
	`version`:	Private generic functions

W
	`watch-etcd`:	Public ordinary functions
	`with-etcd`:	Public macros
	`write-to-buffer`:	Private ordinary functions

	Index Entry	Section

+
	`+became-regex+`:	Private special variables
	`+etcd-member-id-regex+`:	Private special variables

B
	`buffer-stream`:	Private classes

C
	`callback-type`:	Private classes
	`command`:	Private classes
	`config`:	Public classes

G
	`get-put-uri`:	Public classes

I
	`id`:	Public classes

N
	`name`:	Private classes

O
	`on-follower`:	Public classes
	`on-leader`:	Public classes
	`output-callback`:	Private classes

P
	`pointer`:	Private classes
	`process`:	Public classes

R
	`read-thread`:	Private classes
	`ready`:	Public classes
	`role`:	Public classes

S
	`Slot, buffer-stream`:	Private classes
	`Slot, callback-type`:	Private classes
	`Slot, command`:	Private classes
	`Slot, config`:	Public classes
	`Slot, get-put-uri`:	Public classes
	`Slot, id`:	Public classes
	`Slot, name`:	Private classes
	`Slot, on-follower`:	Public classes
	`Slot, on-leader`:	Public classes
	`Slot, output-callback`:	Private classes
	`Slot, pointer`:	Private classes
	`Slot, process`:	Public classes
	`Slot, read-thread`:	Private classes
	`Slot, ready`:	Public classes
	`Slot, role`:	Public classes
	`Slot, start-semaphore`:	Public classes
	`Slot, version`:	Public classes
	`Special Variable, +became-regex+`:	Private special variables
	`Special Variable, +etcd-member-id-regex+`:	Private special variables
	`start-semaphore`:	Public classes

V
	`version`:	Public classes

	Index Entry	Section

C
	`cl-etcd`:	The cl-etcd system
	`cl-etcd`:	The cl-etcd package
	`cl-etcd.asd`:	The cl-etcd/cl-etcd․asd file
	`Class, etcd`:	Public classes
	`Class, process`:	Private classes

E
	`etcd`:	Public classes
	`etcd.lisp`:	The cl-etcd/etcd․lisp file

F
	`File, cl-etcd.asd`:	The cl-etcd/cl-etcd․asd file
	`File, etcd.lisp`:	The cl-etcd/etcd․lisp file
	`File, package.lisp`:	The cl-etcd/package․lisp file

P
	`Package, cl-etcd`:	The cl-etcd package
	`package.lisp`:	The cl-etcd/package․lisp file
	`process`:	Private classes

S
	`System, cl-etcd`:	The cl-etcd system

The cl-etcd Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-etcd

3 Files

3.1 Lisp

3.1.1 cl-etcd/cl-etcd.asd

3.1.2 cl-etcd/package.lisp

3.1.3 cl-etcd/etcd.lisp

4 Packages

4.1 cl-etcd

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Standalone methods

5.1.5 Classes

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-etcd`

3.1.1 `cl-etcd/cl-etcd.asd`

3.1.2 `cl-etcd/package.lisp`

3.1.3 `cl-etcd/etcd.lisp`

4.1 `cl-etcd`