The omg Reference Manual

This is the omg Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 22:44:50 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 omg

A Common Lisp library to build fully dynamic web interfaces

Author

Pavel Kaygorodov <>

Home Page

https://github.com/hemml/OMGlib

Source Control

https://github.com/hemml/OMGlib.git

License

GPLv3

Version

0.2.0

Dependencies
  • clack (system).
  • websocket-driver-server (system).
  • bordeaux-threads (system).
  • trivial-utf-8 (system).
  • media-types (system).
  • hunchentoot (system).
  • pngload (system).
  • skippy (system).
  • cl-jpeg (system).
  • swank (system).
  • osicat (system).
  • usocket (system).
  • uiop (system).
  • find-port (system).
  • inferior-shell (system).
Source

omg.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 omg/omg.asd

Source

omg.asd.

Parent Component

omg (system).

ASDF Systems

omg.


3.1.2 omg/omg.lisp

Source

omg.asd.

Parent Component

omg (system).

Packages

omg.

Public Interface
Internals

3.1.3 omg/omgdaemon.lisp

Dependency

omg.lisp (file).

Source

omg.asd.

Parent Component

omg (system).

Packages

omgdaemon.

Public Interface
Internals

3.1.4 omg/omgui.lisp

Dependencies
Source

omg.asd.

Parent Component

omg (system).

Packages

omgui.

Public Interface
Internals

3.2 Static


3.2.1 omg/README.md

Source

omg.asd.

Parent Component

omg (system).


3.2.2 omg/LICENSE

Source

omg.asd.

Parent Component

omg (system).


4 Packages

Packages are listed by definition order.


4.1 omg

Source

omg.lisp.

Use List
  • bordeaux-threads.
  • clack.
  • common-lisp.
  • trivial-utf-8.
  • websocket-driver.
Used By List
Public Interface
Internals

4.2 omgdaemon

Source

omgdaemon.lisp.

Use List
  • common-lisp.
  • inferior-shell.
  • omg.
Used By List

omgui.

Public Interface
Internals

4.3 omgui

Source

omgui.lisp.

Use List
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *omg-last-version*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *omg-version*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +devel-version+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +omg-version-cookie+
Package

omgdaemon.

Source

omgdaemon.lisp.


5.1.2 Macros

Macro: add-event-handler (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: add-style (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: add-youtube-player (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: allow-page-close (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: append-element (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: async-bind (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: browser-case (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: check-element (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: close-current-dialog (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: create-element (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: def-session-var (vr &optional init)
Package

omg.

Source

omg.lisp.

Macro: defconstant-f (name val)
Package

omg.

Source

omg.lisp.

Macro: defmacro-f (name args &rest body)
Package

omg.

Source

omg.lisp.

Macro: defparameter-f (name val)
Package

omg.

Source

omg.lisp.

Macro: defun-f (name args &rest body)
Package

omg.

Source

omg.lisp.

Macro: defun-r (name args &rest body)

Define a server-side function and allow to call it from browser side

Package

omg.

Source

omg.lisp.

Macro: defvar-f (name val)
Package

omg.

Source

omg.lisp.

Macro: dialog-ok (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: disable-back-button (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: disable-scroll (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: dragabble-list-elements (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: dragabble-list-insert (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: dragabble-list-insert-position (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: element-height (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: element-width (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: enable-back-button (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: enable-scroll (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: ensure-element (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: ensure-last-version (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: execute-after (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: find-widget (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: gensym2 (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: get-dialog-data (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: get-element-id (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: in-debug-session (&rest body)
Package

omg.

Source

omg.lisp.

Macro: js-get-element-by-id (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: js-parse-float (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsacos (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsasin (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsatan (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsatan2 (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jscos (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsfloor (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsln (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jslog (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsmax (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsmin (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jsrandom (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jssin (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: jstan (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: load-js-script (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: local-storage (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: make-dialog (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: make-dragabble-list (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: make-js-function (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: make-js-object (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: make-svg (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: modal-dialog (header-text dialog-text &key lines)
Package

omgui.

Source

omgui.lisp.

Macro: on-element-remove (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: page-height (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: page-width (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: parent-element (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: prevent-page-close (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: register-hash-cb (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: remove-element (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: rm-event-handler (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: session-storage (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: show-notification (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: thread-in-session (&rest code)
Package

omg.

Source

omg.lisp.

Macro: visible-height (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: visible-left (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: visible-top (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: visible-width (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: winref (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: with-session (sess &rest body)

Execute commands inside session sess

Package

omg.

Source

omg.lisp.


5.1.3 Ordinary functions

Function: add-to-boot (f)
Package

omg.

Source

omg.lisp.

Function: add-to-root-html (html)
Package

omg.

Source

omg.lisp.

Function: commit-devel ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: commit-notify (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: commit-production ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: current-session-id ()
Package

omg.

Source

omg.lisp.

Function: find-session (sid)

Return session object with specific ID

Package

omg.

Source

omg.lisp.

Function: get-my-version ()
Package

omgui.

Source

omgui.lisp.

Function: get-omg-cookie-name ()
Package

omgui.

Source

omgui.lisp.

Function: kill-server ()
Package

omg.

Source

omg.lisp.

Function: make-omg-daemon (port &key swank-comm-style)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: make-pwa (&key name short-name display theme-color background-color icon-path)
Package

omg.

Source

omg.lisp.

Function: omg-init (port)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: remote-exec (cmd &optional nowait)

Execute the code on the browser-side. If the *current-session* set, the code will be executed
within the specific session, otherwise, the code will be executed in all sessions and all the return values are returned as a list. If the nowait is T, the function will retrurn NIL immediately, without waiting result from the remote side.

Package

omg.

Source

omg.lisp.

Function: restart-server (&rest args)
Package

omg.

Source

omg.lisp.

Function: rm-from-boot (f)
Package

omg.

Source

omg.lisp.

Function: set-boot (f)
Package

omg.

Source

omg.lisp.

Function: set-debug-session (sid)
Package

omg.

Source

omg.lisp.

Function: set-root-html (html)
Package

omg.

Source

omg.lisp.

Function: start-server (&rest args)
Package

omg.

Source

omg.lisp.

Function: steal-swank ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: version-set-sym (var val)
Package

omgdaemon.

Source

omgdaemon.lisp.


5.1.4 Standalone methods

Reader Method: socket ((omg-session omg-session))

automatically generated reader method

Package

websocket-driver.ws.base.

Source

omg.lisp.

Target Slot

socket.


5.2 Internals


5.2.1 Constants

Constant: sid-length
Package

omg.

Source

omg.lisp.


5.2.2 Special variables

Special Variable: *backcnt*
Package

omgui.

Source

omgui.lisp.

Special Variable: *beforeunload-installed*
Package

omgui.

Source

omgui.lisp.

Special Variable: *boot-functions*
Package

omg.

Source

omg.lisp.

Special Variable: *current-res*
Package

omg.

Source

omg.lisp.

Special Variable: *current-session*
Package

omg.

Source

omg.lisp.

Special Variable: *debug-session-id*
Package

omg.

Source

omg.lisp.

Special Variable: *dialog-stack*
Package

omgui.

Source

omgui.lisp.

Special Variable: *dialog-wait-list*
Package

omgui.

Source

omgui.lisp.

Special Variable: *disable-back*
Package

omgui.

Source

omgui.lisp.

Special Variable: *disable-page-unload*
Package

omgui.

Source

omgui.lisp.

Special Variable: *exportable-expressions*
Package

omg.

Source

omg.lisp.

Special Variable: *exported-function-names*
Package

omg.

Source

omg.lisp.

Special Variable: *extra-html*
Package

omg.

Source

omg.lisp.

Special Variable: *fback*
Package

omgui.

Source

omgui.lisp.

Special Variable: *forks*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *giant-hash-lock*
Package

omg.

Source

omg.lisp.

Special Variable: *gimme-path*
Package

omg.

Source

omg.lisp.

Special Variable: *gimme-wait-list*
Package

omg.

Source

omg.lisp.

Special Variable: *global-event-handlers*
Package

omgui.

Source

omgui.lisp.

Special Variable: *global-observer-handlers*
Package

omgui.

Source

omgui.lisp.

Special Variable: *hash-change-cbs*
Package

omgui.

Source

omgui.lisp.

Special Variable: *html-path*
Package

omg.

Source

omg.lisp.

Special Variable: *in-f-macro*
Package

omg.

Source

omg.lisp.

Special Variable: *in-rpc*
Package

omg.

Source

omg.lisp.

Special Variable: *js-path*
Package

omg.

Source

omg.lisp.

Special Variable: *last-args*
Package

omg.

Source

omg.lisp.

Special Variable: *local-compile*
Package

omg.

Source

omg.lisp.

Special Variable: *local-lambdas*
Package

omg.

Source

omg.lisp.

Special Variable: *main-lock*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *main-st-i*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *main-st-o*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *notification-container*
Package

omgui.

Source

omgui.lisp.

Special Variable: *omg-thread-list*
Package

omg.

Source

omg.lisp.

Special Variable: *onpopstate-installed*
Package

omgui.

Source

omgui.lisp.

Special Variable: *port*
Package

omg.

Source

omg.lisp.

Special Variable: *prevent-devel-startup*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *proxy-port*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *proxy-sock*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *pwa-icon*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-icon-file*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-icon-type*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-mainfest*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-name*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-path*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-sw-js*
Package

omg.

Source

omg.lisp.

Special Variable: *pwa-sw-js-name*
Package

omg.

Source

omg.lisp.

Special Variable: *root-path*
Package

omg.

Source

omg.lisp.

Special Variable: *rpc-functions*
Package

omg.

Source

omg.lisp.

Special Variable: *rpc-path*
Package

omg.

Source

omg.lisp.

Special Variable: *scroll-disabled*
Package

omgui.

Source

omgui.lisp.

Special Variable: *serv*
Package

omg.

Source

omg.lisp.

Special Variable: *server-set-list*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *server-set-sem*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *session-list*
Package

omg.

Source

omg.lisp.

Special Variable: *session-timeout*
Package

omg.

Source

omg.lisp.

Special Variable: *ssl-cert*
Package

omg.

Source

omg.lisp.

Special Variable: *ssl-key*
Package

omg.

Source

omg.lisp.

Special Variable: *style-cache*
Package

omgui.

Source

omgui.lisp.

Special Variable: *swank-comm-style*
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: *takit-path*
Package

omg.

Source

omg.lisp.

Special Variable: *takit-wait-list*
Package

omg.

Source

omg.lisp.

Special Variable: *use-wss*
Package

omg.

Source

omg.lisp.

Special Variable: *user-uri-handler*
Package

omg.

Source

omg.lisp.

Special Variable: *wl-timeout*
Package

omg.

Source

omg.lisp.

Special Variable: *ws-path*
Package

omg.

Source

omg.lisp.

Special Variable: *youtube-js-loaded*
Package

omgui.

Source

omgui.lisp.

Special Variable: +app_prefix+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +cr-lf+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +keyword-pkg+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +nil-str+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +nl-code+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +omg-images-path+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +proxy-chunk-size+
Package

omgdaemon.

Source

omgdaemon.lisp.

Special Variable: +version-cookie-prefix+
Package

omgdaemon.

Source

omgdaemon.lisp.


5.2.3 Macros

Macro: buf-append (b1 b2)
Package

omgdaemon.

Source

omgdaemon.lisp.

Macro: curtain (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: deep-oget-1 (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: dialog-frame (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: dialog-header (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: dialog-table (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: element-on-page-p (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: form-button-row (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: form-line (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: js-string-split (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: make-def-macro-f (op)

Just a macro to generate macros for f-functions and f-macros definintions (defun-f, defmacro-f, etc...)

Package

omg.

Source

omg.lisp.

Macro: make-var-macro-f (op)

A macro for variables-parameters-constants definitions

Package

omg.

Source

omg.lisp.

Macro: random-id (&rest args)
Package

omgui.

Source

omgui.lisp.

Macro: system-font (&rest args)
Package

omgui.

Source

omgui.lisp.


5.2.4 Ordinary functions

Function: boot-f ()

The boot code, will be executed on the browser-side just after the socket is connected.

Package

omg.

Source

omg.lisp.

Function: commit (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: compile-to-js (code pkg &optional reskey)

Return JS for the code, pkg is current package for compilation context.
The reskey is the *gimme-wait-list* key, the place to store compilation result.

Package

omg.

Source

omg.lisp.

Function: dialog-wl-send (id dat)
Package

omgui.

Source

omgui.lisp.

Function: ensure-version-working (version &key no-cmd)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: exec-local-lambda (idargs)
Package

omg.

Source

omg.lisp.

Function: exec-remote-macro (name args)

Execute in a browser a code of the macro with the specific name and argments.
Called by JSCL compiler while compling lisp code to JS. We have to execute macros on the browser-side, because all side-effects, produced by macros, must have a place in the browser.

Package

omg.

Source

omg.lisp.

Function: execv (program args)

Replace current executable with another one.

Package

omgdaemon.

Source

omgdaemon.lisp.

Function: f-eval (arg)

Smart-eval – evaluate everything, but expotrable expressions, lambdas and function names

Package

omg.

Source

omg.lisp.

Function: get-cmd-res (cmd)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: get-last-version ()
Package

omgui.

Source

omgui.lisp.

Function: get-main-js ()

Return the JS code, including JSCL and OMG parts glued.

Package

omg.

Source

omg.lisp.

Function: get-root-html ()

Return a somple HTML with JS injected.

Package

omg.

Source

omg.lisp.

Function: get-str-from (s len)
Package

omg.

Source

omg.lisp.

Function: get-top-version ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: get-version-info (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: gethash-lock (key hash)
Package

omg.

Source

omg.lisp.

Function: (setf gethash-lock) (key hash)
Package

omg.

Source

omg.lisp.

Function: gimme (sym)

The handler for gimme-requests, which are used to request unknown symbols from the server-side.

Package

omg.

Source

omg.lisp.

Function: has-ssl-p ()
Package

omg.

Source

omg.lisp.

Function: kill-all-threads ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: kill-version (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: make-docker-image (&optional tag)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: make-tmp-version (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: make-ws (env)

Return the websocket for the new session. Also, creates the session object.

Package

omg.

Source

omg.lisp.

Function: makimg (path)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: need-reload ()
Package

omgui.

Source

omgui.lisp.

Function: posix-fork ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: proxy (port)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: proxy-job (cs)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: random-key (h &optional len)

Make a random hash-table key

Package

omg.

Source

omg.lisp.

Function: random-string (len)

Generate a random stgring of length len

Package

omg.

Source

omg.lisp.

Function: random-symbol (len)

Make a random symbol

Package

omg.

Source

omg.lisp.

Function: register-rpc (name)
Package

omg.

Source

omg.lisp.

Function: remote-unintern (sym)

Unintern the symbol within all active sessions, mandatory to reflect symbol redefinition. The next try to intern the symbol in browser-side will cause new symbol fetch.

Package

omg.

Source

omg.lisp.

Function: replace-all (string part replacement &key test)

Returns a new string in which all the occurences of the part is replaced with replacement.

Package

omg.

Source

omg.lisp.

Function: restart-version (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: rpc-wrapper (op args pkg)

The wrapper for RPC requests, used to allow call browser-side functions from RPC funcs.

Package

omg.

Source

omg.lisp.

Function: run-daemon ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: run-main ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: run-version (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: send-cmd-to (version cmd)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: serv (env)
Package

omg.

Source

omg.lisp.

Function: stop-proxy ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: sys-execv (program argv)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: takit (key res)

The handler for takit-requests. This requests are used to return macro expansion results from browser-side

Package

omg.

Source

omg.lisp.

Function: tmp-version-p (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: update-omg ()
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: use-wss-p ()
Package

omg.

Source

omg.lisp.

Function: version-alive-p (version &key no-cmd)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: version-available (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: version-file-path (version)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: version-path-p (path)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: wait-for-commit-version (tv v pid)
Package

omgdaemon.

Source

omgdaemon.lisp.

Function: wait-for-version-startup (version &optional timeout)
Package

omgdaemon.

Source

omgdaemon.lisp.


5.2.5 Generic functions

Generic Reader: get-id (object)
Package

omg.

Methods
Reader Method: get-id ((omg-session omg-session))

automatically generated reader method

Source

omg.lisp.

Target Slot

ses-id.

Generic Reader: last-active (object)
Package

omg.

Methods
Reader Method: last-active ((omg-session omg-session))

automatically generated reader method

Source

omg.lisp.

Target Slot

last-active.

Generic Reader: wait-list (object)
Package

omg.

Methods
Reader Method: wait-list ((omg-session omg-session))

automatically generated reader method

Source

omg.lisp.

Target Slot

wait-list.


5.2.6 Classes

Class: omg-session

The session object, holding the session socket, the wait-list holding semaphores and storing result data from remote-exec calls

Package

omg.

Source

omg.lisp.

Direct methods
Direct slots
Slot: socket
Package

websocket-driver.ws.base.

Initform

(error "socket required")

Initargs

:socket

Readers

socket.

Writers

This slot is read-only.

Slot: ses-id
Initform

(omg::random-symbol omg::|sid-length|)

Readers

get-id.

Writers

This slot is read-only.

Slot: last-active
Initform

(get-universal-time)

Readers

last-active.

Writers

This slot is read-only.

Slot: wait-list
Initform

(make-hash-table)

Readers

wait-list.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

(
(setf gethash-lock): Private ordinary functions

A
add-event-handler: Public macros
add-style: Public macros
add-to-boot: Public ordinary functions
add-to-root-html: Public ordinary functions
add-youtube-player: Public macros
allow-page-close: Public macros
append-element: Public macros
async-bind: Public macros

B
boot-f: Private ordinary functions
browser-case: Public macros
buf-append: Private macros

C
check-element: Public macros
close-current-dialog: Public macros
commit: Private ordinary functions
commit-devel: Public ordinary functions
commit-notify: Public ordinary functions
commit-production: Public ordinary functions
compile-to-js: Private ordinary functions
create-element: Public macros
current-session-id: Public ordinary functions
curtain: Private macros

D
deep-oget-1: Private macros
def-session-var: Public macros
defconstant-f: Public macros
defmacro-f: Public macros
defparameter-f: Public macros
defun-f: Public macros
defun-r: Public macros
defvar-f: Public macros
dialog-frame: Private macros
dialog-header: Private macros
dialog-ok: Public macros
dialog-table: Private macros
dialog-wl-send: Private ordinary functions
disable-back-button: Public macros
disable-scroll: Public macros
dragabble-list-elements: Public macros
dragabble-list-insert: Public macros
dragabble-list-insert-position: Public macros

E
element-height: Public macros
element-on-page-p: Private macros
element-width: Public macros
enable-back-button: Public macros
enable-scroll: Public macros
ensure-element: Public macros
ensure-last-version: Public macros
ensure-version-working: Private ordinary functions
exec-local-lambda: Private ordinary functions
exec-remote-macro: Private ordinary functions
execute-after: Public macros
execv: Private ordinary functions

F
f-eval: Private ordinary functions
find-session: Public ordinary functions
find-widget: Public macros
form-button-row: Private macros
form-line: Private macros
Function, (setf gethash-lock): Private ordinary functions
Function, add-to-boot: Public ordinary functions
Function, add-to-root-html: Public ordinary functions
Function, boot-f: Private ordinary functions
Function, commit: Private ordinary functions
Function, commit-devel: Public ordinary functions
Function, commit-notify: Public ordinary functions
Function, commit-production: Public ordinary functions
Function, compile-to-js: Private ordinary functions
Function, current-session-id: Public ordinary functions
Function, dialog-wl-send: Private ordinary functions
Function, ensure-version-working: Private ordinary functions
Function, exec-local-lambda: Private ordinary functions
Function, exec-remote-macro: Private ordinary functions
Function, execv: Private ordinary functions
Function, f-eval: Private ordinary functions
Function, find-session: Public ordinary functions
Function, get-cmd-res: Private ordinary functions
Function, get-last-version: Private ordinary functions
Function, get-main-js: Private ordinary functions
Function, get-my-version: Public ordinary functions
Function, get-omg-cookie-name: Public ordinary functions
Function, get-root-html: Private ordinary functions
Function, get-str-from: Private ordinary functions
Function, get-top-version: Private ordinary functions
Function, get-version-info: Private ordinary functions
Function, gethash-lock: Private ordinary functions
Function, gimme: Private ordinary functions
Function, has-ssl-p: Private ordinary functions
Function, kill-all-threads: Private ordinary functions
Function, kill-server: Public ordinary functions
Function, kill-version: Private ordinary functions
Function, make-docker-image: Private ordinary functions
Function, make-omg-daemon: Public ordinary functions
Function, make-pwa: Public ordinary functions
Function, make-tmp-version: Private ordinary functions
Function, make-ws: Private ordinary functions
Function, makimg: Private ordinary functions
Function, need-reload: Private ordinary functions
Function, omg-init: Public ordinary functions
Function, posix-fork: Private ordinary functions
Function, proxy: Private ordinary functions
Function, proxy-job: Private ordinary functions
Function, random-key: Private ordinary functions
Function, random-string: Private ordinary functions
Function, random-symbol: Private ordinary functions
Function, register-rpc: Private ordinary functions
Function, remote-exec: Public ordinary functions
Function, remote-unintern: Private ordinary functions
Function, replace-all: Private ordinary functions
Function, restart-server: Public ordinary functions
Function, restart-version: Private ordinary functions
Function, rm-from-boot: Public ordinary functions
Function, rpc-wrapper: Private ordinary functions
Function, run-daemon: Private ordinary functions
Function, run-main: Private ordinary functions
Function, run-version: Private ordinary functions
Function, send-cmd-to: Private ordinary functions
Function, serv: Private ordinary functions
Function, set-boot: Public ordinary functions
Function, set-debug-session: Public ordinary functions
Function, set-root-html: Public ordinary functions
Function, start-server: Public ordinary functions
Function, steal-swank: Public ordinary functions
Function, stop-proxy: Private ordinary functions
Function, sys-execv: Private ordinary functions
Function, takit: Private ordinary functions
Function, tmp-version-p: Private ordinary functions
Function, update-omg: Private ordinary functions
Function, use-wss-p: Private ordinary functions
Function, version-alive-p: Private ordinary functions
Function, version-available: Private ordinary functions
Function, version-file-path: Private ordinary functions
Function, version-path-p: Private ordinary functions
Function, version-set-sym: Public ordinary functions
Function, wait-for-commit-version: Private ordinary functions
Function, wait-for-version-startup: Private ordinary functions

G
Generic Function, get-id: Private generic functions
Generic Function, last-active: Private generic functions
Generic Function, wait-list: Private generic functions
gensym2: Public macros
get-cmd-res: Private ordinary functions
get-dialog-data: Public macros
get-element-id: Public macros
get-id: Private generic functions
get-id: Private generic functions
get-last-version: Private ordinary functions
get-main-js: Private ordinary functions
get-my-version: Public ordinary functions
get-omg-cookie-name: Public ordinary functions
get-root-html: Private ordinary functions
get-str-from: Private ordinary functions
get-top-version: Private ordinary functions
get-version-info: Private ordinary functions
gethash-lock: Private ordinary functions
gimme: Private ordinary functions

H
has-ssl-p: Private ordinary functions

I
in-debug-session: Public macros

J
js-get-element-by-id: Public macros
js-parse-float: Public macros
js-string-split: Private macros
jsacos: Public macros
jsasin: Public macros
jsatan: Public macros
jsatan2: Public macros
jscos: Public macros
jsfloor: Public macros
jsln: Public macros
jslog: Public macros
jsmax: Public macros
jsmin: Public macros
jsrandom: Public macros
jssin: Public macros
jstan: Public macros

K
kill-all-threads: Private ordinary functions
kill-server: Public ordinary functions
kill-version: Private ordinary functions

L
last-active: Private generic functions
last-active: Private generic functions
load-js-script: Public macros
local-storage: Public macros

M
Macro, add-event-handler: Public macros
Macro, add-style: Public macros
Macro, add-youtube-player: Public macros
Macro, allow-page-close: Public macros
Macro, append-element: Public macros
Macro, async-bind: Public macros
Macro, browser-case: Public macros
Macro, buf-append: Private macros
Macro, check-element: Public macros
Macro, close-current-dialog: Public macros
Macro, create-element: Public macros
Macro, curtain: Private macros
Macro, deep-oget-1: Private macros
Macro, def-session-var: Public macros
Macro, defconstant-f: Public macros
Macro, defmacro-f: Public macros
Macro, defparameter-f: Public macros
Macro, defun-f: Public macros
Macro, defun-r: Public macros
Macro, defvar-f: Public macros
Macro, dialog-frame: Private macros
Macro, dialog-header: Private macros
Macro, dialog-ok: Public macros
Macro, dialog-table: Private macros
Macro, disable-back-button: Public macros
Macro, disable-scroll: Public macros
Macro, dragabble-list-elements: Public macros
Macro, dragabble-list-insert: Public macros
Macro, dragabble-list-insert-position: Public macros
Macro, element-height: Public macros
Macro, element-on-page-p: Private macros
Macro, element-width: Public macros
Macro, enable-back-button: Public macros
Macro, enable-scroll: Public macros
Macro, ensure-element: Public macros
Macro, ensure-last-version: Public macros
Macro, execute-after: Public macros
Macro, find-widget: Public macros
Macro, form-button-row: Private macros
Macro, form-line: Private macros
Macro, gensym2: Public macros
Macro, get-dialog-data: Public macros
Macro, get-element-id: Public macros
Macro, in-debug-session: Public macros
Macro, js-get-element-by-id: Public macros
Macro, js-parse-float: Public macros
Macro, js-string-split: Private macros
Macro, jsacos: Public macros
Macro, jsasin: Public macros
Macro, jsatan: Public macros
Macro, jsatan2: Public macros
Macro, jscos: Public macros
Macro, jsfloor: Public macros
Macro, jsln: Public macros
Macro, jslog: Public macros
Macro, jsmax: Public macros
Macro, jsmin: Public macros
Macro, jsrandom: Public macros
Macro, jssin: Public macros
Macro, jstan: Public macros
Macro, load-js-script: Public macros
Macro, local-storage: Public macros
Macro, make-def-macro-f: Private macros
Macro, make-dialog: Public macros
Macro, make-dragabble-list: Public macros
Macro, make-js-function: Public macros
Macro, make-js-object: Public macros
Macro, make-svg: Public macros
Macro, make-var-macro-f: Private macros
Macro, modal-dialog: Public macros
Macro, on-element-remove: Public macros
Macro, page-height: Public macros
Macro, page-width: Public macros
Macro, parent-element: Public macros
Macro, prevent-page-close: Public macros
Macro, random-id: Private macros
Macro, register-hash-cb: Public macros
Macro, remove-element: Public macros
Macro, rm-event-handler: Public macros
Macro, session-storage: Public macros
Macro, show-notification: Public macros
Macro, system-font: Private macros
Macro, thread-in-session: Public macros
Macro, visible-height: Public macros
Macro, visible-left: Public macros
Macro, visible-top: Public macros
Macro, visible-width: Public macros
Macro, winref: Public macros
Macro, with-session: Public macros
make-def-macro-f: Private macros
make-dialog: Public macros
make-docker-image: Private ordinary functions
make-dragabble-list: Public macros
make-js-function: Public macros
make-js-object: Public macros
make-omg-daemon: Public ordinary functions
make-pwa: Public ordinary functions
make-svg: Public macros
make-tmp-version: Private ordinary functions
make-var-macro-f: Private macros
make-ws: Private ordinary functions
makimg: Private ordinary functions
Method, get-id: Private generic functions
Method, last-active: Private generic functions
Method, socket: Public standalone methods
Method, wait-list: Private generic functions
modal-dialog: Public macros

N
need-reload: Private ordinary functions

O
omg-init: Public ordinary functions
on-element-remove: Public macros

P
page-height: Public macros
page-width: Public macros
parent-element: Public macros
posix-fork: Private ordinary functions
prevent-page-close: Public macros
proxy: Private ordinary functions
proxy-job: Private ordinary functions

R
random-id: Private macros
random-key: Private ordinary functions
random-string: Private ordinary functions
random-symbol: Private ordinary functions
register-hash-cb: Public macros
register-rpc: Private ordinary functions
remote-exec: Public ordinary functions
remote-unintern: Private ordinary functions
remove-element: Public macros
replace-all: Private ordinary functions
restart-server: Public ordinary functions
restart-version: Private ordinary functions
rm-event-handler: Public macros
rm-from-boot: Public ordinary functions
rpc-wrapper: Private ordinary functions
run-daemon: Private ordinary functions
run-main: Private ordinary functions
run-version: Private ordinary functions

S
send-cmd-to: Private ordinary functions
serv: Private ordinary functions
session-storage: Public macros
set-boot: Public ordinary functions
set-debug-session: Public ordinary functions
set-root-html: Public ordinary functions
show-notification: Public macros
socket: Public standalone methods
start-server: Public ordinary functions
steal-swank: Public ordinary functions
stop-proxy: Private ordinary functions
sys-execv: Private ordinary functions
system-font: Private macros

T
takit: Private ordinary functions
thread-in-session: Public macros
tmp-version-p: Private ordinary functions

U
update-omg: Private ordinary functions
use-wss-p: Private ordinary functions

V
version-alive-p: Private ordinary functions
version-available: Private ordinary functions
version-file-path: Private ordinary functions
version-path-p: Private ordinary functions
version-set-sym: Public ordinary functions
visible-height: Public macros
visible-left: Public macros
visible-top: Public macros
visible-width: Public macros

W
wait-for-commit-version: Private ordinary functions
wait-for-version-startup: Private ordinary functions
wait-list: Private generic functions
wait-list: Private generic functions
winref: Public macros
with-session: Public macros


A.3 Variables

Jump to:   *   +  
C   L   S   W  
Index Entry  Section

*
*backcnt*: Private special variables
*beforeunload-installed*: Private special variables
*boot-functions*: Private special variables
*current-res*: Private special variables
*current-session*: Private special variables
*debug-session-id*: Private special variables
*dialog-stack*: Private special variables
*dialog-wait-list*: Private special variables
*disable-back*: Private special variables
*disable-page-unload*: Private special variables
*exportable-expressions*: Private special variables
*exported-function-names*: Private special variables
*extra-html*: Private special variables
*fback*: Private special variables
*forks*: Private special variables
*giant-hash-lock*: Private special variables
*gimme-path*: Private special variables
*gimme-wait-list*: Private special variables
*global-event-handlers*: Private special variables
*global-observer-handlers*: Private special variables
*hash-change-cbs*: Private special variables
*html-path*: Private special variables
*in-f-macro*: Private special variables
*in-rpc*: Private special variables
*js-path*: Private special variables
*last-args*: Private special variables
*local-compile*: Private special variables
*local-lambdas*: Private special variables
*main-lock*: Private special variables
*main-st-i*: Private special variables
*main-st-o*: Private special variables
*notification-container*: Private special variables
*omg-last-version*: Public special variables
*omg-thread-list*: Private special variables
*omg-version*: Public special variables
*onpopstate-installed*: Private special variables
*port*: Private special variables
*prevent-devel-startup*: Private special variables
*proxy-port*: Private special variables
*proxy-sock*: Private special variables
*pwa-icon*: Private special variables
*pwa-icon-file*: Private special variables
*pwa-icon-type*: Private special variables
*pwa-mainfest*: Private special variables
*pwa-name*: Private special variables
*pwa-path*: Private special variables
*pwa-sw-js*: Private special variables
*pwa-sw-js-name*: Private special variables
*root-path*: Private special variables
*rpc-functions*: Private special variables
*rpc-path*: Private special variables
*scroll-disabled*: Private special variables
*serv*: Private special variables
*server-set-list*: Private special variables
*server-set-sem*: Private special variables
*session-list*: Private special variables
*session-timeout*: Private special variables
*ssl-cert*: Private special variables
*ssl-key*: Private special variables
*style-cache*: Private special variables
*swank-comm-style*: Private special variables
*takit-path*: Private special variables
*takit-wait-list*: Private special variables
*use-wss*: Private special variables
*user-uri-handler*: Private special variables
*wl-timeout*: Private special variables
*ws-path*: Private special variables
*youtube-js-loaded*: Private special variables

+
+app_prefix+: Private special variables
+cr-lf+: Private special variables
+devel-version+: Public special variables
+keyword-pkg+: Private special variables
+nil-str+: Private special variables
+nl-code+: Private special variables
+omg-images-path+: Private special variables
+omg-version-cookie+: Public special variables
+proxy-chunk-size+: Private special variables
+version-cookie-prefix+: Private special variables

C
Constant, sid-length: Private constants

L
last-active: Private classes

S
ses-id: Private classes
sid-length: Private constants
Slot, last-active: Private classes
Slot, ses-id: Private classes
Slot, socket: Private classes
Slot, wait-list: Private classes
socket: Private classes
Special Variable, *backcnt*: Private special variables
Special Variable, *beforeunload-installed*: Private special variables
Special Variable, *boot-functions*: Private special variables
Special Variable, *current-res*: Private special variables
Special Variable, *current-session*: Private special variables
Special Variable, *debug-session-id*: Private special variables
Special Variable, *dialog-stack*: Private special variables
Special Variable, *dialog-wait-list*: Private special variables
Special Variable, *disable-back*: Private special variables
Special Variable, *disable-page-unload*: Private special variables
Special Variable, *exportable-expressions*: Private special variables
Special Variable, *exported-function-names*: Private special variables
Special Variable, *extra-html*: Private special variables
Special Variable, *fback*: Private special variables
Special Variable, *forks*: Private special variables
Special Variable, *giant-hash-lock*: Private special variables
Special Variable, *gimme-path*: Private special variables
Special Variable, *gimme-wait-list*: Private special variables
Special Variable, *global-event-handlers*: Private special variables
Special Variable, *global-observer-handlers*: Private special variables
Special Variable, *hash-change-cbs*: Private special variables
Special Variable, *html-path*: Private special variables
Special Variable, *in-f-macro*: Private special variables
Special Variable, *in-rpc*: Private special variables
Special Variable, *js-path*: Private special variables
Special Variable, *last-args*: Private special variables
Special Variable, *local-compile*: Private special variables
Special Variable, *local-lambdas*: Private special variables
Special Variable, *main-lock*: Private special variables
Special Variable, *main-st-i*: Private special variables
Special Variable, *main-st-o*: Private special variables
Special Variable, *notification-container*: Private special variables
Special Variable, *omg-last-version*: Public special variables
Special Variable, *omg-thread-list*: Private special variables
Special Variable, *omg-version*: Public special variables
Special Variable, *onpopstate-installed*: Private special variables
Special Variable, *port*: Private special variables
Special Variable, *prevent-devel-startup*: Private special variables
Special Variable, *proxy-port*: Private special variables
Special Variable, *proxy-sock*: Private special variables
Special Variable, *pwa-icon*: Private special variables
Special Variable, *pwa-icon-file*: Private special variables
Special Variable, *pwa-icon-type*: Private special variables
Special Variable, *pwa-mainfest*: Private special variables
Special Variable, *pwa-name*: Private special variables
Special Variable, *pwa-path*: Private special variables
Special Variable, *pwa-sw-js*: Private special variables
Special Variable, *pwa-sw-js-name*: Private special variables
Special Variable, *root-path*: Private special variables
Special Variable, *rpc-functions*: Private special variables
Special Variable, *rpc-path*: Private special variables
Special Variable, *scroll-disabled*: Private special variables
Special Variable, *serv*: Private special variables
Special Variable, *server-set-list*: Private special variables
Special Variable, *server-set-sem*: Private special variables
Special Variable, *session-list*: Private special variables
Special Variable, *session-timeout*: Private special variables
Special Variable, *ssl-cert*: Private special variables
Special Variable, *ssl-key*: Private special variables
Special Variable, *style-cache*: Private special variables
Special Variable, *swank-comm-style*: Private special variables
Special Variable, *takit-path*: Private special variables
Special Variable, *takit-wait-list*: Private special variables
Special Variable, *use-wss*: Private special variables
Special Variable, *user-uri-handler*: Private special variables
Special Variable, *wl-timeout*: Private special variables
Special Variable, *ws-path*: Private special variables
Special Variable, *youtube-js-loaded*: Private special variables
Special Variable, +app_prefix+: Private special variables
Special Variable, +cr-lf+: Private special variables
Special Variable, +devel-version+: Public special variables
Special Variable, +keyword-pkg+: Private special variables
Special Variable, +nil-str+: Private special variables
Special Variable, +nl-code+: Private special variables
Special Variable, +omg-images-path+: Private special variables
Special Variable, +omg-version-cookie+: Public special variables
Special Variable, +proxy-chunk-size+: Private special variables
Special Variable, +version-cookie-prefix+: Private special variables

W
wait-list: Private classes