Skip to main content
Version: 0.9.0 (next)

QarOnboardLocalAppExt Struct

Extension: join the QAROS hub installed on this PC as a local source app, with no code. More...

Declaration​

struct QarOnboardLocalAppExt { ... }

Included Headers​

#include <qar-streaming-c/include/qar_streaming.h>

Public Member Attributes Index​

uint32_tapproval_timeout_ms

Max wait for the user's first-time approval; 0 -> hub default (120 s). More...

QarStructureHeaderheader

Description​

Extension: join the QAROS hub installed on this PC as a local source app, with no code.

Chain into QarOnboardInit.header.next as the only mode extension. The hub identifies the calling process from Windows (its executable, signature and user), asks the user once ("Allow <app> to join QAROS?"), and signs a 30-minute certificate for a key that exists only in this process's memory. Later starts of the same app join silently while it still matches what the user approved. The runtime renews the certificate before it expires.

  • Joins the hub of the QAROS installation this runtime belongs to: the QAR_INSTANCE environment variable when set, else the installation holding the loaded qar-streaming-c, else the installed (HKLM) one. The hub's qar-runtime-launcher must run as this user in this Windows session, from that installation's bin/, signed with the QAROS key pinned in the runtime; otherwise QAR_STATUS_ONBOARDING_HUB_NOT_AUTHENTIC.
  • Stateless: writes nothing to disk; out_onboarding_id is the zero id. qar_runtime_rejoin and qar_runtime_forget do not apply.
  • Not combinable with QarOnboardHostExt (local only) or QarOnboardPeerIdExt (the hub assigns the peer id): QAR_STATUS_ARGUMENT_NOT_SUPPORTED.
  • The progress callback reports "Waiting for approval in QAROS hub" while the prompt is open.
  • Windows only; QAR_STATUS_NOT_IMPLEMENTED elsewhere.

Definition at line 1643 of file qar_streaming.h.

Public Member Attributes​

approval_timeout_ms​

uint32_t QarOnboardLocalAppExt::approval_timeout_ms

Max wait for the user's first-time approval; 0 -> hub default (120 s).

Definition at line 1648 of file qar_streaming.h.

header​

QarStructureHeader QarOnboardLocalAppExt::header

QAR_STRUCTURE_TYPE_RUNTIME_ONBOARD_LOCAL_APP_EXT

Definition at line 1646 of file qar_streaming.h.

The documentation for this struct was generated from the following file:

Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.