Notify component is used to notify interested protocol agents to the change of subscribed parameter values/events.
| draw.io Diagram | ||||
|---|---|---|---|---|
|
Three types of notification messages exist for the notification for connected clients to work.
NotifyMsg 1 : Notification Message from the individual interface component to LMLite about any update of the existing connected devices or any new connections.
NotifyMsg 2: Notification Message from LMLite to the Notify component
NotifyMsg 3: Notification message from Notify component to the PA’s who have registered for notifications for connected device.
In this type of notification message, the connected device components like WiFi,MoCA, Ethernet sets a dedicated parameter of LMLite. As and when this notify message comes from a component to LMLite, the dedicated parameter is parsed and the host table is updated accordingly.
Example: For WiFi the dedicated parameter is “Device.Hosts. X_RDKCENTRALCOM_LMHost_Sync_From_WiFi”.
This parameter is of string type and contains values for fields phyAddr, ssid, status and so on
LMLite monitors the values of all the connected clients.Whenever any connection/disconnection updates happen in host table it updates the notify component.
The data sent from LMLite to notify component is status, MAC, interface of the connected device.
Notify component maintains a table of parameters for which PA's are interested to be notified.
Whenever the notify component receives a NotifyMsg2 from LMLite, it search's this table and notifies the interested protocol agents.
| Code Block |
|---|
190412-09:07:06.362896 [mod=NOTIFY, lvl=NOTICE] [tid=8101] Connect to bus daemon...
190412-09:07:06.399693 [mod=NOTIFY, lvl=INFO] [tid=8101] INFO: bus_handle: 0x 42de98
190412-09:07:07.409584 [mod=NOTIFY, lvl=NOTICE] [tid=8101] ssp_engage
190412-09:07:07.410030 [mod=NOTIFY, lvl=WARN] [tid=8101] Register empty object : com.
190412-09:07:07.410183 [mod=NOTIFY, lvl=WARN] [tid=8101] Register empty object : com.cisco.
190412-09:07:07.410317 [mod=NOTIFY, lvl=WARN] [tid=8101] Register empty object : com.cisco.spvtg.
190412-09:07:07.410462 [mod=NOTIFY, lvl=WARN] [tid=8101] Register empty object : com.cisco.spvtg.ccsp.
190412-09:07:07.413791 [mod=NOTIFY, lvl=WARN] [tid=8101] DM Library module name = CCSP Base Data Model
190412-09:07:07.437794 [mod=NOTIFY, lvl=WARN] [tid=8101] DM Library module name = COSA_TR181_USGv2
190412-09:07:07.474303 [mod=NOTIFY, lvl=WARN] [tid=8101] Search for empty object in 'dslhCpeCheckEmptyObject'
190412-09:07:08.973951 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.IP.Interface.1.IPv4Address.1.IPAddress is added in the list by eRT.com.cisco.spvtg.ccsp.tr069pa
190412-09:07:29.180399 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.NotifyComponent.X_RDKCENTRAL-COM_Connected-Client is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.197046 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.Bridging.Bridge.1.Port.8.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.216638 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.Bridging.Bridge.2.Port.2.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.233987 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.1.Security.ModeEnabled is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.277507 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.1.SSIDAdvertisementEnabled is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.311655 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.1.X_CISCO_COM_MACFilter.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.324732 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.1.X_CISCO_COM_MACFilter.FilterAsBlackList is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.338687 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.2.Security.ModeEnabled is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.349138 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.2.SSIDAdvertisementEnabled is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.373733 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.2.X_CISCO_COM_MACFilter.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.386728 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.AccessPoint.2.X_CISCO_COM_MACFilter.FilterAsBlackList is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.399528 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.Radio.1.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.415133 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.Radio.2.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.427273 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.SSID.1.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.442179 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.SSID.1.SSID is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.457338 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.SSID.2.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.468374 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.WiFi.SSID.2.SSID is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.480294 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_DeviceControl.LanManagementEntry.1.LanMode is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.492051 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_Security.Firewall.FilterAnonymousInternetRequests is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.504599 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_Security.Firewall.FilterHTTP is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.528328 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_Security.Firewall.FilterIdent is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.540371 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_Security.Firewall.FilterMulticast is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.552318 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_Security.Firewall.FilterP2P is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.568543 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_Security.Firewall.FirewallLevel is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.583100 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_DeviceControl.LanManagementEntry.1.LanIPAddress is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.595523 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.X_CISCO_COM_DeviceControl.LanManagementEntry.1.LanSubnetMask is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.607201 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.DHCPv4.Server.Pool.1.MinAddress is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.618843 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.DHCPv4.Server.Pool.1.MaxAddress is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.633372 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.DHCPv4.Server.Pool.1.LeaseTime is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.652253 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.NAT.X_CISCO_COM_DMZ.Enable is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.664287 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.NAT.X_CISCO_COM_DMZ.InternalIP is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.677985 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.NAT.X_CISCO_COM_DMZ.IPv6Host is added in the list by eRT.com.cisco.spvtg.ccsp.webpaagent
190412-09:07:29.697284 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.NotifyComponent.X_RDKCENTRAL-COM_Connected-Client is added in the list by eRT.com.cisco.spvtg.ccsp.meshagent
190412-09:08:25.453146 [mod=NOTIFY, lvl=INFO] [tid=8108]
Notification : Parameter Device.ManagementServer.ConnectionRequestURL is added in the list by eRT.com.cisco.spvtg.ccsp.tr069pa |
| Markdown |
|---|
...
The NotifyComponent is a centralized notification service in the RDK-B middleware that manages parameter change notifications between different RDK-B components and protocol agents. It acts as a notification broker that allows components to register interest in specific TR-181 parameter changes and distributes notifications when those parameters are modified. This component ensures efficient and reliable communication across the RDK-B stack by providing a unified notification mechanism for parameter value changes, reducing direct inter-component dependencies and enabling scalable event-driven architecture. The NotifyComponent provides essential services to the RDK-B ecosystem by maintaining a dynamic registry of parameter interests from various protocol agents (WebPA, TR-069, DMCLI, SNMP, Wi-Fi, and Mesh), processing notification requests through a message queue system, and distributing parameter change notifications to all registered subscribers. At the module level, it implements a thread-safe notification engine with persistent parameter registration, message queue-based asynchronous communication, and flexible notification masks that allow fine-grained control over which protocol agents receive specific notifications. ```mermaid graph LR subgraph "External Systems" RemoteMgmt["Remote Management"] LocalUI["Local Web UI"] SNMPNMS["SNMP Network Management"] end subgraph "RDK-B Platform" subgraph "Remote Management Agents" ProtocolAgents["Protocol Agents"] TR069PA["TR-069 PA"] WebPA["WebPA"] SNMPAgent["SNMP Agent"] WiFiAgent["WiFi Agent"] MeshAgent["Mesh Agent"] end subgraph "Notification Framework" NotifyComp["NotifyComponent"] end subgraph "RDK-B Core Components" PAMComp["P&M Component"] CcspCr["Component Registry"] OtherComps["Other RDK-B Components"] end end subgraph "System Layer" MessageQueue["POSIX Message Queue"] FileSystem["Persistent Storage"] Linux["Linux Kernel"] end %% External connections RemoteMgmt -->|TR-069/WebPA| ProtocolAgents LocalUI -->|HTTP/HTTPS| WebPA SNMPNMS -->|SNMP Protocol| SNMPAgent %% Protocol Agents to NotifyComponent ProtocolAgents -->|IPC| NotifyComp TR069PA -->|Register Parameters| NotifyComp WebPA -->|Register Parameters| NotifyComp SNMPAgent -->|Register Parameters| NotifyComp WiFiAgent -->|Register Parameters| NotifyComp MeshAgent -->|Register Parameters| NotifyComp %% NotifyComponent to Other RDK-B Components NotifyComp -->|IPC| PAMComp NotifyComp -->|IPC| CcspCr NotifyComp -->|IPC| OtherComps %% System Layer Integration NotifyComp <-->|Message Queue I/O| MessageQueue NotifyComp <-->|Registration Cache| FileSystem PAMComp -->|Parameter Changes| MessageQueue OtherComps -->|Parameter Changes| MessageQueue %% System integration MessageQueue <-->|System Calls| Linux FileSystem <-->|File Operations| Linux classDef external fill:#fff3e0,stroke:#ef6c00,stroke-width:2px; classDef notifyComponent fill:#e3f2fd,stroke:#1976d2,stroke-width:3px; classDef rdkbComponent fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px; classDef system fill:#fce4ec,stroke:#c2185b,stroke-width:2px; class RemoteMgmt,LocalUI,SNMPNMS external; class NotifyComp notifyComponent; class ProtocolAgents,TR069PA,WebPA,SNMPAgent,WiFiAgent,MeshAgent,PAMComp,CcspCr,OtherComps rdkbComponent; class MessageQueue,FileSystem,Linux system; ``` **Key Features & Responsibilities**: - **Centralized Notification Management**: Acts as a broker for all TR-181 parameter change notifications across RDK-B components, eliminating the need for point-to-point notification connections - **Dynamic Parameter Registration**: Allows protocol agents to dynamically register and unregister interest in specific TR-181 parameters using flexible notification masks - **Multi-Protocol Support**: Supports notifications for WebPA, TR-069, DMCLI, SNMP, Wi-Fi, and Mesh protocol agents with individual notification mask management - **Asynchronous Message Processing**: Implements a message queue-based system for handling parameter change notifications without blocking the sender components - **Persistent Registration Storage**: Maintains parameter registration information in persistent storage to survive component restarts and crashes - **Thread-Safe Operations**: Uses dynamic linked list management and thread-safe operations to handle concurrent registration and notification requests ## Design The NotifyComponent follows a broker-based design pattern that centralizes notification management while maintaining loose coupling between RDK-B components and protocol agents. The design implements a hub-and-spoke topology where the NotifyComponent serves as the central hub that receives parameter change notifications from any RDK-B component and distributes them to all registered protocol agents based on their subscription masks. This approach significantly reduces the complexity of inter-component communication by eliminating the need for each component to maintain direct connections with multiple protocol agents. The design integrates seamlessly with the RDK-B messaging infrastructure through both synchronous and asynchronous communication patterns. For northbound interactions with protocol agents, the component uses RBus/DBUS for parameter registration and notification delivery, ensuring reliable and standardized communication. For southbound interactions, it employs POSIX message queues to receive parameter change notifications from other RDK-B components, enabling asynchronous and non-blocking communication that doesn't impact the performance of notifying components. The IPC mechanisms are carefully chosen based on communication requirements - RBus/DBUS provides reliable synchronous communication for registration operations and notification delivery, while POSIX message queues enable high-performance asynchronous communication for parameter change events. The component also implements persistent data storage through file-based caching of registration information, allowing it to recover quickly after restarts without requiring re-registration from all protocol agents. This hybrid approach optimizes both performance and reliability across different communication scenarios. ```mermaid %%{init: { "flowchart": { "useMaxWidth": true, "diagramPadding": 16, "htmlLabels": true }, "themeVariables": { "fontSize": "12px" } }}%% flowchart TD subgraph " |
...
Notify Component<br> Internal Architecture" subgraph "Interface Layer" TR181API[TR-181 API Handler<br/>cosa_apis_NotifyComponent.h] SSPFramework[SSP Framework<br/>ssp_main.c, plugin_main.c] end subgraph "Core Processing" RegMgr[Registration Manager<br/>AddNotifyParam/DelNotifyParam] EventEngine[Event Processing Engine<br/>Event_HandlerThread] NotifyDispatcher[Notification Dispatcher<br/>Notify_To_PAs/Find_Param] MaskMgr[Notification Mask Manager<br/>PA_to_Mask] end subgraph "Data Management" ParamRegistry[Parameter Registry<br/>Dynamic Linked List] PersistLayer[Persistence Layer<br/>UpdateNotifyParamFile/ReloadNotifyParam] end subgraph "Communication" IPCInterface[IPC Interface<br/>RBus/DBUS Handling] MsgQueueHandler[Message Queue Handler<br/>MsgPosttoQueue] end end %% Interface connections TR181API --> RegMgr SSPFramework --> IPCInterface %% Core processing flow RegMgr --> ParamRegistry RegMgr --> PersistLayer EventEngine --> NotifyDispatcher NotifyDispatcher --> MaskMgr NotifyDispatcher --> ParamRegistry MaskMgr --> IPCInterface %% Data flow ParamRegistry --> PersistLayer EventEngine --> MsgQueueHandler %% External interfaces IPCInterface -.->|Protocol Agents| TR181API MsgQueueHandler -.->|RDK-B Components| EventEngine classDef interface fill:#e3f2fd,stroke:#1976d2,stroke-width:2px; classDef core fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px; classDef data fill:#fff3e0,stroke:#ef6c00,stroke-width:2px; classDef comm fill:#fce4ec,stroke:#c2185b,stroke-width:2px; class TR181API,SSPFramework interface; class RegMgr,EventEngine,NotifyDispatcher,MaskMgr core; class ParamRegistry,PersistLayer data; class IPCInterface,MsgQueueHandler comm; ``` ### Prerequisites and Dependencies **Build-Time Flags and Configuration:** | Configure Option | DISTRO Feature | Build Flag | Purpose | Default | |------------------|----------------|------------|---------|---------| | `--enable-unitTestDockerSupport` | N/A | `UNIT_TEST_DOCKER_SUPPORT` | Enable Docker support for unit testing with specialized test harness | Disabled | |
...
|
...
**RDK-B Platform and Integration Requirements:**
* **RDK-B Components**: `CcspCommonLibrary`, `CcspCr`, `utopia`, `rdk-logger`
* **HAL Dependencies**: No direct HAL dependencies - operates at middleware layer only
* **Systemd Services**: `CcspCrSsp.service` must be active before `NotifyComponent.service` starts
* **Message Bus**: RBus registration under component-specific namespace for IPC communication
* **TR-181 Data Model**: `Device.NotifyComponent.*` namespace for configuration parameters
* **Configuration Files**:`NotifyComponent.xml` for TR-181 parameter definitions with dm_pack_code_gen.py code generation, `msg_daemon.cfg` for message bus configuration, `/tmp/.NotifyParamListCache` for persistent registration storage.
* **Startup Order**: Initialize after Component Registry and message bus daemon are running
|
...
|
...
**Threading Model:**
The NotifyComponent implements a minimal multi-threaded architecture designed for efficient notification processing while maintaining thread-safe operations and minimal resource utilization.
| Thread & Function | Purpose | Cycle/Timeout | Synchronization |
|-------------------|---------|----------------|------------------|
| **Main Thread** |
...
`main()` / `ssp_main()` | Component initialization, TR-181 parameter processing, RBus message handling | Event-driven message loop, RBus callbacks, SSP lifecycle management | RBus async callbacks, component lifecycle mutexes | | **Event Handler Thread** |
...
`Event_HandlerThread()` / `CreateEventHandlerThread()` | Primary notification processing thread that monitors POSIX message queue for parameter change notifications and coordinates notification distribution to registered protocol agents | Continuous monitoring loop with `mq_receive()`, processes incoming messages from `/Notify_queue` and triggers notification distribution | POSIX message queue synchronization, AnscAllocateMemory/AnscFreeMemory for thread-safe memory operations | ### Component State Flow **Initialization to Active State** The NotifyComponent follows a structured initialization sequence that establishes all necessary IPC connections, recovers persistent state, and activates the notification processing system before becoming fully operational. ```mermaid sequenceDiagram participant System as System Startup participant NotifyComp as NotifyComponent participant MsgBus as Message Bus (RBus/DBUS) participant MsgQueue as POSIX Message Queue participant FileSystem as File System participant EventThread as Event Handler Thread System->>NotifyComp: Initialize Component Note over NotifyComp: State: Initializing<br/>Setup logging, memory pools NotifyComp->>MsgBus: Connect to Message Bus MsgBus-->>NotifyComp: Connection Established Note over NotifyComp: State: Initializing → ConnectingBus NotifyComp->>MsgBus: Register TR-181 Parameters MsgBus-->>NotifyComp: Parameter Registration Complete Note over NotifyComp: State: ConnectingBus → RegisteringParams NotifyComp->>MsgQueue: Create/Open Message Queue MsgQueue-->>NotifyComp: Queue Ready (/Notify_queue) Note over NotifyComp: State: RegisteringParams → InitializingQueue NotifyComp->>FileSystem: Load Persistent Registrations FileSystem-->>NotifyComp: Registration Cache Loaded Note over NotifyComp: State: InitializingQueue → LoadingCache NotifyComp->>EventThread: Create Event Handler Thread EventThread-->>NotifyComp: Thread Started Note over NotifyComp: State: LoadingCache → Active NotifyComp->>System: Initialization Complete (Active State) loop Runtime Operations Note over NotifyComp: State: Active<br/>Process registrations & notifications EventThread->>MsgQueue: Monitor for Parameter Changes NotifyComp->>MsgBus: Send Notifications to Protocol Agents end System->>NotifyComp: Stop Request Note over NotifyComp: State: Active → Shutdown NotifyComp->>FileSystem: Save Registration Cache NotifyComp->>EventThread: Stop Event Handler Thread NotifyComp->>MsgQueue: Close Message Queue NotifyComp->>MsgBus: Disconnect from Message Bus NotifyComp->>System: Shutdown Complete ``` **Runtime State Changes and Context Switching** The NotifyComponent maintains operational state primarily through its dynamic parameter registry and does not implement complex state machines, focusing instead on event-driven processing with minimal state transitions. **State Change Triggers:** - **Registration Events**: Protocol agents registering/unregistering parameter interests trigger registry updates and persistent storage operations - **Parameter Change Notifications**: Incoming messages via POSIX queue trigger notification processing and distribution to registered subscribers - **Component Recovery**: After crashes or restarts, loading persistent cache triggers registry reconstruction without requiring re-registration **Context Switching Scenarios:** - **Protocol Agent Registration**: Component switches from idle monitoring to active registration processing when receiving registration requests - **Notification Processing**: Upon receiving parameter change messages, component switches context to notification distribution mode - **Persistence Operations**: During registry updates, component temporarily switches to file I/O context to maintain registration cache consistency ### Call Flow **Initialization Call Flow:** ```mermaid sequenceDiagram participant Init as Initialization Process participant NotifyComp as NotifyComponent participant MsgBus as Message Bus participant Storage as File System Init->>NotifyComp: Start Component NotifyComp->>NotifyComp: Initialize Global Variables & Memory NotifyComp->>MsgBus: Connect to RBus/DBUS MsgBus-->>NotifyComp: Connection Established NotifyComp->>MsgBus: Register TR-181 Parameters MsgBus-->>NotifyComp: Registration Complete NotifyComp->>Storage: Load Parameter Registry Cache Storage-->>NotifyComp: Registry Loaded NotifyComp->>NotifyComp: Create Event Handler Thread NotifyComp->>Init: Initialization Complete (Active State) ``` **Parameter Registration Call Flow:** ```mermaid sequenceDiagram participant ProtocolAgent as Protocol Agent<br/>(WebPA/TR-069/etc.) participant NotifyComp as NotifyComponent participant Registry as Parameter Registry participant Storage as Persistent Storage ProtocolAgent->>NotifyComp: SetNotifi_ParamName<br/>"AgentName,ParamName,true" Note over NotifyComp: Parse registration string<br/>Extract PA name, parameter, action NotifyComp->>NotifyComp: PA_to_Mask(AgentName) Note over NotifyComp: Convert agent name to notification mask alt Add Parameter Registration NotifyComp->>Registry: AddNotifyParam(PA_Name, param_name) Registry->>Registry: Search existing registrations alt Parameter exists Registry->>Registry: Update notification mask else New parameter Registry->>Registry: Create new registration entry end Registry-->>NotifyComp: Registration Updated NotifyComp->>Storage: UpdateNotifyParamFile() Storage-->>NotifyComp: Cache Updated else Remove Parameter Registration NotifyComp->>Registry: DelNotifyParam(PA_Name, param_name) Registry->>Registry: Remove PA from parameter mask Registry-->>NotifyComp: Registration Removed NotifyComp->>Storage: UpdateNotifyParamFile() Storage-->>NotifyComp: Cache Updated end NotifyComp-->>ProtocolAgent: Registration Complete ``` **Notification Processing Call Flow:** ```mermaid sequenceDiagram participant RDKBComponent as RDK-B Component participant MsgQueue as Message Queue<br/>/Notify_queue participant EventHandler as Event Handler Thread participant Registry as Parameter Registry participant Dispatcher as Notification Dispatcher participant ProtocolAgent as Protocol Agent RDKBComponent->>MsgQueue: Post Parameter Change<br/>"ParamName,NewValue" MsgQueue->>EventHandler: mq_receive() Note over EventHandler: Parse parameter name from message EventHandler->>Registry: Find_Param(param_name, message) Registry->>Registry: Search registration list alt Parameter Found in Registry Registry-->>EventHandler: Return notification mask EventHandler->>Dispatcher: Notify_To_PAs(PA_Bits, message) loop For each registered PA alt WebPA Agent registered Dispatcher->>ProtocolAgent: RBus notification to WebPA end alt TR-069 Agent registered Dispatcher->>ProtocolAgent: RBus notification to TR-069 end alt SNMP Agent registered Dispatcher->>ProtocolAgent: RBus notification to SNMP end alt Wi-Fi Agent registered Dispatcher->>ProtocolAgent: RBus notification to Wi-Fi end alt Mesh Agent registered Dispatcher->>ProtocolAgent: RBus notification to Mesh end end else Parameter Not Found Registry-->>EventHandler: No registrations found Note over EventHandler: Log message and continue end EventHandler->>MsgQueue: Continue monitoring queue ``` ## TR‑181 Data Models ### Supported TR-181 Parameters The NotifyComponent implements a minimal TR-181 interface focused specifically on managing parameter notification registrations. It follows the BBF TR-181 specification for parameter access patterns while providing custom extensions for notification management functionality. ### Object Hierarchy ``` Device. └── NotifyComponent. ├── Notifi_ParamName (string, R/W) ├── SetNotifi_ParamName (string, R/W) ├── X_RDKCENTRAL-COM_Connected-Client (string, R) └── X_RDKCENTRAL-COM_PresenceNotification (string, R) ``` ### Parameter Definitions **Core Parameters:** | Parameter Path | Data Type | Access | Default Value | Description | BBF Compliance | |----------------|-----------|--------|---------------|-------------|----------------| | `Device.NotifyComponent.Notifi_ParamName` | string | R/W | `""` | Read-only parameter for querying current notification registrations. Returns comma-separated list of registered parameter names for diagnostics. | Custom Extension | | `Device.NotifyComponent.SetNotifi_ParamName` | string | R/W | `""` | Primary interface for managing parameter notification registrations. Format: "AgentName,ParameterName,Action" where Action is "true" for add or "false" for remove. | Custom Extension | | `Device.NotifyComponent.X_RDKCENTRAL-COM_Connected-Client` | string | R | `""` | Special notification parameter for TR-069 connected client notifications. Provides information about client connection status changes. | Custom Extension | | `Device.NotifyComponent.X_RDKCENTRAL-COM_PresenceNotification` | string | R | `""` | Special notification parameter for presence detection events. Used for device presence and connectivity state notifications. | Custom Extension | ## Internal Modules The NotifyComponent is organized into several key modules that handle different aspects of notification management, from parameter registration to message processing and notification distribution. | Module/Class | Description | Key Files | |-------------|------------|-----------| | **Registration Manager** | Handles protocol agent registration requests, maintains dynamic parameter registry using linked list, and manages persistent storage of registrations | `cosa_apis_NotifyComponent.c` (AddNotifyParam, DelNotifyParam, NotifyParam functions) | | **Event Processing Engine** | Implements the core event handler thread that monitors POSIX message queue for parameter change notifications and coordinates notification distribution | `cosa_apis_NotifyComponent.c` (Event_HandlerThread, CreateEventHandlerThread) | | **Notification Dispatcher** | Processes notification requests, applies notification masks to determine target protocol agents, and delivers notifications via RBus/DBUS | `cosa_apis_NotifyComponent.c` (Notify_To_PAs, Find_Param, PA_to_Mask) | | **Persistence Layer** | Manages file-based caching of parameter registrations to survive component restarts and provides recovery mechanisms | `cosa_apis_NotifyComponent.c` (UpdateNotifyParamFile, ReloadNotifyParam) | | **IPC Interface** | Handles communication with protocol agents through TR-181 parameter interface and manages message queue operations | `cosa_apis_NotifyComponent.c` (NotifyComponent_SetParamStringValue, MsgPosttoQueue) | | **SSP Framework** | Provides CCSP integration layer including component lifecycle management, message bus registration, and system service integration | `ssp_main.c`, `plugin_main.c` | ## Component Interactions The NotifyComponent serves as a central hub for notification management across the RDK-B middleware, maintaining connections with protocol agents, other RDK-B components, and system services through multiple IPC mechanisms optimized for different communication patterns. ### Interaction Matrix | Target Component/Layer | Interaction Purpose | Key APIs/Endpoints | |------------------------|-------------------|------------------| | **Protocol Agents** | | TR-069 Protocol Agent | Parameter change notifications for ACS synchronization | `Device.TR069Notify.X_RDKCENTRAL-COM_Connected-Client`, `Device.TR069Notify.X_RDKCENTRAL-COM_TR069_Notification` | | WebPA Agent | Real-time parameter notifications for cloud management | `eRT.com.cisco.spvtg.ccsp.webpaagent` RBus interface | | SNMP Protocol Agent | SNMP trap generation for parameter changes | `SNMP` mask notifications via RBus | | Wi-Fi Agent | Wi-Fi specific parameter change notifications | `eRT.com.cisco.spvtg.ccsp.wifi` RBus interface | | Mesh Agent | Mesh network topology and status notifications | `eRT.com.cisco.spvtg.ccsp.meshagent` RBus interface | | DMCLI Agent | Command-line interface parameter notifications | `ccsp.busclient` RBus interface | | **RDK-B Middleware Components** | | P&M Agent | Device management parameter changes, system status updates | POSIX message queue `/Notify_queue` | | Component Registry | Component discovery and lifecycle management | RBus component registration and discovery | | Wi-Fi Manager | Wi-Fi configuration and status parameter changes | POSIX message queue `/Notify_queue` | | WAN Manager | WAN connectivity and configuration notifications | POSIX message queue `/Notify_queue` | | **System & Storage** | | POSIX Message Queue | Asynchronous parameter change notification delivery | `mq_open()`, `mq_send()`, `mq_receive()` for `/Notify_queue` | | File System | Persistent registration storage and crash recovery | `fopen()`, `fwrite()`, `fread()` for `/tmp/.NotifyParamListCache` | | RBus Daemon | Inter-process communication and service discovery | RBus registration, method calls, and event publishing | **Events Published by NotifyComponent:** | Event Name | Event Topic/Path | Trigger Condition | Subscriber Components | |------------|-----------------|-------------------|---------------------| | Parameter Change Notification | Protocol-specific RBus methods | Parameter value changes received via message queue | All registered protocol agents based on notification masks | | TR-069 Connected Client | `Device.TR069Notify.X_RDKCENTRAL-COM_Connected-Client` | Client connection status changes | TR-069 Protocol Agent | | TR-069 Notification | `Device.TR069Notify.X_RDKCENTRAL-COM_TR069_Notification` | TR-069 specific parameter changes | TR-069 Protocol Agent | | Presence Notification | `Device.NotifyComponent.X_RDKCENTRAL-COM_PresenceNotification` | Device presence detection events | WebPA Agent, Mesh Agent | ### IPC Flow Patterns **Primary IPC Flow - Parameter Registration:** ```mermaid sequenceDiagram participant PA as Protocol Agent participant RBus as RBus Daemon participant NotifyComp as NotifyComponent participant Registry as Parameter Registry participant Storage as File System PA->>RBus: SetParameterValues()<br/>Device.NotifyComponent.SetNotifi_ParamName<br/>"webpaagent,Device.WiFi.Radio.1.Enable,true" RBus->>NotifyComp: RBus Method Call Note over NotifyComp: Parse: PA="webpaagent"<br/>Param="Device.WiFi.Radio.1.Enable"<br/>Action="true" NotifyComp->>Registry: AddNotifyParam(webpaagent, Device.WiFi.Radio.1.Enable) Registry->>Registry: Update linked list with WebPA mask Registry-->>NotifyComp: Registration Complete NotifyComp->>Storage: UpdateNotifyParamFile() Storage-->>NotifyComp: Cache Updated NotifyComp-->>RBus: SetParameterValues Response (Success) RBus-->>PA: Registration Confirmed ``` **Event Notification Flow:** ```mermaid sequenceDiagram participant RDKBComp as RDK-B Component participant MsgQueue as Message Queue participant EventThread as Event Handler Thread participant Registry as Parameter Registry participant Dispatcher as Notification Dispatcher participant RBus as RBus Daemon participant WebPA as WebPA Agent participant TR069 as TR-069 Agent RDKBComp->>MsgQueue: mq_send(/Notify_queue)<br/>"Device.WiFi.Radio.1.Enable,true" Note over MsgQueue: Asynchronous delivery MsgQueue->>EventThread: mq_receive() EventThread->>Registry: Find_Param("Device.WiFi.Radio.1.Enable") Registry-->>EventThread: Found: NotifyMask=WebPA|TR069 EventThread->>Dispatcher: Notify_To_PAs(WebPA|TR069, message) par WebPA Notification Dispatcher->>RBus: RBus call to webpaagent RBus->>WebPA: Parameter Change Notification WebPA-->>RBus: Ack RBus-->>Dispatcher: Success and TR-069 Notification Dispatcher->>RBus: RBus call to tr069pa<br/>Device.TR069Notify.X_RDKCENTRAL-COM_TR069_Notification RBus->>TR069: Parameter Change Notification TR069-->>RBus: Ack RBus-->>Dispatcher: Success end Dispatcher-->>EventThread: Notifications Sent EventThread->>MsgQueue: Continue monitoring ``` ## Implementation Details ### Major HAL APIs Integration The NotifyComponent operates entirely within the RDK-B middleware layer and does not directly integrate with Hardware Abstraction Layer (HAL) APIs. It functions as a pure software service that manages inter-component communication without requiring hardware-specific operations. **No Direct HAL Integration:** The NotifyComponent's design philosophy emphasizes middleware-level notification management without hardware dependencies, allowing it to operate consistently across different RDK-B platform implementations regardless of underlying hardware variations. ### Key Implementation Logic - **Dynamic Parameter Registry Management**: The core state management is implemented using a dynamic linked list structure in `cosa_apis_NotifyComponent.c`, with thread-safe operations using ANSC memory management functions - Main implementation in `AddNotifyParam()` and `DelNotifyParam()` functions for registration management - Dynamic linked list traversal and modification in `Find_Param()` function for notification lookup - **Asynchronous Event Processing**: The message queue-based notification system enables non-blocking parameter change processing through dedicated thread management - POSIX message queue operations in `Event_HandlerThread()` with continuous monitoring loop - Message parsing and parameter extraction using `strtok_r()` for safe string tokenization - Thread-safe message processing with proper error handling and logging - **Notification Mask System**: Protocol agent identification and notification targeting implemented through bitmask operations for efficient subscriber management - Protocol agent to mask conversion in `PA_to_Mask()` function with lookup table - Notification distribution logic in `Notify_To_PAs()` with per-agent message delivery - Support for WebPA (0x1), DMCLI (0x2), SNMP (0x4), TR-069 (0x8), Wi-Fi (0x10), and Mesh (0x20) agents - **Persistent Registration Storage**: File-based caching system ensures registration persistence across component restarts and system failures - Registration serialization in `UpdateNotifyParamFile()` with atomic file operations - Recovery mechanism in `ReloadNotifyParam()` for startup registration reconstruction - Crash-resilient design with immediate cache updates on registration changes - **Error Handling Strategy**: Comprehensive error detection and recovery mechanisms for robust operation in production environments - POSIX message queue error handling with automatic retry and graceful degradation - File I/O error management with fallback to in-memory operation - RBus communication error handling with logging and continuation of service - **Logging & Debugging**: Multi-level logging system with component-specific trace categories for operational visibility - Parameter registration and notification activity logging with `CcspNotifyCompTraceInfo()` - Error condition logging with detailed context information - Debug support for registration state inspection and message flow tracing ### Key Configuration Files | Configuration File | Purpose | Override Mechanisms | |--------------------|---------|--------------------| | `NotifyComponent.xml` | TR-181 parameter definitions and COSA API function mappings for component interface | Environment variable overrides for file location | | `msg_daemon.cfg` | Message bus daemon configuration for RBus/DBUS connectivity | Command-line parameters during component startup | | `/tmp/.NotifyParamListCache` | Runtime persistent storage for parameter registrations to survive restarts | Automatic regeneration if file is corrupted or missing | | `configure.ac` | Build-time configuration for autotools integration and dependency management | Configure script parameters and cross-compilation settings | |