AREG (Automated Real-time Event Grid) Framework is a cutting-edge interface-centric solution designed to facilitate real-time asynchronous communication in distributed and mist-computing environments. The communication engine powering the AREG Software Development Kit (SDK) supports Inter-Process Communication (IPC), it is built upon the Object Remote Procedure Call (Object RPC) protocol, helping developers create scalable, multitasking applications across multiple platforms. At the heart of the AREG SDK lies the AREG Framework written in C++, which comprises various software components and tools to simplify the development of distributed, real-time, and asynchronous applications. This framework enables connected Things to interact and offer services, functioning like lightweight distributed micro-servers.
These pages serve as comprehensive resources, providing detailed descriptions of the AREG SDK framework, along with practical examples and a range of accompanying tools.
The following sections guide you through installing, configuring, and using the AREG SDK, with links to more detailed documentation.
-
Installation and Setup
- Installing and Using AREG SDK with vcpkg Package Manager: Guide to installing the AREG SDK with the
vcpkgpackage manager. - Building AREG SDK with CMake: Instructions for building the AREG SDK using CMake.
- Building the AREG SDK with Microsoft Visual Studio and MSBuild: Steps to set up and build the AREG SDK in Visual Studio.
- Building AREG SDK on Windows Subsystem for Linux (WSL): Building the AREG SDK on WSL for a Linux environment within Windows.
- Installing and Using AREG SDK with vcpkg Package Manager: Guide to installing the AREG SDK with the
-
Configuration and Build Options
- CMake Configuration Options for Building AREG SDK: Overview of CMake options for building and customizing AREG SDK.
- AREG SDK CMake Functions and Macros: Details on CMake functions and macros provided by AREG SDK.
- Integrating AREG Framework with CMake: Steps to integrate AREG SDK in your CMake projects.
- Integrating AREG Framework with Microsoft Visual Studio: How to link and use AREG SDK within Visual Studio projects.
- AREG SDK Preprocessor Definitions Guide: Configuration and Usage Across Toolchains: Comprehensive guide to configuring preprocessor definitions for the AREG SDK across different development environments and toolchains.
-
Development Tools
- AREG SDK Code Generator (
codegen.jar): Guide for using AREG SDK's code generator to create service interfaces and streamline development.
- AREG SDK Code Generator (
-
Logging and Monitoring
- AREG SDK Logging Configuration Guide: Setting up and configuring logging within AREG SDK applications.
- Developing with AREG Logging System: Instructions for integrating logging into your applications.
- AREG SDK Log Observer Application: A guide to observing logs in real time.
- AREG SDK Log Collector Service: Configuration and use of AREG SDK's log collector for centralized log management.
-
Networking and Communication
- AREG SDK Multicast Router: Information on setting up multicast communication for distributed applications.
-
Data Management
- Key-Value Data Persistence Syntax in AREG SDK: Persistent data storage and management using AREG SDK's key-value storage options.
-
Troubleshootings
- Troubleshooting WSL Updates: Provides solutions for common issues encountered while updating the WSL.
- Troubleshooting CMake Builds on Linux: Provides solutions for common errors encountered during the CMake compilation process on Linux.
- Integration Troubleshooting: Provides solutions for common errors encountered during integration of AREG SDK sources or binaries in the projects.
-
Examples and Tests
- Building and Running Examples and Tests: Instructions to exclude, build and run Examples and Unit Tests of AREG SDK.
Help us to make docs greater.
See something is wrong, unclear or need a help?
Submit a change, open a discussion or ask AREG SDK community a question.
2023-2024 © Aregtech, www.aregtech.com, email: info[at]aregtech.com