lightspeed - v1.0.0

lightspeed/transport/matrix

Transport profile matrix with progressive enhancement semantics for M24.

Types

AdapterState

Matrix adapter state.

pub type AdapterState {
  AdapterState(
    websocket: wisp_websocket.AdapterState,
    profile: Profile,
    mode: Mode,
    queued_outbound: List(String),
    last_client_sequence: Int,
    last_client_seen_at_ms: Int,
    security_policy: SecurityPolicy,
    timeout_policy: TimeoutPolicy,
  )
}

Constructors

Capability

Capability flags used by compatibility fixtures.

pub type Capability {
  OrderedClientEvents
  ReconnectSemantics
  ServerPushFrames
  BidirectionalChannel
  ProgressiveFallback
}

Constructors 

  • OrderedClientEvents
  • ReconnectSemantics
  • ServerPushFrames
  • BidirectionalChannel
  • ProgressiveFallback

ConnectRequest

Connect/reconnect request shape.

pub type ConnectRequest {
  ConnectRequest(
    route: String,
    csrf_token: String,
    origin: String,
    now_ms: Int,
    prefer_fallback: Bool,
  )
}

Constructors 

  • ConnectRequest(
  route: String,
  csrf_token: String,
  origin: String,
  now_ms: Int,
  prefer_fallback: Bool,
)

ConnectResult

Connect/reconnect result.

pub type ConnectResult {
  Connected(state: AdapterState, outbound_frames: List(String))
  Rejected(error: contract.AdapterError)
}

Constructors

Mode

Active runtime mode.

pub type Mode {
  PrimaryRealtime
  FallbackPolling
}

Constructors 

  • PrimaryRealtime
  • FallbackPolling

Profile

Supported transport profiles for compatibility matrix testing.

pub type Profile {
  WebSocketOnly
  WebSocketWithServerSentEventsFallback
  WebSocketWithLongPollingFallback
}

Constructors 

  • WebSocketOnly
  • WebSocketWithServerSentEventsFallback
  • WebSocketWithLongPollingFallback

ReceiveResult

Receive/poll result.

pub type ReceiveResult {
  ReceiveResult(
    state: AdapterState,
    outbound_frames: List(String),
  )
}

Constructors 

  • ReceiveResult(state: AdapterState, outbound_frames: List(String))

SecurityPolicy

Security defaults enforced by matrix adapters.

pub type SecurityPolicy {
  SecurityPolicy(
    require_https_origin: Bool,
    require_csrf: Bool,
    max_payload_bytes: Int,
  )
}

Constructors 

  • SecurityPolicy(
  require_https_origin: Bool,
  require_csrf: Bool,
  max_payload_bytes: Int,
)

TimeoutPolicy

Timeout defaults for heartbeat and reconnect behavior.

pub type TimeoutPolicy {
  TimeoutPolicy(
    heartbeat_timeout_ms: Int,
    reconnect_grace_ms: Int,
  )
}

Constructors 

  • TimeoutPolicy(heartbeat_timeout_ms: Int, reconnect_grace_ms: Int)

Values

active_transport 

pub fn active_transport(
  state: AdapterState,
) -> transport.Transport

Active transport for current profile+mode.

active_transport_label 

pub fn active_transport_label(state: AdapterState) -> String

Active transport label.

capability_enabled 

pub fn capability_enabled(
  state: AdapterState,
  capability: Capability,
) -> Bool

Capability predicate for fixtures and docs.

connect 

pub fn connect(
  session_state: session.Session,
  request: ConnectRequest,
  profile: Profile,
  auth_hook: contract.AuthHook,
) -> ConnectResult

Connect with default protection, security, and timeout policies.

connect_with_policies 

pub fn connect_with_policies(
  session_state: session.Session,
  request: ConnectRequest,
  profile: Profile,
  auth_hook: contract.AuthHook,
  protection_hook: contract.ProtectionHook,
  security_policy: SecurityPolicy,
  timeout_policy: TimeoutPolicy,
) -> ConnectResult

Connect with explicit protection, security, and timeout policies.

default_security_policy 

pub fn default_security_policy() -> SecurityPolicy

Default transport security policy.

default_timeout_policy 

pub fn default_timeout_policy() -> TimeoutPolicy

Default timeout policy.

fallback_available 

pub fn fallback_available(profile: Profile) -> Bool

Whether the profile has a fallback mode available.

mode_label 

pub fn mode_label(state: AdapterState) -> String

Active mode label.

poll 

pub fn poll(state: AdapterState) -> ReceiveResult

Poll queued server frames.

profile_label 

pub fn profile_label(profile: Profile) -> String

Active profile label.

progressive_enhancement_active 

pub fn progressive_enhancement_active(
  state: AdapterState,
) -> Bool

Whether fallback mode is active.

queued_outbound_count 

pub fn queued_outbound_count(state: AdapterState) -> Int

Number of queued frames pending poll.

receive 

pub fn receive(
  state: AdapterState,
  payload: String,
  now_ms: Int,
  client_sequence: Int,
) -> ReceiveResult

Receive one client frame.

client_sequence must be monotonically increasing per connection.

receive_with_hooks 

pub fn receive_with_hooks(
  state: AdapterState,
  payload: String,
  now_ms: Int,
  client_sequence: Int,
  rate_limit_hook: contract.RateLimitHook,
) -> ReceiveResult

Receive one client frame with explicit rate-limit hook.

reconnect 

pub fn reconnect(
  state: AdapterState,
  request: ConnectRequest,
  auth_hook: contract.AuthHook,
) -> ConnectResult

Reconnect with the state’s existing policy defaults.

reconnect_with_policies 

pub fn reconnect_with_policies(
  state: AdapterState,
  request: ConnectRequest,
  auth_hook: contract.AuthHook,
  protection_hook: contract.ProtectionHook,
  security_policy: SecurityPolicy,
  timeout_policy: TimeoutPolicy,
) -> ConnectResult

Reconnect with explicit protection, security, and timeout policies.

session_state 

pub fn session_state(state: AdapterState) -> session.Session

Session state accessor.

✨ Search Document