ConfigChannelHandler
This chapter describes the ConfigChannelHandler class, which exposes public methods for handling both synchronous and asynchronous requests. ConfigChannelHandler processes messages that carry configuration changes, which can occur at any time.
The ConfigChannelHandler class contains the following public methods
- setOnDataReceivedHandler - Sets handler to handle logical operations related to configuration.
- _waitForDone - Waiting for the main threads to complete. The CommonBackend class calls this automatically.
- processPacketsReceivedDuringSynchronousRequest - Responses received during a <functionName>Synchronously();. Requests that do not correspond to the expected response are buffered. Requires that setOnDataReceivedHandler must be called beforehand.
- _sendBackendApiCompatibility - Sends the compatibility level of the backend API after the comparison of NGA Manager and backend versions, is called by the CommonBackend class and does not have to be called manually.
Synchronous requests
- requestDatabaseParametersSynchronously - Requests the parameters of the database specified in the project in the Database Engineering panel (database address, user, password, database name, and specific database options).
- getWinCcOaSystemOfFrontendSynchronously - Requests information about the system of the WinCC OA project. The response contains the name and number of the system.
- requestArchiveGroupDeltaSynchronously - Requests the list of archive groups in the database and WinCC OA.
- requestMetadataDeltaSynchronously - Requests the list of data points (name, type, archive group, etc.) in WinCC OA
- requestRedundancyInfoSynchronously - Requests the current state of the redundancy.
- amI_RBackend - Requests if the backend is redundant.
Asynchronous requests (the response is received in the callback set via external handler - setOnDataReceivedHandler, onWriteRequest, etc.)
There are asynchronous variations for the requests - for the descriptions, see the descriptions above, e.g. requestDatabaseParametersSynchronously:
- requestDatabaseParameters
- requestMetadataDelta
- requestArchiveGroupDelta
- getWinCcOaSystemOfFrontend
- requestRedundancyInfo
- requestRedundancyBackendType
- requestValuesNewerThan - Retrieves values more recent than the supplied parameter (a timestamp). Mainly used at startup to load the most recent records modified since the last timestamp stored in the database.
- requestCurrentAlerts - Requests current alerts from the NGA Manager.
- sendArchiveGroupNextBackupUpdate - Sends the time of the next predictable backup according to the settings of the archive group.
- sendSegmentMetadataList - Sends lists of segments with actual states to the NGA Manager.
- sendMonitoringUpdate -Sends backend status information—such as database connection state, current errors, and details of the most recent error—for display in the WinCC OA UI. Calling sendMonitoringUpdate updates internal backend monitoring data points, such as monitor.backendConnectionToDB.
- _doLogMessage - Directly send a log message. Use CommonBackend::getLoggingInterface() instead.
For more information, see Database parameters, Wincc OA project system information, Metadata, Last values DatabaseActivityMonitor handlers and DataReceivedHandler.
