Liking cljdoc? Tell your friends :D

com.blockether.vis.contract.gateway

Gateway declarations loaded from the validated JSON contract.

Gateway declarations loaded from the validated JSON contract.
raw docstring

client-leaseclj

Remote lease lifetime and keepalive policy.

Remote lease lifetime and keepalive policy.
sourceraw docstring

envelopesclj

Canonical gateway envelope declarations.

Canonical gateway envelope declarations.
sourceraw docstring

error-bodyclj

(error-body type message extra)

Build the canonical JSON error body; caller extras retain their existing override semantics.

Build the canonical JSON error body; caller extras retain their existing override semantics.
sourceraw docstring

error-response-body-keysclj

Semantic error body key to canonical wire spelling.

Semantic error body key to canonical wire spelling.
sourceraw docstring

error-response-envelopeclj

Shared JSON error response declaration.

Shared JSON error response declaration.
sourceraw docstring

error-response-error-keysclj

Semantic error detail key to canonical wire spelling.

Semantic error detail key to canonical wire spelling.
sourceraw docstring

event-typesclj

All event names on session, dedicated-job and relay-push streams.

All event names on session, dedicated-job and relay-push streams.
sourceraw docstring

handshakeclj

(handshake {:keys [version build]})

Build the engine handshake from contract protocol numbers and runtime release identity.

Build the engine handshake from contract protocol numbers and runtime release identity.
sourceraw docstring

handshake-envelopeclj

Gateway identity handshake declaration.

Gateway identity handshake declaration.
sourceraw docstring

handshake-keysclj

Semantic handshake key to canonical wire spelling.

Semantic handshake key to canonical wire spelling.
sourceraw docstring

(header k)

Canonical lower-case spelling for semantic header k, or nil.

Canonical lower-case spelling for semantic header `k`, or nil.
sourceraw docstring

headersclj

Semantic header key to canonical lower-case spelling.

Semantic header key to canonical lower-case spelling.
sourceraw docstring

job-event-typesclj

All dedicated job-stream event names.

All dedicated job-stream event names.
sourceraw docstring

job-eventsclj

Directional event names carried by dedicated speech job streams.

Directional event names carried by dedicated speech job streams.
sourceraw docstring

journal-line-envelopeclj

Private cross-process journal metadata declaration.

Private cross-process journal metadata declaration.
sourceraw docstring

journal-metadata-keysclj

Semantic journal metadata key to canonical wire spelling.

Semantic journal metadata key to canonical wire spelling.
sourceraw docstring

journal-pidclj

(journal-pid event)
source

journal-pid-keyclj

source

journal-producerclj

(journal-producer event)
source

journal-producer-keyclj

source

journal-store-keyclj

source

journal-stored?clj

(journal-stored? event)
source

minimum-client-protocolclj

Oldest client protocol served by this gateway contract.

Oldest client protocol served by this gateway contract.
sourceraw docstring

minimum-gateway-protocolclj

Oldest gateway protocol accepted by this client contract.

Oldest gateway protocol accepted by this client contract.
sourceraw docstring

operationclj

(operation method path)

Request/response transport declaration for built-in method and path, or nil.

Request/response transport declaration for built-in `method` and `path`, or nil.
sourceraw docstring

protocolclj

Canonical gateway compatibility numbers.

Canonical gateway compatibility numbers.
sourceraw docstring

protocol-versionclj

Wire protocol spoken by this contract.

Wire protocol spoken by this contract.
sourceraw docstring

push-event-typesclj

Event names used by relay push payloads.

Event names used by relay push payloads.
sourceraw docstring

queue-mirror-event-typesclj

Queue lifecycle events mirrored by attached channels.

Queue lifecycle events mirrored by attached channels.
sourceraw docstring

replayclj

Cursor and generation anchors for session replay.

Cursor and generation anchors for session replay.
sourceraw docstring

route-methodsclj

(route-methods)

Exact built-in [method path] pairs declared by the contract.

Exact built-in `[method path]` pairs declared by the contract.
sourceraw docstring

route-operationsclj

Complete [method path] to request/response transport declaration.

Complete `[method path]` to request/response transport declaration.
sourceraw docstring

route-tableclj

Complete built-in gateway route table, one record per path.

Complete built-in gateway route table, one record per path.
sourceraw docstring

session-event-envelopeclj

Stamped session stream event declaration.

Stamped session stream event declaration.
sourceraw docstring

session-event-keysclj

Semantic session stamp key to canonical wire spelling.

Semantic session stamp key to canonical wire spelling.
sourceraw docstring

session-event-schemaclj

Schema number stamped onto every session event.

Schema number stamped onto every session event.
sourceraw docstring

session-event-type?clj

(session-event-type? event-type)

True when event-type belongs to the closed session-stream vocabulary.

True when `event-type` belongs to the closed session-stream vocabulary.
sourceraw docstring

session-event-typesclj

Closed built-in vocabulary carried by the session journal and multiplexed session SSE stream.

Closed built-in vocabulary carried by the session journal and multiplexed session SSE stream.
sourceraw docstring

speech-job-eventclj

Speech synthesis job stream event name.

Speech synthesis job stream event name.
sourceraw docstring

stamp-journal-lineclj

(stamp-journal-line event producer pid store?)

Add private producer metadata to one already-stamped session event.

Add private producer metadata to one already-stamped session event.
sourceraw docstring

stamp-session-eventclj

(stamp-session-event payload session-id sequence timestamp type)

Apply the contract-owned identity stamp after payload, so payload keys cannot spoof it.

Apply the contract-owned identity stamp after `payload`, so payload keys cannot spoof it.
sourceraw docstring

strip-journal-metadataclj

(strip-journal-metadata event)

Remove private journal metadata before an event reaches a session consumer.

Remove private journal metadata before an event reaches a session consumer.
sourceraw docstring

subscription-ready-envelopeclj

First-frame session subscription declaration.

First-frame session subscription declaration.
sourceraw docstring

subscription-ready-eventclj

(subscription-ready-event {:keys [session-id cursor current-turn-id is-live
                                  server-time-ms latest-iteration]})

Build the canonical first frame for one session subscription.

Build the canonical first frame for one session subscription.
sourceraw docstring

subscription-ready-optional-keysclj

source

subscription-ready-required-keysclj

source

turn-meta-keysclj

Wire keys copied from a settled turn row into blocking submit/attach results.

Wire keys copied from a settled turn row into blocking submit/attach results.
sourceraw docstring

turn-terminal-event-typesclj

Every built-in event type that ends a turn.

Every built-in event type that ends a turn.
sourceraw docstring

verdictclj

(verdict {:keys [gateway-protocol gateway-min-client gateway-version
                 client-protocol client-min-gateway client-version
                 client-name]})

Pure compatibility verdict between a gateway and a client.

Reasons are ok, client-too-old, gateway-too-old, or unknown when a peer did not advertise a protocol. :upgrade names the half that must be updated.

Pure compatibility verdict between a gateway and a client.

Reasons are `ok`, `client-too-old`, `gateway-too-old`, or `unknown` when a peer
did not advertise a protocol. `:upgrade` names the half that must be updated.
sourceraw docstring

versionclj

Gateway contract document version.

Gateway contract document version.
sourceraw docstring

view-close-eventclj

Session event that ends either View kind.

Session event that ends either View kind.
sourceraw docstring

view-eventsclj

Open, patch and close event names for both View kinds.

Open, patch and close event names for both View kinds.
sourceraw docstring

view-open-eventclj

Session event that mounts either View kind.

Session event that mounts either View kind.
sourceraw docstring

view-patch-eventclj

Session event carrying accepted View operations.

Session event carrying accepted View operations.
sourceraw docstring

voice-job-eventclj

Transcription job stream event name.

Transcription job stream event name.
sourceraw docstring

wire->handshakeclj

(wire->handshake m)

Read a peer's advertised handshake from its canonical string-keyed wire map. Missing fields remain nil so verdict rejects an unversioned peer explicitly.

Read a peer's advertised handshake from its canonical string-keyed wire map.
Missing fields remain nil so [[verdict]] rejects an unversioned peer explicitly.
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