{"id":13002,"date":"2026-08-03T07:44:14","date_gmt":"2026-08-03T07:44:14","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/?page_id=13002"},"modified":"2026-08-04T05:25:27","modified_gmt":"2026-08-04T05:25:27","slug":"webconfigframework","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/","title":{"rendered":"WebconfigFramework"},"content":{"rendered":"\n

WebconfigFramework is a shared C library (libwebconfig_framework<\/code>) that provides RDK middleware components with a standardized interface for registering configuration sub-documents and handling binary configuration blob updates delivered by a webconfig client. The library manages the full lifecycle of a configuration request \u2014 from initial sub-document registration and version tracking, through queued execution with timeout enforcement, to acknowledgement and rollback \u2014 without requiring each consuming component to implement these mechanisms independently.<\/p>\n\n\n\n

As a device-side library, WebconfigFramework bridges cloud-driven or management-plane configuration delivery with the internal processing logic of individual RDK middleware components. A webconfig client pushes encoded configuration payloads (blobs) targeted at specific sub-documents owned by device components. Each component that participates in this model links against libwebconfig_framework<\/code>, registers the sub-documents it manages, and provides callback function pointers to execute, roll back, and free blob data. The framework takes responsibility for queuing, scheduling, timeout management, and reporting results back to the webconfig client.<\/p>\n\n\n\n

The framework is platform-agnostic and designed to support deployments across both video streaming and broadband gateway devices. Its design accommodates single-component blob execution and, through the optional multi-component execution model, coordinated blob delivery across a master component and one or more slave components running in separate processes.<\/p>\n\n\n\n

flowchart LR\n\nclassDef Apps stroke:#00B9F1,fill:#E6F7FD,stroke-width:2px;\nclassDef RDKMW stroke:#75D701,fill:#F1FFE6,stroke-width:2px;\nclassDef VL stroke:#808080,fill:#F2F2F2,stroke-width:2px;\nclassDef Ext stroke:#FF8C00,fill:#FFF3E0,stroke-width:2px;\n\nsubgraph Ext[\"External Systems\"]\n    WebcfgClient[\"Webconfig Client\"]\nend\n\nsubgraph Apps[\"Apps & Runtimes\"]\n    FBApps[\"Firebolt Apps\"]\n    WPE_RT[\"WPE Runtime\"]\nend\n\nsubgraph RDKMW[\"RDK Core Middleware\"]\n    WCF[\"WebconfigFramework\\n(libwebconfig_framework)\"]\n    CompA[\"RDK Component A\"]\n    CompB[\"RDK Component B\"]\n    Thunder[\"WPEFramework (Thunder)\"]\n    AM[\"App Manager\"]\nend\n\nsubgraph VL[\"Vendor Layer\"]\n    HAL[\"Platform HAL\"]\n    BSP[\"BSP\"]\nend\n\nWebcfgClient -->|\"Config blob delivery\"| CompA\nWebcfgClient -->|\"Config blob delivery\"| CompB\nCompA -->|\"register_sub_docs \/ PushBlobRequest\"| WCF\nCompB -->|\"register_sub_docs \/ PushBlobRequest\"| WCF\nWCF -->|\"ACK \/ NACK (rbus signal)\"| WebcfgClient\nApps -->|\"Firebolt APIs\"| RDKMW\nRDKMW -->|\"HAL APIs\"| VL\n\nclass Apps Apps;\nclass RDKMW RDKMW;\nclass VL VL;\nclass Ext Ext;<\/pre><\/div>\n\n\n\n
Key Features & Responsibilities:<\/strong><\/p>\n\n\n\n
    \n
  • Sub-document Registration<\/strong>: Components register the configuration sub-documents they own during initialization, providing the framework with the sub-document names, current versions, and getter\/setter callbacks for version persistence.<\/li>\n\n\n\n
  • Version Deduplication<\/strong>: Before queuing any blob request, the framework checks whether the incoming version already exists or is already pending execution. Duplicate requests are discarded, and transaction IDs are updated in place rather than re-queuing.<\/li>\n\n\n\n
  • Request Queuing<\/strong>: Accepted blob requests are placed in a bounded circular queue and dispatched via a POSIX message queue to a dedicated processing thread, decoupling the receiving component from the execution path.<\/li>\n\n\n\n
  • Timed Execution with Timeout Enforcement<\/strong>: Each blob execution runs in a cancelable worker thread. The framework applies a calculated timeout (component-provided or default) and cancels the thread upon expiry, sending a NACK to the webconfig client.<\/li>\n\n\n\n
  • Rollback Support<\/strong>: If blob execution fails (other than a validation-only failure), the framework invokes the component-supplied rollback callback to restore the previous configuration state.<\/li>\n\n\n\n
  • ACK\/NACK Signaling<\/strong>: The framework signals the webconfig client with ACK (success or pending with estimated timeout) or NACK (failure with error code and message) via rbus signals.<\/li>\n\n\n\n
  • Crash Recovery Notification<\/strong>: Components can call check_component_crash()<\/code> at startup. The framework detects whether the component is recovering from a crash by checking for the presence of a designated init-file and notifies the webconfig client of current sub-document versions accordingly.<\/li>\n\n\n\n
  • Force-Reset Event Subscription<\/strong>: The framework subscribes to the Device.X_RDK_WebConfig.webcfgSubdocForceReset<\/code> rbus event. When received, it resets the stored versions of the specified sub-documents, causing the webconfig client to re-apply those configurations on the next sync.<\/li>\n\n\n\n
  • Multi-Component Coordination<\/strong>: When enabled, the framework supports a master\/slave execution model across processes. A master component coordinates blob data delivery to slave components using rbus events, collects their execution results, and reports a consolidated outcome to the webconfig client.<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n
    Design<\/h2>\n\n\n\n
    WebconfigFramework is designed as a thin, self-contained library that imposes minimal coupling on the consuming component. It initializes its own internal threads and POSIX message queues at registration time, requiring no daemon lifecycle management from the component. The framework operates around a producer-consumer model: the component acts as producer by calling PushBlobRequest()<\/code> after receiving and parsing a blob, and the framework’s internal processing thread acts as consumer by dispatching execution to a component-supplied callback with a bounded timeout.<\/p>\n\n\n\n
    Version management is central to the design. The framework maintains a registry of all registered sub-documents with their current applied versions. When a new blob arrives, the version is compared against the registered version and against any pending queue entries. This three-way check \u2014 already applied, in queue, or new \u2014 prevents redundant execution and ensures the webconfig client receives meaningful feedback for every request.<\/p>\n\n\n\n
    The northbound interface toward the webconfig client is handled exclusively through rbus signals. The framework opens a dedicated rbus connection at first use and sends structured signal strings encoding sub-document name, transaction ID, version, result type (ACK\/NACK), timeout, error code, and error message. The framework also subscribes to force-reset events over rbus, enabling the webconfig client to invalidate previously applied versions and trigger re-delivery.<\/p>\n\n\n\n
    The southbound interface toward the platform is entirely callback-driven. The framework invokes function pointers provided by the component at registration time \u2014 executeBlobRequest<\/code>, rollbackFunc<\/code>, calcTimeout<\/code>, and freeResources<\/code> \u2014 keeping the library fully portable across device categories with no platform-specific code paths embedded within it.<\/p>\n\n\n\n
    Version state is managed through the getVersion<\/code> and setVersion<\/code> callbacks supplied by the consuming component at register_sub_docs()<\/code>. The framework maintains in-memory versions in the blobRegInfo<\/code> array and calls the component’s setter after each successful blob execution.<\/p>\n\n\n\n
    The IPC mechanism selection is uniform across all interactions: rbus is used for all external signaling (ACK\/NACK to webconfig client, force-reset subscription, and multi-component event delivery). POSIX message queues serve only as an internal, intra-process dispatch channel between the PushBlobRequest()<\/code> API call and the messageQueueProcessing<\/code> worker thread.<\/p>\n\n\n\n
    graph TD\n    REG[\"Registration Module\\nregister_sub_docs \/ check_component_crash\"]\n    QUEUE[\"Circular Queue\\nqueueInfo\"]\n    MQ[\"POSIX Message Queue\\nper-process\"]\n    MQPROC[\"messageQueueProcessing\\nThread\"]\n    EXECTH[\"execute_request Thread\\ntimed and cancelable\"]\n    RBUS[\"rbus Interface\\nrbusInit \/ rbusEvent_Subscribe\"]\n    FORCERESET[\"subscribeSubdocForceReset\\nThread\"]\n    MASTER[\"Multi-Comp Master\\nQueue and Processing Thread\"]\n    SLAVE[\"Multi-Comp Slave\\nQueue and Processing Thread\"]\n    EVTS[\"rbus Events\\nBroadcast \/ Master \/ Slave\"]\n    LOG[\"Logging Module\\nLOG.RDK.WEBCONFIG\"]\n    CompCB[\"Component Callback\"]\n\n    REG -->|\"initialize\"| MQ\n    REG -->|\"initialize\"| FORCERESET\n    MQ -->|\"dispatch\"| MQPROC\n    MQPROC -->|\"spawn\"| EXECTH\n    MQPROC -->|\"addEntry\"| QUEUE\n    EXECTH -->|\"executeBlobRequest\"| CompCB\n    MQPROC -->|\"send result\"| RBUS\n    FORCERESET -->|\"subscribe\"| RBUS\n    MASTER -->|\"coordinate via\"| EVTS\n    SLAVE -->|\"coordinate via\"| EVTS<\/pre><\/div>\n\n\n\n
    Threading Model<\/h4>\n\n\n\n
      \n
    • Threading Architecture<\/strong>: Multi-threaded<\/li>\n\n\n\n
    • messageQueueProcessing<\/code> Thread<\/strong>: Blocks on mq_receive()<\/code> waiting for blob requests posted by PushBlobRequest()<\/code>. Upon receipt, it updates queue state, spawns an execute_request<\/code> thread, and waits on a timed condition variable (pthread_cond_timedwait<\/code>). It owns the execution mutex (webconfig_exec<\/code>) and the queue access mutex (queue_access<\/code>).<\/li>\n\n\n\n
    • execute_request<\/code> Thread<\/strong>: Created per blob request with PTHREAD_CANCEL_ASYNCHRONOUS<\/code>. Invokes the component’s executeBlobRequest<\/code> callback and signals the messageQueueProcessing<\/code> thread via pthread_cond_signal<\/code> on completion. Cancelled by the processing thread if the timeout elapses.<\/li>\n\n\n\n
    • subscribeSubdocForceReset<\/code> Thread<\/strong>: Detached thread that polls for the webconfig component’s rbus presence using webcfg_rbus_discover_component()<\/code> and then subscribes to Device.X_RDK_WebConfig.webcfgSubdocForceReset<\/code>. Runs once at registration and exits after subscribing.<\/li>\n\n\n\n
    • display_subDocs<\/code> Thread<\/strong>: Detached diagnostic thread that activates only when \/tmp\/webconfig_dbg<\/code> exists. Logs registered sub-document names, versions, and queue contents at a configurable interval for a configurable number of iterations.<\/li>\n\n\n\n
    • Multi-component Threads<\/strong> (when WBCFG_MULTI_COMP_SUPPORT<\/code> is enabled):<\/li>\n\n\n\n
    • messageQueueProcessingMultiComp<\/code><\/em>: Master-side queue processing thread that coordinates blob delivery to slave components and collects their results.<\/li>\n\n\n\n
    • messageQueueProcessingMultiCompSlave<\/code><\/em>: Slave-side queue processing thread that receives and executes blob data forwarded by the master.<\/li>\n\n\n\n
    • event_register_slave<\/code><\/em>: Per-subdoc thread that registers slave-side rbus events and signals readiness to the master.<\/li>\n\n\n\n
    • Synchronization<\/strong>: webconfig_exec<\/code> mutex guards blob execution; queue_access<\/code> mutex protects the circular queue; reg_subdoc<\/code> mutex protects the blobRegInfo<\/code> registry; webcfg_rbus_enable<\/code> mutex guards the one-time rbus initialization. Timed waits use CLOCK_MONOTONIC<\/code> via pthread_condattr_setclock<\/code>.<\/li>\n\n\n\n
    • Async \/ Event Dispatch<\/strong>: rbus event callbacks (subdocForceReset_callbk_rbus<\/code>, multiComp_callbk_rbus<\/code>) are invoked on the rbus callback thread. The multi-component callbacks signal processing threads via pthread_cond_signal<\/code> to keep callback handlers non-blocking.<\/li>\n<\/ul>\n\n\n\n
      Prerequisites and Dependencies<\/h3>\n\n\n\n
      Platform and Integration Requirements<\/h4>\n\n\n\n
        \n
      • Build Dependencies<\/strong>: rbus<\/code> (runtime bus library, required at link time); libpthread<\/code>, librt<\/code>, libz<\/code> (linked via libwebconfig_framework_la_LDFLAGS<\/code>). When CCSP_SUPPORT_ENABLED<\/code> is set: libccsp_common<\/code>.<\/li>\n\n\n\n
      • Startup Order<\/strong>: The library initializes fully within the calling component’s process at register_sub_docs()<\/code> time. There is no external daemon or service ordering requirement.<\/li>\n<\/ul>\n\n\n\n
        \n\n\n\n
        Component State Flow<\/h3>\n\n\n\n
        Initialization to Active State<\/h4>\n\n\n\n
        The framework transitions through the following states during initialization when a component calls register_sub_docs()<\/code>:<\/p>\n\n\n\n
        Initializing<\/strong> (populate blobRegInfo<\/code> registry, zero the circular queue) \u2192 Hydrating<\/strong> (invoke getVersion<\/code> callbacks to load current applied versions into the registry) \u2192 QueueReady<\/strong> (create POSIX message queue and spawn messageQueueProcessing<\/code> thread) \u2192 Subscribing<\/strong> (spawn subscribeSubdocForceReset<\/code> thread to establish rbus force-reset subscription) \u2192 Active<\/strong> (ready to accept PushBlobRequest()<\/code> calls and process blob execution).<\/p>\n\n\n\n
        sequenceDiagram\n    participant Component as RDK Component\n    participant WCF as WebconfigFramework\n    participant POSIXMQ as POSIX Message Queue\n    participant RBUS as rbus\n\n    Component->>WCF: register_sub_docs(blobRegInfo, count, getVersion, setVersion)\n    WCF->>WCF: Populate blobRegInfo registry\n    WCF->>Component: getVersion(subdoc_name) [per subdoc]\n    Component-->>WCF: Current version\n\n    WCF->>POSIXMQ: mq_open (create per-process queue)\n    POSIXMQ-->>WCF: Queue ready\n\n    WCF->>WCF: pthread_create \u2014 messageQueueProcessing thread\n    WCF->>WCF: pthread_create \u2014 display_subDocs thread\n    WCF->>WCF: pthread_create \u2014 subscribeSubdocForceReset thread\n\n    WCF->>RBUS: rbusInit() [lazy, on first need]\n    RBUS-->>WCF: rbus handle open\n\n    WCF->>RBUS: webcfg_rbus_discover_component (poll)\n    RBUS-->>WCF: Component found\n\n    WCF->>RBUS: rbusEvent_Subscribe(webcfgSubdocForceReset)\n    RBUS-->>WCF: Subscribed\n\n    WCF-->>Component: register_sub_docs() returns\n    Note over Component,WCF: Framework is Active \u2014 ready to accept PushBlobRequest()<\/pre><\/div>\n\n\n\n
        Runtime State Changes<\/h4>\n\n\n\n
        State Change Triggers:<\/strong><\/p>\n\n\n\n
          \n
        • A blob delivered with a version matching the currently registered version is treated as a no-op: it is not queued, and (unless disableWebCfgNotification==1<\/code>) the framework sends an immediate ACK with timeout=0<\/code> (VERSION_ALREADY_EXIST<\/code>). The exception is the hotspot<\/code> sub-document when the version-ignore override file (\/tmp\/hotspot_version_ignore<\/code>) is present, in which case the framework treats the request as a new version update.<\/li>\n\n\n\n
        • A blob with the same version already pending in the queue results in only the transaction ID being updated in the existing queue entry.<\/li>\n\n\n\n
        • If check_component_crash()<\/code> is called at startup and the init-file is present (indicating a previous crash), the framework reports all registered sub-document versions to the webconfig client with a COMPONENT_CRASH_EVENT<\/code> tag; if absent, it sends COMPONENT_INIT_EVENT<\/code>.<\/li>\n\n\n\n
        • Upon receiving Device.X_RDK_WebConfig.webcfgSubdocForceReset<\/code>, the framework calls resetSubdocVersion()<\/code> for each comma-separated sub-document name in the event payload, zeroing the in-memory version so the next delivery of any version is treated as VERSION_UPDATE_REQUIRED<\/code>.<\/li>\n<\/ul>\n\n\n\n
          Context Switching Scenarios:<\/strong><\/p>\n\n\n\n
            \n
          • If execution times out, the worker thread is cancelled, BLOB_EXECUTION_TIMEDOUT<\/code> NACK is sent to the webconfig client, and the optional rollback function is invoked.<\/li>\n\n\n\n
          • If the internal circular queue is full (queue depth QUEUE_SIZE = 10<\/code> reached), the new request is rejected with a QUEUE_PUSH_FAILED<\/code> NACK immediately. (If mq_send<\/code> fails, the framework sends MQUEUE_SEND_FAILED<\/code>.)<\/li>\n\n\n\n
          • In multi-component mode, a slave component that exceeds MAX_RESPONSE_TIME<\/code> (150 seconds) causes the master to mark the execution as timed out and send a SLAVE_RESPONSE_TIME_OUT<\/code> NACK to the webconfig client.<\/li>\n<\/ul>\n\n\n\n
            \n\n\n\n
            Call Flows<\/h3>\n\n\n\n
            Initialization Call Flow<\/h4>\n\n\n\n
            sequenceDiagram\n    participant Component as RDK Component\n    participant WCF as WebconfigFramework\n    participant POSIXMQ as POSIX Message Queue\n    participant RBUS as rbus\n\n    Component->>WCF: register_sub_docs(blobRegInfo, numDocs, getVersion, setVersion)\n    WCF->>WCF: Store blobData pointer and doc count\n    WCF->>WCF: Zero queueInfo (front = rear = -1)\n    WCF->>Component: getVersion(subdoc_name) for each subdoc\n    Component-->>WCF: Current version per subdoc\n    WCF->>WCF: Store setVersion function pointer\n    WCF->>WCF: initMessageQueue() \u2014 derive process_name from \/proc\/<pid>\/comm\n    WCF->>POSIXMQ: mq_open(\"\/webconfig_queue-<proc>\", O_CREAT)\n    POSIXMQ-->>WCF: mqd_t handle\n    WCF->>WCF: pthread_create \u2014 messageQueueProcessing\n    WCF->>WCF: pthread_create \u2014 display_subDocs\n    WCF->>WCF: pthread_create \u2014 subscribeSubdocForceReset\n    WCF->>RBUS: rbus_open(\"<proc>_wbcfg\")\n    RBUS-->>WCF: Handle opened\n    WCF->>RBUS: rbus_discoverComponentName(webcfgSubdocForceReset) [retry loop]\n    RBUS-->>WCF: Provider found\n    WCF->>RBUS: rbusEvent_Subscribe(Device.X_RDK_WebConfig.webcfgSubdocForceReset)\n    RBUS-->>WCF: Subscribed\n    WCF-->>Component: Returns<\/pre><\/div>\n\n\n\n
            Request Processing Call Flow<\/h4>\n\n\n\n
            The component receives blob data from the webconfig client via its own delivery channel, unpacks it, and calls PushBlobRequest()<\/code> with a populated execData<\/code> structure containing the sub-document name, transaction ID, version, entry count, parsed user data, and callback pointers. The framework performs version checks, queues the request, and notifies the webconfig client of the estimated execution time before invoking the component’s execution handler.<\/p>\n\n\n\n
            sequenceDiagram\n    participant WebcfgClient as Webconfig Client\n    participant Component as RDK Component\n    participant WCF as WebconfigFramework\n    participant POSIXMQ as POSIX Message Queue\n    participant RBUS as rbus\n\n    WebcfgClient->>Component: Blob delivery (subdoc data)\n    Component->>Component: Unpack blob, populate execData struct\n    Component->>WCF: PushBlobRequest(execData)\n\n    WCF->>WCF: checkNewVersionUpdateRequired()\n    alt VERSION_ALREADY_EXIST\n        WCF->>RBUS: sendWebConfigSignal (ACK, timeout=0)\n        RBUS->>WebcfgClient: ACK signal (no-op)\n        WCF-->>Component: Returns\n    else EXECUTION_IN_QUEUE\n        WCF->>WCF: Update txid in existing queue entry\n        WCF->>RBUS: sendWebConfigSignal (ACK with timeout)\n        RBUS->>WebcfgClient: ACK signal (subdoc, txid, version, timeout)\n        WCF-->>Component: Returns\n    else VERSION_UPDATE_REQUIRED\n        WCF->>WCF: calcTimeout(numOfEntries)\n        WCF->>WCF: addEntryToQueue(version, txid, timeout)\n        WCF->>RBUS: sendWebConfigSignal (ACK with timeout)\n        RBUS->>WebcfgClient: ACK signal (subdoc, txid, version, timeout)\n        WCF->>POSIXMQ: mq_send(execData)\n        POSIXMQ-->>WCF: Sent\n\n        POSIXMQ->>WCF: mq_receive (messageQueueProcessing thread)\n        WCF->>WCF: Mark queue entry IN_PROGRESS\n        WCF->>WCF: pthread_create \u2014 execute_request thread\n        WCF->>WCF: pthread_cond_timedwait (MAX_FUNC_EXEC_TIMEOUT \u00d7 timeout)\n\n        alt Execution completes within timeout\n            WCF->>Component: executeBlobRequest(user_data) callback\n            Component-->>WCF: Err {ErrorCode, ErrorMsg}\n            WCF->>WCF: pthread_cond_signal\n            alt BLOB_EXEC_SUCCESS\n                WCF->>WCF: updateVersionAndState (setVersion callback)\n                WCF->>RBUS: sendWebConfigSignal (ACK, timeout=0)\n                RBUS->>WebcfgClient: ACK signal (complete)\n            else Execution failed\n                WCF->>Component: rollbackFunc() [if provided]\n                WCF->>RBUS: sendWebConfigSignal (NACK, ErrorCode, ErrorMsg)\n                RBUS->>WebcfgClient: NACK signal\n            end\n        else Timeout elapsed\n            WCF->>WCF: pthread_cancel(execute_request thread)\n            WCF->>Component: rollbackFunc() [if provided]\n            WCF->>RBUS: sendWebConfigSignal (NACK, BLOB_EXECUTION_TIMEDOUT)\n            RBUS->>WebcfgClient: NACK signal\n        end\n\n        WCF->>WCF: freeResources() callback\n        WCF->>WCF: removeEntryFromQueue()\n    end<\/pre><\/div>\n\n\n\n
            \n\n\n\n
            Internal Modules<\/h2>\n\n\n\n
            Module \/ Class<\/th>Description<\/th>Key Files<\/th><\/tr><\/thead>
            webconfig_framework<\/code><\/td>Core registration and execution module. Implements register_sub_docs()<\/code>, check_component_crash()<\/code>, PushBlobRequest()<\/code>, version management, the circular queue, POSIX message queue setup, messageQueueProcessing<\/code> thread, execute_request<\/code> thread, send_ACK()<\/code>, send_NACK()<\/code>, and the debug display_subDocs<\/code> thread.<\/td>webconfig_framework.c<\/code>, webconfig_framework.h<\/code><\/td><\/tr>
            webconfig_bus_interface<\/code><\/td>rbus integration module. Implements rbus handle initialization, component discovery polling, subscribeSubdocForceReset<\/code> thread, and the subdocForceReset_callbk_rbus<\/code> event callback. Also provides multi-component rbus event registration, subscription, and publish functions when WBCFG_MULTI_COMP_SUPPORT<\/code> is enabled.<\/td>webconfig_bus_interface.c<\/code>, webconfig_bus_interface.h<\/code><\/td><\/tr>
            webconfig_framework_multi_comp<\/code><\/td>Multi-component coordination module. Implements master and slave message queue processing threads, broadcast\/master\/slave signal callbacks, execution result exchange between master and slave processes, rollback coordination, and timeout exchange. Compiled only when WBCFG_MULTI_COMP_SUPPORT<\/code> is defined.<\/td>webconfig_framework_multi_comp.c<\/code><\/td><\/tr>
            webconfig_logging<\/code><\/td>Logging abstraction module. Provides wbTraceLogAPI()<\/code> as a printf<\/code>-based fallback logger, active when the build is configured with neither CCSP tracing nor the camera-platform logging backend.<\/td>webconfig_logging.c<\/code>, webconfig_logging.h<\/code><\/td><\/tr>
            webconfig_err<\/code><\/td>Error code definitions. Defines numeric error codes in the range 300\u2013950 covering execution states, queue failures, validation failures, and sub-system-specific failure categories.<\/td>webconfig_err.h<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
            \n\n\n\n
            Component Interactions<\/h2>\n\n\n\n
            WebconfigFramework interacts externally with the rbus daemon for all outbound signaling and event subscriptions. All platform-specific operations are performed exclusively by the consuming component through its registered callbacks.<\/p>\n\n\n\n
            Interaction Matrix<\/h3>\n\n\n\n
            Target Component \/ Layer<\/th>Interaction Purpose<\/th>Key APIs \/ Topics<\/th><\/tr><\/thead>
            External Systems<\/strong><\/td><\/td><\/td><\/tr>
            Webconfig Client<\/td>Deliver execution outcome (success \/ failure) and estimated timeout for each blob request<\/td>sendWebConfigSignal()<\/code> encoding ACK<\/code> \/ NACK<\/code> with sub-document name, txid, version, timeout, error code, and error message<\/td><\/tr>
            Webconfig Client<\/td>Notify current sub-document versions at component startup or after crash recovery<\/td>notifyVersion_to_Webconfig()<\/code> \u2192 sendWebConfigSignal()<\/code> with COMPONENT_INIT_EVENT<\/code> or COMPONENT_CRASH_EVENT<\/code><\/td><\/tr>
            Bus \/ IPC<\/strong><\/td><\/td><\/td><\/tr>
            rbus<\/td>All external IPC \u2014 outbound signals to webconfig client, inbound force-reset event, multi-component event delivery<\/td>rbus_open<\/code>, rbusEvent_Subscribe<\/code>, rbus_discoverComponentName<\/code>, rbusEvent_Publish<\/code>, rbusEvent_Unsubscribe<\/code><\/td><\/tr>
            POSIX Message Queue<\/td>Intra-process dispatch of blob requests from PushBlobRequest()<\/code> to messageQueueProcessing<\/code> thread<\/td>mq_open<\/code>, mq_send<\/code>, mq_receive<\/code>, mq_unlink<\/code> \u2014 queue named \/webconfig_queue-<process_name><\/code><\/td><\/tr>
            Consuming Component<\/strong><\/td><\/td><\/td><\/tr>
            RDK Component<\/td>Receive blob execution request and return error code\/message<\/td>executeBlobRequest(void*)<\/code> \u2192 pErr<\/code> callback<\/td><\/tr>
            RDK Component<\/td>Restore previous configuration state on execution failure<\/td>rollbackFunc()<\/code> callback<\/td><\/tr>
            RDK Component<\/td>Calculate execution time budget for a given number of blob entries<\/td>calcTimeout(size_t numOfEntries)<\/code> callback<\/td><\/tr>
            RDK Component<\/td>Release parsed blob data after execution completes<\/td>freeResources(void*)<\/code> callback<\/td><\/tr>
            RDK Component<\/td>Read current applied version for a sub-document<\/td>getVersion(char* subdoc_name)<\/code> callback<\/td><\/tr>
            RDK Component<\/td>Persist a newly applied version for a sub-document<\/td>setVersion(char* subdoc_name, uint32_t version)<\/code> callback<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
            Events Published<\/h3>\n\n\n\n
            Signal \/ Event<\/th>Topic<\/th>Trigger Condition<\/th>Receiver<\/th><\/tr><\/thead>
            ACK with timeout<\/td>rbus signal via sendWebConfigSignal<\/code><\/td>New blob version accepted and queued; reports estimated execution timeout<\/td>Webconfig Client<\/td><\/tr>
            ACK completion<\/td>rbus signal via sendWebConfigSignal<\/code><\/td>Blob execution returned BLOB_EXEC_SUCCESS<\/code><\/td>Webconfig Client<\/td><\/tr>
            NACK<\/td>rbus signal via sendWebConfigSignal<\/code><\/td>Blob execution failed, timed out, queue full, or null function pointer; includes ErrorCode<\/code> and ErrorMsg<\/code><\/td>Webconfig Client<\/td><\/tr>
            COMPONENT_INIT_EVENT<\/code><\/td>rbus signal via sendWebConfigSignal<\/code><\/td>Component startup without crash (init-file absent at check_component_crash()<\/code>)<\/td>Webconfig Client<\/td><\/tr>
            COMPONENT_CRASH_EVENT<\/code><\/td>rbus signal via sendWebConfigSignal<\/code><\/td>Component restart after crash (init-file present at check_component_crash()<\/code>)<\/td>Webconfig Client<\/td><\/tr>
            multiCompBroadCastSignal<\/code><\/td>rbus event<\/td>Master has a blob requiring slave participation; announces master name and subdoc<\/td>Slave components<\/td><\/tr>
            multiCompSlaveProcessSignal<\/code><\/td>rbus event<\/td>Master sends blob data or rollback request to a specific slave component<\/td>Slave component<\/td><\/tr>
            multiCompMasterProcessSignal<\/code><\/td>rbus event<\/td>Slave sends ready-signal, timeout value, or execution result back to master<\/td>Master component<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
            IPC Flow Patterns<\/h3>\n\n\n\n
            Primary Request \/ Response Flow:<\/strong><\/p>\n\n\n\n
            PushBlobRequest()<\/code> is the API boundary between the consuming component and the framework. Validation and version deduplication occur synchronously in the caller’s thread before the request enters the asynchronous queue path.<\/p>\n\n\n\n
            sequenceDiagram\n    participant Component as RDK Component\n    participant WCF as WebconfigFramework\n    participant POSIXMQ as POSIX Message Queue\n    participant RBUS as rbus\n\n    Component->>WCF: PushBlobRequest(execData)\n    WCF->>WCF: Version check (deduplicate)\n    WCF->>WCF: addEntryToQueue\n    WCF->>RBUS: ACK signal (timeout estimate)\n    WCF->>POSIXMQ: mq_send(execData)\n    POSIXMQ->>WCF: mq_receive (processing thread)\n    WCF->>Component: executeBlobRequest callback\n    Component-->>WCF: Err result\n    WCF->>RBUS: ACK or NACK signal (final result)<\/pre><\/div>\n\n\n\n
            Force-Reset Event Flow:<\/strong><\/p>\n\n\n\n
            sequenceDiagram\n    participant WebcfgClient as Webconfig Client\n    participant RBUS as rbus\n    participant WCF as WebconfigFramework\n\n    WebcfgClient->>RBUS: Publish Device.X_RDK_WebConfig.webcfgSubdocForceReset\n    RBUS->>WCF: subdocForceReset_callbk_rbus (comma-separated subdoc names)\n    WCF->>WCF: resetSubdocVersion() for each subdoc name\n    Note over WCF: In-memory version set to 0.\n    Note over WCF: Next delivery accepted as a new update.<\/pre><\/div>\n\n\n\n
            Multi-Component Execution Flow:<\/strong><\/p>\n\n\n\n
            sequenceDiagram\n    participant WebcfgClient as Webconfig Client\n    participant Master as Master Component + WCF\n    participant RBUS as rbus\n    participant Slave as Slave Component + WCF\n\n    WebcfgClient->>Master: Blob delivery\n    Master->>RBUS: Publish multiCompBroadCastSignal (master name, subdoc)\n    RBUS->>Slave: Broadcast received\n    Slave->>RBUS: Subscribe multiCompSlaveProcessSignal\n    Slave->>RBUS: Publish multiCompMasterProcessSignal (READY_TO_RECEIVE_DATA)\n    RBUS->>Master: Slave is ready\n    Master->>RBUS: Publish multiCompSlaveProcessSignal (blob data)\n    RBUS->>Slave: Blob data received\n    Slave->>Slave: executeBlobRequest callback\n    Slave->>RBUS: Publish multiCompMasterProcessSignal (result)\n    RBUS->>Master: Execution result\n    Master->>RBUS: sendWebConfigSignal (ACK or NACK)\n    RBUS->>WebcfgClient: Final result<\/pre><\/div>\n\n\n\n
            \n\n\n\n
            Implementation Details<\/h2>\n\n\n\n
            Key Implementation Logic<\/h3>\n\n\n\n
              \n
            • State \/ Lifecycle Management<\/strong>: The circular queue (queueInfo<\/code>) is the primary runtime state structure. Each entry tracks version, transaction ID, timeout, blob execution state (NOT_STARTED<\/code>, PENDING<\/code>, IN_PROGRESS<\/code>, COMPLETED<\/code>, FAILED<\/code>), and the execData<\/code> pointer for deferred memory release. Queue state transitions are protected by queue_access<\/code> mutex.<\/li>\n\n\n\n
            • Queue management: webconfig_framework.c<\/code><\/li>\n\n\n\n
            • Version registry: webconfig_framework.c<\/code> (blobRegInfo<\/code> array, reg_subdoc<\/code> mutex)<\/li>\n\n\n\n
            • Event Processing<\/strong>: Blob requests arrive at PushBlobRequest()<\/code>, are serialized into the POSIX message queue (mq_send<\/code>), and consumed by messageQueueProcessing<\/code>. The worker thread spawns a cancelable execute_request<\/code> thread per request and waits on webconfig_exec_completed<\/code> condition variable with an absolute monotonic deadline of MAX_FUNC_EXEC_TIMEOUT \u00d7 calcTimeout<\/code> seconds. In multi-component mode, rbus event callbacks deliver signals to dedicated master\/slave processing threads via pthread_cond_signal<\/code> on MultiCompCond<\/code>.<\/li>\n\n\n\n
            • Error Handling Strategy<\/strong>: executeBlobRequest<\/code> returns a heap-allocated pErr<\/code> struct containing a uint16_t ErrorCode<\/code> and a 128-byte ErrorMsg<\/code>. Error code BLOB_EXEC_SUCCESS<\/code> (300) indicates success; all other non-zero codes trigger NACK. The special code VALIDATION_FALIED<\/code> (307) (note: spelled this way in webconfig_err.h<\/code>) suppresses rollback invocation since no state was changed. The error code and message are embedded verbatim into the NACK signal sent to the webconfig client. The framework frees the returned pErr<\/code> struct after processing.<\/li>\n\n\n\n
            • Logging & Diagnostics<\/strong>: The logging module selects its backend at compile time: WbInfo<\/code>, WbError<\/code>, WbWarning<\/code>, and WbDebug<\/code> macros map to CCSP trace functions when CCSP_SUPPORT_ENABLED<\/code> is set, to cimplog_*<\/code> functions when ENABLE_RDKC_SUPPORT<\/code> is set, and to wbTraceLogAPI()<\/code> (a printf<\/code>-based implementation) otherwise.<\/li>\n\n\n\n
            • Logger module name: WEBCONFIG<\/code> (cimplog tag); LOG.RDK.WEBCONFIG<\/code> is returned by rdk_logger_module_fetch()<\/code> when ENABLE_RDKC_SUPPORT<\/code> is enabled.<\/li>\n\n\n\n
            • Runtime debug trigger: creating \/tmp\/webconfig_dbg<\/code> activates the display_subDocs<\/code> thread to log queue state and registered sub-document versions at a configurable interval.<\/li>\n<\/ul>\n\n\n\n
              \n\n\n\n
              Configuration<\/h2>\n\n\n\n
              Key Configuration Parameters<\/h3>\n\n\n\n
              Parameter<\/th>Type<\/th>Default<\/th>Description<\/th><\/tr><\/thead>
              DEFAULT_TIMEOUT<\/code><\/td>size_t<\/code> (seconds)<\/td>10<\/code><\/td>Base timeout added to every blob execution timeout calculation when using the default defFunc_calculateTimeout<\/code>.<\/td><\/tr>
              DEFAULT_TIMEOUT_PER_ENTRY<\/code><\/td>size_t<\/code> (seconds)<\/td>3<\/code><\/td>Per-entry timeout increment applied by the default timeout calculation function. Total default timeout = DEFAULT_TIMEOUT + (numOfEntries \u00d7 DEFAULT_TIMEOUT_PER_ENTRY)<\/code>.<\/td><\/tr>
              MAX_FUNC_EXEC_TIMEOUT<\/code><\/td>multiplier<\/td>3<\/code><\/td>Multiplier applied to the component-calculated (or default) timeout when setting the pthread_cond_timedwait<\/code> deadline for the execute_request<\/code> thread.<\/td><\/tr>
              QUEUE_SIZE<\/code><\/td>int<\/td>10<\/code><\/td>Maximum number of concurrent blob requests held in the circular queue per registered component.<\/td><\/tr>
              MAX_EVENTS_IN_MQUEUE<\/code><\/td>int<\/td>10<\/code><\/td>POSIX message queue depth (mq_maxmsg<\/code>).<\/td><\/tr>
              MAX_RESPONSE_TIME<\/code><\/td>int (seconds)<\/td>150<\/code><\/td>Maximum time the master component waits for a slave response in multi-component execution before declaring a timeout.<\/td><\/tr>
              SUBDOC_FORCE_RESET_SUB_TIMEOUT<\/code><\/td>int (seconds)<\/td>60<\/code><\/td>Subscription timeout passed to rbusEvent_Subscribe<\/code> for the force-reset event.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
              Runtime Configuration<\/h3>\n\n\n\n
              The debug verbosity of the display_subDocs<\/code> thread can be adjusted at runtime by writing interval and iteration count values to \/tmp\/webconfig_dbg<\/code>:<\/p>\n\n\n\n
              echo \"<interval_seconds> <num_iterations>\" > \/tmp\/webconfig_dbg<\/pre>\n\n\n\n
              When the file is present, the thread logs registered sub-document names, current versions, and queue state for <num_iterations><\/code> cycles at <interval_seconds><\/code> intervals, then removes the file and returns to idle.<\/p>\n\n\n\n
              Configuration Persistence<\/h3>\n\n\n\n
              Version state is maintained through the setVersion<\/code> and getVersion<\/code> callbacks supplied by the consuming component at registration. The framework invokes setVersion<\/code> after each successful blob execution and calls getVersion<\/code> at registration time to populate its in-memory version registry.<\/p>\n","protected":false},"excerpt":{"rendered":"
              WebconfigFramework is a shared C library (libwebconfig_framework) that provides RDK middleware components with a standardized […]<\/p>\n","protected":false},"author":659,"featured_media":0,"parent":9844,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-13002","page","type-page","status-publish","hentry"],"yoast_head":"\nWebconfigFramework - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"WebconfigFramework - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"WebconfigFramework is a shared C library (libwebconfig_framework) that provides RDK middleware components with a standardized […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2026-08-04T05:25:27+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"11 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/\",\"name\":\"WebconfigFramework - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2026-08-03T07:44:14+00:00\",\"dateModified\":\"2026-08-04T05:25:27+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Video\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"WebconfigFramework\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"WebconfigFramework - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/","og_locale":"en_US","og_type":"article","og_title":"WebconfigFramework - RDK Documentation Portal | Documentation","og_description":"WebconfigFramework is a shared C library (libwebconfig_framework) that provides RDK middleware components with a standardized […]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2026-08-04T05:25:27+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"11 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/","name":"WebconfigFramework - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2026-08-03T07:44:14+00:00","dateModified":"2026-08-04T05:25:27+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/webconfigframework\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Video","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_video_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"WebconfigFramework"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/13002","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/659"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=13002"}],"version-history":[{"count":1,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/13002\/revisions"}],"predecessor-version":[{"id":13003,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/13002\/revisions\/13003"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9844"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=13002"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}