Liking cljdoc? Tell your friends :D

hive-artcraft.service

Native-app commands (catalog/doctor/call/control) driven by the app module's data: its catalog resource and its transport shape. :port is live through an injected or socket ControlTransport; :control-file is live through the control-file transport once :apps {"<id>" {:control-file PATH}} is configured (calls become ui.command {id}); :none has no external control surface and refuses with the remedy.

Native-app commands (catalog/doctor/call/control) driven by the app module's data:
its catalog resource and its transport shape. :port is live through an injected or socket
ControlTransport; :control-file is live through the control-file transport once
:apps {"<id>" {:control-file PATH}} is configured (calls become ui.command {id});
:none has no external control surface and refuses with the remedy.
raw docstring

callclj

(call module entries transport port-res command params request-id)

Validate an engine command against the catalog, then send it through the app's transport. :control-file apps receive it as ui.command {id}.

Validate an engine command against the catalog, then send it through the app's transport.
:control-file apps receive it as ui.command {id}.
sourceraw docstring

catalogclj

(catalog module entries query)

Describe the app's pinned vocabulary; query selects engine, mcp, control, unexpanded or one exact command id. The overview counts unexpanded sites when the catalog declares any.

Describe the app's pinned vocabulary; query selects engine, mcp, control, unexpanded or one
exact command id. The overview counts unexpanded sites when the catalog declares any.
sourceraw docstring

controlclj

(control module entries transport port-res method params request-id)

Validate a catalogued control method, then send it through the app's transport.

Validate a catalogued control method, then send it through the app's transport.
sourceraw docstring

doctorclj

(doctor module entries transport port-res)

Report catalog size (and any unexpanded static-extraction gap), transport shape, whether a transport is live, and the remedy. A :control-file transport also reports whether its file is readable and trusted, and an authenticating :port transport whether its token resolves (never the token): with none configured it says so and how to fix it.

Report catalog size (and any unexpanded static-extraction gap), transport shape, whether a
transport is live, and the remedy. A :control-file transport also reports whether its file is
readable and trusted, and an authenticating :port transport whether its token resolves (never
the token): with none configured it says so and how to fix it.
sourceraw docstring

load-catalogclj

(load-catalog module)

Read a native app's catalog resource from the classpath and validate it.

Read a native app's catalog resource from the classpath and validate it.
sourceraw docstring

resolve-transportclj

(resolve-transport module app-cfg port-res)
(resolve-transport module app-cfg port-res getenv)

Injected :transport wins; a :port app gets a loopback socket on its resolved port (carrying its token-ref and getenv when its port authenticates); a :control-file app with a configured :control-file gets the control-file transport; anything else gets nil.

Injected :transport wins; a :port app gets a loopback socket on its resolved port (carrying its
token-ref and `getenv` when its port authenticates); a :control-file app with a configured
:control-file gets the control-file transport; anything else gets nil.
sourceraw docstring

shape-remedyclj

(shape-remedy module port-res)

Human remedy for reaching an app of this transport shape.

Human remedy for reaching an app of this transport shape.
sourceraw docstring

token-refclj

(token-ref module app-cfg)

The TokenRef a :port app's requests must carry: :apps {"<id>" {:token-ref ...}} wins over the module's :app/token-ref default; nil for an app whose port does not authenticate.

The TokenRef a :port app's requests must carry: :apps {"<id>" {:token-ref ...}} wins over the
module's :app/token-ref default; nil for an app whose port does not authenticate.
sourceraw docstring

token-remedyclj

(token-remedy module)

How to give an authenticating :port app and the hive JVM the same control token.

How to give an authenticating :port app and the hive JVM the same control token.
sourceraw docstring

ui-command-requestclj

(ui-command-request built)

A :control-file app has no engine.execute: an engine command becomes ui.command {id} (non-empty params ride along as {params}).

A :control-file app has no engine.execute: an engine command becomes ui.command {id}
(non-empty params ride along as {params}).
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close