Critical Application Monitoring (CAM)
v1.0
Overview
Introduction
Principle of Operation
Components
Build System
Documentation
cam-uuid
cam-app-example
libcam
cam-service
cam-tool
Test Suites
Contributions and Issue Reporting
Feedback and Support
Getting Started
Build Host Environment Setup
System Requirements
Install Dependencies
Download
Build
Setup terminal environment
Run
CAM Integration with Kronos
Development Manual
libcam API
Message Protocol
Message Header
Stream Initialization Message
Critical Application to
cam-service
cam-service
to Critical Application
Stream Start Message
Critical Application to
cam-service
Stream Stop Message
Critical Application to
cam-service
Stream Event Message
Critical Application to
cam-service
Stream Deploy Message
Deployment Application to
cam-service
cam-service
to Deployment Application
Stream Event Log File Format
Header Section
Metadata Section
State Control Section
Log Entries Section
Start
Stop
End
Event
Stream Configuration File Format
Header Section
Metadata block
State control block
Event alarms block
Example
Stream Deployment File Format
Header Section
Metadata Section
State Control Section
Event Alarms Section
Development Guidelines
Coding Style
Source Code
Unicode
License Headers
C Code Style
Clang Format
Braces
Operators
Operator Precedence
Header Guards
Inclusion Policy
Macros and Constants
Symbol Naming
Loop Indices
Types
Comments
Initialization
Doxygen Comments
Python
Sphinx-based Documents
Headings
Code blocks
Alignment and Indentation
Validation
Unit Tests
C based CAM components
Python based CAM component
Integration Tests
License
SPDX Identifiers
Release Notes
v1.0
New Features
Changed
Limitations
Known Issues
Critical Application Monitoring (CAM)
Index
Index
C
C
cam_ctx_t (C++ type)
CAM_DEFAULT_PORT (C macro)
cam_end (C++ function)
CAM_ERROR (C macro)
cam_init (C++ function)
cam_stream_cal_config (C++ struct)
cam_stream_cal_config::file_name (C++ member)
cam_stream_cal_config::timeout_i2s (C++ member)
cam_stream_cal_config::timeout_s2e (C++ member)
cam_stream_config (C++ struct)
cam_stream_config::ctx (C++ member)
cam_stream_config::name (C++ member)
cam_stream_config::uuid_str (C++ member)
cam_stream_ctx_t (C++ type)
cam_stream_end (C++ function)
cam_stream_event (C++ function)
cam_stream_init (C++ function)
CAM_STREAM_NAME_LEN (C macro)
cam_stream_start (C++ function)
cam_stream_stop (C++ function)
CAM_SUCCESS (C macro)
cam_version (C++ function)
CAM_VERSION_MAJOR (C macro)
CAM_VERSION_MINOR (C macro)