Liking cljdoc? Tell your friends :D

com.blockether.vis.contract.gateway

Gateway payload schemas and their HTTP transport metadata.

Gateway payload schemas and their HTTP transport metadata.
raw docstring

client-leaseclj

Remote lease lifetime and keepalive policy.

Remote lease lifetime and keepalive policy.
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

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 schema protocol numbers and runtime release identity.

Build the engine handshake from schema protocol numbers and runtime release identity.
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-pidclj

(journal-pid event)
source

journal-producerclj

(journal-producer event)
source

journal-stored?clj

(journal-stored? event)
source

minimum-client-protocolclj

Oldest client protocol served by this gateway.

Oldest client protocol served by this gateway.
sourceraw docstring

minimum-gateway-protocolclj

Oldest gateway protocol accepted by this client.

Oldest gateway protocol accepted by this client.
sourceraw docstring

newer-session-goalclj

(newer-session-goal previous incoming)

Keep the highest valid session-wide revision across HTTP snapshots and event replay. Goal replacement increments revision too; invalid, absent and older snapshots cannot rewind it.

Keep the highest valid session-wide revision across HTTP snapshots and event replay.
Goal replacement increments revision too; invalid, absent and older snapshots cannot rewind it.
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

protocol-versionclj

Wire protocol spoken by this schema.

Wire protocol spoken by this schema.
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

route-methodsclj

(route-methods)

Exact built-in [method path] pairs declared by the schema's HTTP metadata.

Exact built-in `[method path]` pairs declared by the schema's HTTP metadata.
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-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 SSE stream.

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

session-goal-labelsclj

Display titles of the canonical goal status schema alternatives.

Display titles of the canonical goal status schema alternatives.
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 schema identity stamp after payload, so payload keys cannot spoof it.

Apply the schema 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-eventclj

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

Build the canonical first frame for one session subscription.

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

turn-meta-keysclj

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

Wire fields copied from a settled turn 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

valid-session-goal?clj

(valid-session-goal? goal)

True for a canonical wire goal. A session without a goal carries nil instead.

True for a canonical wire goal. A session without a goal carries nil instead.
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

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