clojupyter.kernel.comm-atom — clojupyter 0.3.6

Implements support for Jupyter COMM objects which is the mechanism for synchronizing state between Jupyter clients (Notebook, Lab, others) and kernels such as Clojupyter. COMM objects serve as the basis for interactive controls such as ipywidgets.

comm-atom-proto clj protocol

comm-id clj

(comm-id comm-atom)

The Jupyter protocol ID of the COMM-ATOM.

model-ref clj

(model-ref comm-atom)

The COMM-ATOM's Jupyter Model reference identifier (a string).

origin-message clj

(origin-message comm-atom)

The message that caused the COMM-ATOM to be created.

state-set! clj

(state-set! comm-atom comm-state)

Sets the value comm-atom to be comm-state by updating the global state and sending COMM update message. comm-state must be a map serializable to JSON. Returns comm-atom.

state-update! clj

(state-update! comm-atom comm-state)

Merges comm-state into current value of comm-atom.

target clj

(target comm-atom)

The Jupyter target name to which the COMM-ATOM belongs.

unwatch clj

(unwatch comm-atom key)

Remove watch added with key key from comm-atom. Returns comm-atom.

watch clj

(watch comm-atom key fn)

Add watch to comm-atom which will subsequently be called when the value of comm-atom is updated. The observer fn fn must be a fn of 4 args: a key, the reference, its old-state, its new-state, identical to those for watch functions (internally CommAtom uses an agent for update notification), cf. add-watch for details. Returns comm-atom.

comm-atom? clj

create clj

(create jup req-message target-name comm-id comm-state)

create-and-insert clj

(create-and-insert jup req-message target-name comm-id comm-state)

insert clj

(insert comm-atom)

MESSAGE-METADATA clj