Liking cljdoc? Tell your friends :D
Clojure only.

wagoe.realtime.shell.module-wiring

Integrant wiring for the realtime module.

Config key: :wagoe/realtime {:provider :memory | :redis ; :in-memory is the pre-1.0 spelling ;; redis only: :host "localhost" :port 6379 :password "..." :database 0 ; auth + db selection (production) :timeout 2000 ; socket timeout ms :max-total 8 :max-idle 8 :min-idle 0 ; publish-pool sizing :channel "wagoe:realtime:bus" :key-prefix "realtime" :subscribe-timeout-ms 5000 ; await window for subscription to go live :jwt-verifier <IJWTVerifier ref>}

The local connection registry is in-memory under BOTH providers (sockets are node-local). Only the pub/sub manager and the bus differ. Under :redis the component opens two Jedis pools — one for topic subscriptions (pub/sub manager) and one inside the bus for publish — both closed on halt.

IMPORTANT: the web/WS server component MUST depend on :wagoe/realtime so that start-subscriber! has completed (subscription live) before any WebSocket connection is accepted.

Integrant wiring for the realtime module.

Config key: :wagoe/realtime
  {:provider :memory | :redis        ; :in-memory is the pre-1.0 spelling
   ;; redis only:
   :host "localhost" :port 6379
   :password "..." :database 0        ; auth + db selection (production)
   :timeout 2000                        ; socket timeout ms
   :max-total 8 :max-idle 8 :min-idle 0 ; publish-pool sizing
   :channel "wagoe:realtime:bus"
   :key-prefix "realtime"
   :subscribe-timeout-ms 5000           ; await window for subscription to go live
   :jwt-verifier <IJWTVerifier ref>}

The local connection registry is in-memory under BOTH providers (sockets are
node-local). Only the pub/sub manager and the bus differ. Under :redis the
component opens two Jedis pools — one for topic subscriptions (pub/sub
manager) and one inside the bus for publish — both closed on halt.

IMPORTANT: the web/WS server component MUST depend on :wagoe/realtime so
that start-subscriber! has completed (subscription live) before any WebSocket
connection is accepted.
raw docstring

normalize-providerclj

(normalize-provider provider)

The provider keyword in the vocabulary cache, realtime, events and jobs share. This module implements :memory | :redis; :db exists only where a module has a database adapter.

:in-memory is accepted as :memory and warns. Removal no earlier than 2.0 (BOU-436). nil keeps the documented default, which is in-process.

The provider keyword in the vocabulary cache, realtime, events and jobs
share. This module implements `:memory` | `:redis`; `:db` exists only where a
module has a database adapter.

`:in-memory` is accepted as `:memory` and warns. Removal no earlier than 2.0
(BOU-436). nil keeps the documented default, which is in-process.
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