The cl-replica Reference Manual

3.1.1 cl-replica/cl-replica.asd

Source

cl-replica.asd.

Parent Component

cl-replica (system).

ASDF Systems

cl-replica.

---

3.1.2 cl-replica/packages.lisp

Source

cl-replica.asd.

Parent Component

cl-replica (system).

Packages

• cl-replica.hashtable-ops.
• cl-replica.vector-clock.
• cl-replica.
• cl-replica.network-io.

---

3.1.3 cl-replica/vector-clock.lisp

Dependency

packages.lisp (file).

Source

cl-replica.asd.

Parent Component

cl-replica (system).

Public Interface

• compare-and-update (function).
• concurrent-access (condition).
• init-timestamp (function).
• make-timestamp (function).
• promote-timestamp (function).
• timestamp (structure).
• timestamp-vclock (reader).
• (setf timestamp-vclock) (writer).
• timestamp<= (function).

Internals

• copy-timestamp (function).
• timestamp-p (function).
• ts-1 (reader method).
• ts-2 (reader method).
• vec-length (function).

---

3.1.4 cl-replica/network-io.lisp

Dependency

packages.lisp (file).

Source

cl-replica.asd.

Parent Component

cl-replica (system).

Public Interface

• connect-to-remote-peer (function).
• make-network-settings (function).
• network-settings-cache-being-processed (reader).
• (setf network-settings-cache-being-processed) (writer).
• network-settings-client-buffer-size (reader).
• (setf network-settings-client-buffer-size) (writer).
• network-settings-encryption-fns (reader).
• (setf network-settings-encryption-fns) (writer).
• network-settings-header-bytes (reader).
• (setf network-settings-header-bytes) (writer).
• network-settings-htable-entry-size (reader).
• (setf network-settings-htable-entry-size) (writer).
• network-settings-max-n-of-tcp-connections (reader).
• (setf network-settings-max-n-of-tcp-connections) (writer).
• network-settings-remove-obsolete-keys-interval (reader).
• (setf network-settings-remove-obsolete-keys-interval) (writer).
• network-settings-server-buffer-size (reader).
• (setf network-settings-server-buffer-size) (writer).
• network-settings-share-cache-interval-in-sec (reader).
• (setf network-settings-share-cache-interval-in-sec) (writer).
• network-settings-stop-hash-table-cleaning (reader).
• (setf network-settings-stop-hash-table-cleaning) (writer).
• network-settings-stop-sync (reader).
• (setf network-settings-stop-sync) (writer).
• network-settings-stop-tcp-client (reader).
• (setf network-settings-stop-tcp-client) (writer).
• network-settings-stop-tcp-server (reader).
• (setf network-settings-stop-tcp-server) (writer).
• network-settings-stop-udp-server (reader).
• (setf network-settings-stop-udp-server) (writer).
• network-settings-tcp-client-reconnection-attempts (reader).
• (setf network-settings-tcp-client-reconnection-attempts) (writer).
• network-settings-tcp-client-try-reconnect-after (reader).
• (setf network-settings-tcp-client-try-reconnect-after) (writer).
• network-settings-time-to-wait-if-no-data (reader).
• (setf network-settings-time-to-wait-if-no-data) (writer).
• network-settings-trailing-bytes (reader).
• (setf network-settings-trailing-bytes) (writer).
• network-settings-udp-socket (reader).
• (setf network-settings-udp-socket) (writer).
• send-echo (function).
• send-update (function).
• start-server (function).
• stop-communication (function).

Internals

• address (reader method).
• as-keyword (function).
• cannot-build-lisp-object-from-string (condition).
• checkout-decoder (function).
• copy-decoder (function).
• copy-network-settings (function).
• data (reader method).
• decode (function).
• decode-buffer (function).
• decoder (structure).
• decoder-acc (reader).
• (setf decoder-acc) (writer).
• decoder-acc-min-size (reader).
• (setf decoder-acc-min-size) (writer).
• decoder-decrypt-fn (reader).
• (setf decoder-decrypt-fn) (writer).
• decoder-header-bytes (reader).
• (setf decoder-header-bytes) (writer).
• decoder-header-size (reader).
• (setf decoder-header-size) (writer).
• decoder-p (function).
• decoder-prev-buffer-head (reader).
• (setf decoder-prev-buffer-head) (writer).
• decoder-prev-buffer-trail (reader).
• (setf decoder-prev-buffer-trail) (writer).
• decoder-trailing-bytes (reader).
• (setf decoder-trailing-bytes) (writer).
• decoder-trailing-size (reader).
• (setf decoder-trailing-size) (writer).
• decrypt (function).
• encode (function).
• encrypt (function).
• ensure-no-msg-makers (function).
• error-msg (reader method).
• error-msg (reader method).
• handle-connection (function).
• idx (reader method).
• init-decoder (function).
• make-decoder (function).
• marker (reader method).
• msg-markers-found-in-data (condition).
• network-address-parse-error (condition).
• network-settings (structure).
• network-settings-p (function).
• obj-to-str (function).
• operation (reader method).
• parse-buffer (function).
• parse-network-address (function).
• split-string-by-delimiter (function).
• start-tcp-server (function).
• start-udp-server (function).
• str-to-obj (function).
• try-connect-until-success (function).

---

3.1.5 cl-replica/hashtable-ops.lisp

Dependencies

• packages.lisp (file).
• vector-clock.lisp (file).

Source

cl-replica.asd.

Parent Component

cl-replica (system).

Public Interface

• apply-updates-from-other-nodes (function).
• cache-being-shared (condition).
• gethash-shared-no-lock (function).
• gvalue-dbind (macro).
• init-gvalue (function).
• make-shared-hash-table (function).
• newhash-shared-no-lock (function).
• remhash-shared-no-lock (function).
• remove-obsolete-keys (function).
• share-cache-periodically (function).
• shared-hash-table-clients-socket-pool (reader).
• (setf shared-hash-table-clients-socket-pool) (writer).
• shared-hash-table-destroyed-p (reader).
• (setf shared-hash-table-destroyed-p) (writer).
• shared-hash-table-last-keys-modified (reader).
• (setf shared-hash-table-last-keys-modified) (writer).
• shared-hash-table-last-keys-modified-max-length (reader).
• (setf shared-hash-table-last-keys-modified-max-length) (writer).
• shared-hash-table-lock (reader).
• (setf shared-hash-table-lock) (writer).
• shared-hash-table-number-of-nodes (reader).
• (setf shared-hash-table-number-of-nodes) (writer).
• shared-hash-table-other-nodes (reader).
• (setf shared-hash-table-other-nodes) (writer).
• shared-hash-table-server-input-queue (reader).
• (setf shared-hash-table-server-input-queue) (writer).
• shared-hash-table-server-socket (reader).
• (setf shared-hash-table-server-socket) (writer).
• shared-hash-table-table (reader).
• (setf shared-hash-table-table) (writer).
• shared-hash-table-this-node (reader).
• (setf shared-hash-table-this-node) (writer).
• shared-hash-table-this-node-idx (reader).
• (setf shared-hash-table-this-node-idx) (writer).
• sort-for-consistency (function).

Internals

• call-fn-in-interruptable-thread (macro).
• clean-shared-hash-table (function).
• copy-shared-hash-table (function).
• data (reader method).
• malformed-data (condition).
• msg (reader method).
• nshuffle (function).
• provide-cache (function).
• shared-hash-table (structure).
• shared-hash-table-p (function).

---

3.1.6 cl-replica/api.lisp

Dependencies

• packages.lisp (file).
• hashtable-ops.lisp (file).
• vector-clock.lisp (file).
• network-io.lisp (file).

Source

cl-replica.asd.

Parent Component

cl-replica (system).

Public Interface

• clrhash-shared (function).
• destroy-shared-htable (function).
• (setf gethash-shared) (setf expander).
• gethash-shared (function).
• maphash-shared (function).
• newhash-shared (function).
• remhash-shared (function).
• share-hash-table (function).

Internals

• dbind-with-mutex (macro).
• start-all-network-threads (function).
• stop-all-network-threads (function).

---

5.1.1 Macros

Macro: gvalue-dbind (vars gvalue &body body) ¶

Destructures gvalue and binds its component to vars

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

---

5.1.2 Setf expanders

Setf Expander: (setf gethash-shared) (key h-table-obj) ¶

Package

cl-replica.

Source

api.lisp.

Reader

gethash-shared (function).

Writer

newhash-shared (function).

---

5.1.3 Ordinary functions

Function: apply-updates-from-other-nodes (sht settings queue) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: clrhash-shared (h-table-obj) ¶

API for deleting all keys from h-table.

Package

cl-replica.

Source

api.lisp.

Function: compare-and-update (ts-own ts-received) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Function: connect-to-remote-peer (addr settings) ¶

Returns node on which one can all send-update

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: destroy-shared-htable (h-table-obj wait-after-socket-is-closed) ¶

API to stop all threads inside the shared hash table. A simple hash-table is returned.

Package

cl-replica.

Source

api.lisp.

Function: gethash-shared (key h-table-obj &optional default) ¶

API for getting value

Package

cl-replica.

Source

api.lisp.

Setf expander for this function

(setf gethash-shared).

Function: gethash-shared-no-lock (key sht) ¶

Retrieves value from h-table based on key

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: init-gvalue (value del-p timestamp) ¶

Constructs a hash-table shared value from normal value

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: init-timestamp (n-proc) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Function: make-network-settings (&key htable-entry-size header-bytes trailing-bytes server-buffer-size client-buffer-size udp-socket stop-sync time-to-wait-if-no-data stop-udp-server stop-tcp-server stop-tcp-client max-n-of-tcp-connections tcp-client-try-reconnect-after tcp-client-reconnection-attempts share-cache-interval-in-sec remove-obsolete-keys-interval stop-hash-table-cleaning cache-being-processed encryption-fns) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: make-shared-hash-table (&key lock this-node other-nodes number-of-nodes this-node-idx clients-socket-pool server-socket server-input-queue table last-keys-modified last-keys-modified-max-length destroyed-p) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: make-timestamp (&key vclock) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Function: maphash-shared (fn h-table-obj) ¶

API for iteration over key-value pairs

Package

cl-replica.

Source

api.lisp.

Reader: network-settings-cache-being-processed (instance) ¶

Writer: (setf network-settings-cache-being-processed) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

cache-being-processed.

Reader: network-settings-client-buffer-size (instance) ¶

Writer: (setf network-settings-client-buffer-size) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

client-buffer-size.

Reader: network-settings-encryption-fns (instance) ¶

Writer: (setf network-settings-encryption-fns) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

encryption-fns.

Reader: network-settings-header-bytes (instance) ¶

Writer: (setf network-settings-header-bytes) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

header-bytes.

Reader: network-settings-htable-entry-size (instance) ¶

Writer: (setf network-settings-htable-entry-size) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

htable-entry-size.

Reader: network-settings-max-n-of-tcp-connections (instance) ¶

Writer: (setf network-settings-max-n-of-tcp-connections) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

max-n-of-tcp-connections.

Reader: network-settings-remove-obsolete-keys-interval (instance) ¶

Writer: (setf network-settings-remove-obsolete-keys-interval) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

remove-obsolete-keys-interval.

Reader: network-settings-server-buffer-size (instance) ¶

Writer: (setf network-settings-server-buffer-size) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

server-buffer-size.

Reader: network-settings-share-cache-interval-in-sec (instance) ¶

Writer: (setf network-settings-share-cache-interval-in-sec) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

share-cache-interval-in-sec.

Reader: network-settings-stop-hash-table-cleaning (instance) ¶

Writer: (setf network-settings-stop-hash-table-cleaning) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

stop-hash-table-cleaning.

Reader: network-settings-stop-sync (instance) ¶

Writer: (setf network-settings-stop-sync) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

stop-sync.

Reader: network-settings-stop-tcp-client (instance) ¶

Writer: (setf network-settings-stop-tcp-client) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

stop-tcp-client.

Reader: network-settings-stop-tcp-server (instance) ¶

Writer: (setf network-settings-stop-tcp-server) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

stop-tcp-server.

Reader: network-settings-stop-udp-server (instance) ¶

Writer: (setf network-settings-stop-udp-server) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

stop-udp-server.

Reader: network-settings-tcp-client-reconnection-attempts (instance) ¶

Writer: (setf network-settings-tcp-client-reconnection-attempts) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

tcp-client-reconnection-attempts.

Reader: network-settings-tcp-client-try-reconnect-after (instance) ¶

Writer: (setf network-settings-tcp-client-try-reconnect-after) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

tcp-client-try-reconnect-after.

Reader: network-settings-time-to-wait-if-no-data (instance) ¶

Writer: (setf network-settings-time-to-wait-if-no-data) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

time-to-wait-if-no-data.

Reader: network-settings-trailing-bytes (instance) ¶

Writer: (setf network-settings-trailing-bytes) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

trailing-bytes.

Reader: network-settings-udp-socket (instance) ¶

Writer: (setf network-settings-udp-socket) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

udp-socket.

Function: newhash-shared (key h-table-obj new-value) ¶

API for setting value

Package

cl-replica.

Source

api.lisp.

Setf expanders to this function

(setf gethash-shared).

Function: newhash-shared-no-lock (key value del-p timestamp sht settings &optional infect-p) ¶

Adds data to h-table and updates its cache

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: promote-timestamp (ts self) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Function: remhash-shared (key h-table-obj) ¶

API for deleting key

Package

cl-replica.

Source

api.lisp.

Function: remhash-shared-no-lock (key sht) ¶

Deletes key from h-table by setting del-p flag.
See Demers et al., Epidemic Algorithms for Replicated Database Maintenance (1989) to understand why one cannot simply delete a key-value pair from a replicated database.

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: remove-obsolete-keys (sht settings) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: send-echo (addr settings) ¶

Connects to own tcp server and sends a dummy message.
Is used to promote server loops by one iteration forward in order to let them close the socket.

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: send-update (key value del-p timestamp node settings &optional retry-p) ¶

Send gvalue data to another node

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: share-cache-periodically (sht settings) ¶

Provides own cache to a random node

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: share-hash-table (h-table &key this-node other-nodes message-frame-header message-frame-trail htable-entry-size cache-length server-buffer-size client-buffer-size time-to-wait-if-no-data max-n-of-tcp-connections tcp-client-try-reconnect-after tcp-client-reconnection-attempts share-cache-interval-in-sec remove-obsolete-keys-interval encryption-fns) ¶

Nondestructively converts hash-table <key,value> into:
1. hash-table <key, #(value, death-certificate, timestamp)> 2. cache (list key timestamp)
and returns shared-hash-table-object.

Package

cl-replica.

Source

api.lisp.

Reader: shared-hash-table-clients-socket-pool (instance) ¶

Writer: (setf shared-hash-table-clients-socket-pool) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

clients-socket-pool.

Reader: shared-hash-table-destroyed-p (instance) ¶

Writer: (setf shared-hash-table-destroyed-p) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

destroyed-p.

Reader: shared-hash-table-last-keys-modified (instance) ¶

Writer: (setf shared-hash-table-last-keys-modified) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

last-keys-modified.

Reader: shared-hash-table-last-keys-modified-max-length (instance) ¶

Writer: (setf shared-hash-table-last-keys-modified-max-length) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

last-keys-modified-max-length.

Reader: shared-hash-table-lock (instance) ¶

Writer: (setf shared-hash-table-lock) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

lock.

Reader: shared-hash-table-number-of-nodes (instance) ¶

Writer: (setf shared-hash-table-number-of-nodes) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

number-of-nodes.

Reader: shared-hash-table-other-nodes (instance) ¶

Writer: (setf shared-hash-table-other-nodes) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

other-nodes.

Reader: shared-hash-table-server-input-queue (instance) ¶

Writer: (setf shared-hash-table-server-input-queue) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

server-input-queue.

Reader: shared-hash-table-server-socket (instance) ¶

Writer: (setf shared-hash-table-server-socket) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

server-socket.

Reader: shared-hash-table-table (instance) ¶

Writer: (setf shared-hash-table-table) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

table.

Reader: shared-hash-table-this-node (instance) ¶

Writer: (setf shared-hash-table-this-node) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

this-node.

Reader: shared-hash-table-this-node-idx (instance) ¶

Writer: (setf shared-hash-table-this-node-idx) (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Target Slot

this-node-idx.

Function: sort-for-consistency (list-of-ips) ¶

Sort the list of ips.

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: start-server (addr queue settings) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: stop-communication (protocol settings &optional side) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Reader: timestamp-vclock (instance) ¶

Writer: (setf timestamp-vclock) (instance) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Target Slot

vclock.

Function: timestamp<= (ts-1 ts-2) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

---

5.1.4 Conditions

Condition: cache-being-shared ¶

Throwing this error blocks the API and informs a caller that
an application cannot perform any operation on the shared-hash-table. Without this explicit condition, the application would be silently blocked by the mutex inside #’provide-cache. Explicit block is much better because the application has a possibility to use error handlers

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Direct superclasses

error.

Condition: concurrent-access ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Direct superclasses

error.

Direct methods

• ts-1.
• ts-2.

Direct slots

Slot: ts-1 ¶

Initargs

:ts-1

Readers

ts-1.

Writers

This slot is read-only.

Slot: ts-2 ¶

Initargs

:ts-2

Readers

ts-2.

Writers

This slot is read-only.

---

5.1.5 Structures

Structure: timestamp ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: vclock ¶

Type

simple-vector

Initform

#()

Readers

timestamp-vclock.

Writers

(setf timestamp-vclock).

---

5.2.1 Macros

Macro: call-fn-in-interruptable-thread (delay stop-flag n-segments fn-with-args) ¶

When delay >> 1, (sleep delay) would block the thread for a long time.
This macro solves that problem by splitting delay into n-segments time intervals and by checking stop-flag n-segments times withing the delay.

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Macro: dbind-with-mutex (vars h-table-obj &body body) ¶

D-bind variables in vars to h-table-obj structure, acquire the lock, do the job in @body and release the lock

Package

cl-replica.

Source

api.lisp.

---

5.2.2 Ordinary functions

Function: as-keyword (str) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: checkout-decoder (queue decoder) ¶

Decodes and then resets the internal buffer (acc) of decoder

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: clean-shared-hash-table (sht) ¶

Deletes all keys which have death-certificates (del-p flag)

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: copy-decoder (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: copy-network-settings (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: copy-shared-hash-table (instance) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: copy-timestamp (instance) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Function: decode (vec) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: decode-buffer (buffer decoder) ¶

Implements two-step buffer decoder

Package

cl-replica.network-io.

Source

network-io.lisp.

Reader: decoder-acc (instance) ¶

Writer: (setf decoder-acc) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

acc.

Reader: decoder-acc-min-size (instance) ¶

Writer: (setf decoder-acc-min-size) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

acc-min-size.

Reader: decoder-decrypt-fn (instance) ¶

Writer: (setf decoder-decrypt-fn) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

decrypt-fn.

Reader: decoder-header-bytes (instance) ¶

Writer: (setf decoder-header-bytes) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

header-bytes.

Reader: decoder-header-size (instance) ¶

Writer: (setf decoder-header-size) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

header-size.

Function: decoder-p (object) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Reader: decoder-prev-buffer-head (instance) ¶

Writer: (setf decoder-prev-buffer-head) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

prev-buffer-head.

Reader: decoder-prev-buffer-trail (instance) ¶

Writer: (setf decoder-prev-buffer-trail) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

prev-buffer-trail.

Reader: decoder-trailing-bytes (instance) ¶

Writer: (setf decoder-trailing-bytes) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

trailing-bytes.

Reader: decoder-trailing-size (instance) ¶

Writer: (setf decoder-trailing-size) (instance) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Target Slot

trailing-size.

Function: decrypt (data decrypt-fn) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: encode (obj) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: encrypt (data encrypt-fn) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: ensure-no-msg-makers (msg header-bytes trailing-bytes operation) ¶

Throws error if message markers are found in message

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: handle-connection (connection queue server-buffer-size decoder) ¶

Accumulate buffer content until critical mass is reached. Then decode it.

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: init-decoder (settings) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: make-decoder (&key acc acc-min-size header-bytes header-size trailing-bytes trailing-size decrypt-fn prev-buffer-trail prev-buffer-head) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: network-settings-p (object) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: nshuffle (sequence) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: obj-to-str (obj) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: parse-buffer (header-bytes header-size trailing-bytes trailing-size buffer) ¶

Recursively traverses buffer and tries hard to find message frames separated by starting (header-bytes) and terminating (trailing-bytes) sequencies.
The algorithm works well even if
- small buffer size is used
- buffer contains junk data bytes from previous calls
- buffer contains ill-positioned message markers
However, if the buffer size is really tiny, some messages can get lost.
Note: buffer-size and trailing-size are provided as arguments and not calculated inside the function because a caller knows these values.

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: parse-network-address (addr) ¶

Parses tcp://192.168.1.1:5550 to (values :tcp #(192 168 1 1) 5550)

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: provide-cache (sht settings) ¶

Provides last keys modified in an extended form [(key timestamp) -> (list key value death-cert timestamp )]

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: shared-hash-table-p (object) ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Function: split-string-by-delimiter (string delimiterp) ¶

Lisp-is-cool-> (Lisp is cool) as strings. Delimiterp is a predicate.

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: start-all-network-threads (h-table-obj) ¶

API for activating inter nodes communication

Package

cl-replica.

Source

api.lisp.

Function: start-tcp-server (address port queue settings) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: start-udp-server (address port queue settings) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: stop-all-network-threads (settings) ¶

API for disabling inter-nodes communication

Package

cl-replica.

Source

api.lisp.

Function: str-to-obj (str) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: timestamp-p (object) ¶

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

Function: try-connect-until-success (socket address port settings) ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Function: vec-length (vec) ¶

Calculates the length of the vector

Package

cl-replica.vector-clock.

Source

vector-clock.lisp.

---

5.2.3 Generic functions

Generic Reader: address (condition) ¶

Package

cl-replica.network-io.

Methods

Reader Method: address ((condition network-address-parse-error)) ¶

Source

network-io.lisp.

Target Slot

address.

Generic Reader: data (condition) ¶

Package

cl-replica.hashtable-ops.

Methods

Reader Method: data ((condition malformed-data)) ¶

Source

hashtable-ops.lisp.

Target Slot

data.

Generic Reader: data (condition) ¶

Package

cl-replica.network-io.

Methods

Reader Method: data ((condition cannot-build-lisp-object-from-string)) ¶

Source

network-io.lisp.

Target Slot

data.

Generic Reader: error-msg (condition) ¶

Package

cl-replica.network-io.

Methods

Reader Method: error-msg ((condition cannot-build-lisp-object-from-string)) ¶

Source

network-io.lisp.

Target Slot

error-msg.

Reader Method: error-msg ((condition network-address-parse-error)) ¶

Source

network-io.lisp.

Target Slot

error-msg.

Generic Reader: idx (condition) ¶

Package

cl-replica.network-io.

Methods

Reader Method: idx ((condition msg-markers-found-in-data)) ¶

Source

network-io.lisp.

Target Slot

idx.

Generic Reader: marker (condition) ¶

Package

cl-replica.network-io.

Methods

Reader Method: marker ((condition msg-markers-found-in-data)) ¶

Source

network-io.lisp.

Target Slot

marker.

Generic Reader: msg (condition) ¶

Package

cl-replica.hashtable-ops.

Methods

Reader Method: msg ((condition malformed-data)) ¶

Source

hashtable-ops.lisp.

Target Slot

msg.

Generic Reader: operation (condition) ¶

Package

cl-replica.network-io.

Methods

Reader Method: operation ((condition msg-markers-found-in-data)) ¶

Source

network-io.lisp.

Target Slot

operation.

Generic Reader: ts-1 (condition) ¶

Package

cl-replica.vector-clock.

Methods

Reader Method: ts-1 ((condition concurrent-access)) ¶

Source

vector-clock.lisp.

Target Slot

ts-1.

Generic Reader: ts-2 (condition) ¶

Package

cl-replica.vector-clock.

Methods

Reader Method: ts-2 ((condition concurrent-access)) ¶

Source

vector-clock.lisp.

Target Slot

ts-2.

---

5.2.4 Conditions

Condition: cannot-build-lisp-object-from-string ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Direct superclasses

error.

Direct methods

• data.
• error-msg.

Direct slots

Slot: data ¶

Initargs

:data

Readers

data.

Writers

This slot is read-only.

Slot: error-msg ¶

Initargs

:error-msg

Readers

error-msg.

Writers

This slot is read-only.

Condition: malformed-data ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Direct superclasses

error.

Direct methods

• data.
• msg.

Direct slots

Slot: data ¶

Initargs

:data

Readers

data.

Writers

This slot is read-only.

Slot: msg ¶

Initargs

:msg

Readers

msg.

Writers

This slot is read-only.

Condition: msg-markers-found-in-data ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Direct superclasses

error.

Direct methods

• idx.
• marker.
• operation.

Direct slots

Slot: operation ¶

Initargs

:operation

Readers

operation.

Writers

This slot is read-only.

Slot: marker ¶

Initargs

:marker

Readers

marker.

Writers

This slot is read-only.

Slot: idx ¶

Initargs

:idx

Readers

idx.

Writers

This slot is read-only.

Condition: network-address-parse-error ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Direct superclasses

error.

Direct methods

• address.
• error-msg.

Direct slots

Slot: address ¶

Initargs

:address

Readers

address.

Writers

This slot is read-only.

Slot: error-msg ¶

Initargs

:error-msg

Readers

error-msg.

Writers

This slot is read-only.

---

5.2.5 Structures

Structure: decoder ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: acc ¶

Readers

decoder-acc.

Writers

(setf decoder-acc).

Slot: acc-min-size ¶

Readers

decoder-acc-min-size.

Writers

(setf decoder-acc-min-size).

Slot: header-bytes ¶

Readers

decoder-header-bytes.

Writers

(setf decoder-header-bytes).

Slot: header-size ¶

Readers

decoder-header-size.

Writers

(setf decoder-header-size).

Slot: trailing-bytes ¶

Readers

decoder-trailing-bytes.

Writers

(setf decoder-trailing-bytes).

Slot: trailing-size ¶

Readers

decoder-trailing-size.

Writers

(setf decoder-trailing-size).

Slot: decrypt-fn ¶

Readers

decoder-decrypt-fn.

Writers

(setf decoder-decrypt-fn).

Slot: prev-buffer-trail ¶

Readers

decoder-prev-buffer-trail.

Writers

(setf decoder-prev-buffer-trail).

Slot: prev-buffer-head ¶

Readers

decoder-prev-buffer-head.

Writers

(setf decoder-prev-buffer-head).

Structure: network-settings ¶

Package

cl-replica.network-io.

Source

network-io.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: htable-entry-size ¶

Readers

network-settings-htable-entry-size.

Writers

(setf network-settings-htable-entry-size).

Slot: header-bytes ¶

Readers

network-settings-header-bytes.

Writers

(setf network-settings-header-bytes).

Slot: trailing-bytes ¶

Readers

network-settings-trailing-bytes.

Writers

(setf network-settings-trailing-bytes).

Slot: server-buffer-size ¶

Readers

network-settings-server-buffer-size.

Writers

(setf network-settings-server-buffer-size).

Slot: client-buffer-size ¶

Readers

network-settings-client-buffer-size.

Writers

(setf network-settings-client-buffer-size).

Slot: udp-socket ¶

Readers

network-settings-udp-socket.

Writers

(setf network-settings-udp-socket).

Slot: stop-sync ¶

Readers

network-settings-stop-sync.

Writers

(setf network-settings-stop-sync).

Slot: time-to-wait-if-no-data ¶

Readers

network-settings-time-to-wait-if-no-data.

Writers

(setf network-settings-time-to-wait-if-no-data).

Slot: stop-udp-server ¶

Readers

network-settings-stop-udp-server.

Writers

(setf network-settings-stop-udp-server).

Slot: stop-tcp-server ¶

Readers

network-settings-stop-tcp-server.

Writers

(setf network-settings-stop-tcp-server).

Slot: stop-tcp-client ¶

Readers

network-settings-stop-tcp-client.

Writers

(setf network-settings-stop-tcp-client).

Slot: max-n-of-tcp-connections ¶

Readers

network-settings-max-n-of-tcp-connections.

Writers

(setf network-settings-max-n-of-tcp-connections).

Slot: tcp-client-try-reconnect-after ¶

Readers

network-settings-tcp-client-try-reconnect-after.

Writers

(setf network-settings-tcp-client-try-reconnect-after).

Slot: tcp-client-reconnection-attempts ¶

Readers

network-settings-tcp-client-reconnection-attempts.

Writers

(setf network-settings-tcp-client-reconnection-attempts).

Slot: share-cache-interval-in-sec ¶

Readers

network-settings-share-cache-interval-in-sec.

Writers

(setf network-settings-share-cache-interval-in-sec).

Slot: remove-obsolete-keys-interval ¶

Readers

network-settings-remove-obsolete-keys-interval.

Writers

(setf network-settings-remove-obsolete-keys-interval).

Slot: stop-hash-table-cleaning ¶

Readers

network-settings-stop-hash-table-cleaning.

Writers

(setf network-settings-stop-hash-table-cleaning).

Slot: cache-being-processed ¶

Readers

network-settings-cache-being-processed.

Writers

(setf network-settings-cache-being-processed).

Slot: encryption-fns ¶

Readers

network-settings-encryption-fns.

Writers

(setf network-settings-encryption-fns).

Structure: shared-hash-table ¶

Package

cl-replica.hashtable-ops.

Source

hashtable-ops.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: lock ¶

Initform

(sb-thread:make-mutex)

Readers

shared-hash-table-lock.

Writers

(setf shared-hash-table-lock).

Slot: this-node ¶

Readers

shared-hash-table-this-node.

Writers

(setf shared-hash-table-this-node).

Slot: other-nodes ¶

Readers

shared-hash-table-other-nodes.

Writers

(setf shared-hash-table-other-nodes).

Slot: number-of-nodes ¶

Readers

shared-hash-table-number-of-nodes.

Writers

(setf shared-hash-table-number-of-nodes).

Slot: this-node-idx ¶

Readers

shared-hash-table-this-node-idx.

Writers

(setf shared-hash-table-this-node-idx).

Slot: clients-socket-pool ¶

Readers

shared-hash-table-clients-socket-pool.

Writers

(setf shared-hash-table-clients-socket-pool).

Slot: server-socket ¶

Readers

shared-hash-table-server-socket.

Writers

(setf shared-hash-table-server-socket).

Slot: server-input-queue ¶

Readers

shared-hash-table-server-input-queue.

Writers

(setf shared-hash-table-server-input-queue).

Slot: table ¶

Readers

shared-hash-table-table.

Writers

(setf shared-hash-table-table).

Slot: last-keys-modified ¶

Readers

shared-hash-table-last-keys-modified.

Writers

(setf shared-hash-table-last-keys-modified).

Slot: last-keys-modified-max-length ¶

Readers

shared-hash-table-last-keys-modified-max-length.

Writers

(setf shared-hash-table-last-keys-modified-max-length).

Slot: destroyed-p ¶

Readers

shared-hash-table-destroyed-p.

Writers

(setf shared-hash-table-destroyed-p).

---