Logo FSBarV1_Archived

EngineConfig Module

Functions for creating and querying EngineConfig values.

Functions and values

Function or value Description

defaultConfig ()

Full Usage: defaultConfig ()

Parameters:
    () : unit

Returns: EngineConfig A new EngineConfig with default values.

Creates a default EngineConfig with sensible defaults for headless testing. A unique socket path is generated using a partial GUID.

() : unit
Returns: EngineConfig

A new EngineConfig with default values.

resolveReadTimeout config

Full Usage: resolveReadTimeout config

Parameters:
    config : EngineConfig - The engine configuration to resolve the timeout for.

Returns: int The resolved read timeout in milliseconds.

Resolves the effective read timeout for socket operations. Checks, in order: EngineConfig.ReadTimeoutMs, the FSBAR_CLIENT_TIMEOUT_MS environment variable, then falls back to 10 000 ms.

config : EngineConfig

The engine configuration to resolve the timeout for.

Returns: int

The resolved read timeout in milliseconds.

Type something to start searching.