ST2110Nic class

Signature:

export declare class ST2110Nic

Properties

Property Type Description

Property	Type	Description
initialised	Promise<void>	Resolves once the NIC is actually usable: MTL_Init / MTL_Start have completed inside the isox host and an IP address is known (from static config or DHCP). Rejects with the failure reason if any later step in the bring-up errors — including the deep zig-side preflight, which fires asynchronously after `preflightComplete` has already resolved. Callers that don’t need to await readiness SHOULD still attach a `.catch` so a late failure isn’t logged as an unhandled rejection by Node; `settings.onError` is the recommended place to handle that failure for UI surfacing.
pendingIpAddressRequests	((ipAddress: string) ⇒ void)[]
preflightComplete	Promise<void>	Resolves once the server-side gen_server is up and its preflight validation has passed (i.e. the NIC accepts commands), but BEFORE MTL_Init / MTL_Start have completed and BEFORE any IP address has been learned. Use this when downstream resource creation (NMOS devices, senders, receivers) can proceed without the wire being live yet — Norsk will queue any operation that requires MTL until MTL_Start completes. Use `initialised` instead when you intend to push or receive packets immediately. Rejects if preflight fails.

initialised

Promise<void>

Resolves once the NIC is actually usable: MTL_Init / MTL_Start have completed inside the isox host and an IP address is known (from static config or DHCP). Rejects with the failure reason if any later step in the bring-up errors — including the deep zig-side preflight, which fires asynchronously after preflightComplete has already resolved. Callers that don’t need to await readiness SHOULD still attach a .catch so a late failure isn’t logged as an unhandled rejection by Node; settings.onError is the recommended place to handle that failure for UI surfacing.

pendingIpAddressRequests

((ipAddress: string) ⇒ void)[]

preflightComplete

Promise<void>

Resolves once the server-side gen_server is up and its preflight validation has passed (i.e. the NIC accepts commands), but BEFORE MTL_Init / MTL_Start have completed and BEFORE any IP address has been learned. Use this when downstream resource creation (NMOS devices, senders, receivers) can proceed without the wire being live yet — Norsk will queue any operation that requires MTL until MTL_Start completes. Use initialised instead when you intend to push or receive packets immediately. Rejects if preflight fails.

Methods

Method Modifiers Description

Method	Modifiers	Description
ipAddress()		Resolves to the primary NIC’s assigned IP. For 2022-7 hosts use `ipAddresses()` to observe both ports.
ipAddresses()		Per-port IPs in NIC order (primary first). Length is 1 for single- port hosts and 2 for ST 2022-7 hosts. Resolves only once every port’s IP is known (relevant for DHCP NICs that arrive independently).

ipAddress()

Resolves to the primary NIC’s assigned IP. For 2022-7 hosts use ipAddresses() to observe both ports.

ipAddresses()

Per-port IPs in NIC order (primary first). Length is 1 for single- port hosts and 2 for ST 2022-7 hosts. Resolves only once every port’s IP is known (relevant for DHCP NICs that arrive independently).