cpp-tbox: cpp-tbox是一个Linux C++,MIT开源许可的,基于 Reactor 模式的开发框架与组件库。它主要针对智能硬件、机器人、网络服务等开发领域。它提供了一套易于开发、稳定可靠的框架,有:通信库(TCP/UDP/串口)、HTTP、线程池、定时器池、协程、日志、命令终端、状态机、行为树等非常实用的开发组件,以及完备实用的主框架,能为广大开发者节省大量开发与调试时间。

Fetch the repository succeeded.

Scan WeChat QR to Pay

Cancel

Complete

richgiteeai

Watch

Unwatch Watching Releases Only Ignoring

1 Star 0 Fork 242

magic/cpp-tbox

forked from cpp-master/cpp-tbox

Code Issues 0 Pull Requests 0 Wiki Insights Pipelines

Service

Tencent Cloud Serverless

Create your Gitee Account

Explore and code with more than 14 million developers,Free private repositories !:)

Already have an account? Sign in

Clone or Download

Clone/Download

HTTPS SSH SVN SVN+SSH Download ZIP

Prompt

To download the code, please copy the following command and execute it in the terminal

To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.

git config --global user.name userName 
git config --global user.email userEmail

When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.

1 Generate RSA keys.

2 Obtain the content of the RSA public key and configure it in SSH Public Keys

To use SVN on Gitee, please visit the usage guide

When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # Private Token

New file Create Diagram file

New submodule

Upload file

Branches 16

Tags 28

contribute

Sync branch

Create Pull Request

known more

See difference Through Pull Request Sync

Sync branch

Through Pull Request Sync

A Pull Request will be created to the current
branch and will be merged in to complete the sync

海卫哥 feat(mqtt): 1.12.27, 修改example/mqtt/conn,使... 01b5177

1626 commits

.github/workflows

3rd-party

documents

examples

modules

tools

.gitignore

CMakeLists.txt

CONTRIBUTING.md

CONTRIBUTORS.md

Config.cmake.in

LICENSE

Makefile

README.md

README_CN.md

build_env.mk

config.mk

version.mk

README

MIT

[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![Language](https://img.shields.io/badge/language-c++11-red.svg)](https://en.cppreference.com/)
[![Platform](https://img.shields.io/badge/platform-linux-lightgrey.svg)](https://img.shields.io/badge/platform-linux-lightgrey.svg)

[[中文]](README_CN.md)

**C++ Treasure Box** is a service-oriented **development framework** and **component library** based on the Reactor model, aim at make C++ development easy.

# Application field

- **Intelligent hardware**, such as: robots (sweepers, commercial service robots), IPC, drones, vehicles, etc.;
- **Edge computing components**, such as: smart home gateway, IOT edge gateway, etc.;
- **Service**, such as: SOCK5, Middleware.

See projects:

- [cpp-socks5](https://github.com/cpp-main/cpp-socks5), learn how to use TCP and how to organize the project;
- [protocal-adapter](https://github.com/cpp-main/protocal-adapter), learn how to use TCP, UDP, MQTT, UART;
- [cpp-tbox-for-ros](https://github.com/cpp-main/cpp-tbox-for-ros), learn how to how to integrate into the ROS 2 development environment, and how to use `rclcpp`;

# Features

## 1. Based on the Reactor
See the Node.js Reactor pattern. 
The main thread handles non-blocking IO events in Reactor mode, and cooperates with ThreadPool to perform large calculations and blocking operations. 
![](documents/images/0001-tbox-loop.jpg) 
This mode avoids the annoyance of competing locking in multi-thread mode, and the program is stable and reliable.

## 2. Contains main framework, easy to use
All non-business-related work is handled using the built-in main framework. You don't need to care about such trivial things as how to output the log, how to parse the parameters, how to exit the program, and how to write the main function. The main frame is all handled for you. 
You only need to derive the `tbox::main::Module` class, fill in the business code, and then register to the framework. 
![](documents/images/0009-demo-app.png)

## 3. With Shell-like terminal
You can interact with the running service through telnet, make it print internal data, or perform specific actions. This greatly reduces the difficulty of debugging. 
![shell interaction](documents/images/0000-terminal-show.gif)

## 4. With completely log system
**1) There are three log sink: stdout + filelog + syslog**

- stdout,Output the log to the terminal via `std::cout`;
- syslog,Output logs to syslog via `syslog()`;
- filelog,Write the log to the specified directory, in the format: `<PRIFIX>.YYMMDD_HHMMSS.<PID>.log`. If the file size exceeds 1M, a new log file will be created. Due to the low efficiency of writing files, the output channel adopts the front-end and back-end modes.

One or more of the three sink can be selected in the startup parameters, and can also be changed through the terminal during operation.

**2) Different level different color** 
The log content includes: level, time (accurate to microseconds), thread number, module name, function name, text, file name, line number. 
It is convenient and quick to locate the problem. 
![log show](documents/images/0002-log-show.png) 
As shown in the figure above, different log levels are clearly distinguished by colors. In particular, for anomalies, red and yellow are used together with highlighting, making them very eye-catching.

**3) Flexible log output filter** 
The log level can be set separately for different modules when the program is running, as follows: 
![set log level](documents/images/0001-set-log-level.gif)

## 5. Flexible parameter system
Parameters are provided in JSON format, and any format of running parameters can be passed in, including: integers, decimals, strings, arrays, and combination parameters, meeting almost all parameter passing requirements: 
![paremeter help](documents/images/0005-arguments.png) 
You can use `-c your_cfg_file.json` to import a configuration file in JSON format at execution time. At the same time, you can also use `-s 'xx.yy.zz=vvv'` to specify parameters temporarily. 
The configuration file in JSON format also supports the include command to include other configuration files when loading.

## 6. Assign tasks across threads without locking
The child thread entrusts the main thread to execute: 
![runInLoop example](documents/images/0003-run-in-loop.png) 
The main thread entrusts the child thread to execute: 
![ThreadPool example](documents/images/0004-run-thread-pool.png)

## 7. Graceful exit process
When receiving signals: SIGINT, SIGTERM, SIGQUIT, SIGPWR, it will execute the exit process in an orderly manner and release resources. Do a clean exit. 
![graceful exit](documents/images/0002-exit-friendly.gif) 
This is crucial for ensuring program integrity and conducting memory analysis.

## 8. Comprehensive exception capture mechanism
When various program exceptions occur in the program, such as: segment fault, assertion, bus error, exception not caught, etc., the framework will capture and print the complete call stack in the log system. Facing program crashes, no longer look blank. The effect is as follows: 
![stack print](documents/images/0006-error-dump.png) 
With this mechanism in place, analyzing program crash issues of online devices becomes very simple, and there is basically no need to use gdb to analyze coredumps.

## 9. Visualized trace module
The trace module can record the time and duration of each execution of the marked function, and can export the icicle diagram for display: 
![icicle diagram](documents/images/0011-trace-view.png) 
It is a great tool for performance analysis and event blocking problem troubleshooting.

## 10. Simple and visualized state machine
It abandons the cumbersome inheritance and derivation of the traditional state mode, and uses it directly in a combined way, which is simple and convenient. It can also export the state machine diagram to achieve what you see is what you get: 
![visualized state machine](documents/images/0010-state-machine-graph.png)

## 11. Visualized behavior tree
It contains an event-driven behavior tree that can realize sequential, branching, and cyclic action processes in an asynchronous environment, and can export a visual tree diagram in real time: 
![visualized behavior tree](documents/images/0010-action-tree-graph.jpg)

## 12. Rich components

| Name | What |
|:----:|:----|
| base | Including log printing, common tools, etc. |
| util | Accessibility module |
| event | Realized IO, Timer, Signal three kinds of event-driven, which is the heart of the whole framework |
| eventx | Including ThreadPool thread pool, WorkThread worker thread, TimerPool timer pool and other modules |
| log | Realized efficient and reliable terminal, syslog, and log output in the form of files |
| trace | Realized outputting traces to files in real time |
| network | Realized serial port, terminal, UDP, TCP communication module |
| terminal | A shell-like command terminal that enables command interaction with programs during runtime |
| **main** | Realized a complete program startup process and framework, so that developers only need to care about business code |
| run | It's an ELF. It loads one or more lib\*.so file which specified by parameter `-l xxx`, then run Modules in side |
| mqtt | MQTT Client |
| coroutine | coroutine function |
| http | Implemented HTTP Server and Client modules on the basis of network |
| alarm | Realized 4 commonly used alarm clocks: CRON alarm clock, single alarm clock, weekly cycle alarm clock, weekday alarm clock |
| flow | Contains multi-level state machine and behavior tree to solve the problem of action flow in asynchronous mode |
| crypto | Implemented the commonly used AES and MD5 encryption and decryption calculations |
| dbus | Implemented the function of integrating dbus into event to process transactions in a non-blocking manner |

# Environment

- Linux series operating system;
- C++11 or above.

# Download & build

## Prepare
```
sudo apt update
sudo apt install build-essential
sudo apt install libgtest-dev libgmock-dev
sudo apt install libmosquitto-dev
sudo apt install libdbus-1-dev

git clone https://gitee.com/cpp-master/cpp-tbox.git
cd cpp-tbox
```

## Using GNU Make
```
make 3rd-party modules RELEASE=1
```
After completion, the header files and library files are in the .staging directory. 
Of course, you can also specify the generation path of header files and library files by specifying `STAGING_DIR`. 
like: 
```
make 3rd-party modules RELEASE=1 STAGING_DIR=$HOME/.tbox
```
After completion, the header files and library files are in the $HOME/.tbox path.

## Using CMake
```
cmake -B build
cmake --build build
cmake --install build
```
Customize the installation directory by specifying `CMAKE_INSTALL_PREFIX` (installed in /usr/local by default): 
```
cmake -B build -DCMAKE_INSTALL_PREFIX=$HOME/.tbox
```

# Tutorial
For details on how to use cpp-tbox to develop your own programs, see the tutorial: 
[cpp-tbox-tutorials](https://github.com/cpp-main/cpp-tbox-tutorials/blob/master/README.md)

For example to use `find_package`:
```
cmake_minimum_required(VERSION 3.10)
project(tbox-find_package)
find_package(tbox COMPONENTS base util alarm event eventx)
add_executable(demo main.cpp)
target_link_libraries(demo PRIVATE tbox::tbox_base tbox::tbox_util tbox::tbox_alarm tbox::tbox_event tbox::tbox_eventx)
```

# Dependencies

# Configure

Open the config.mk file, you don’t need to block the modules corresponding to `app_y += xxx`, but pay attention to the dependencies between modules.

# License

[MIT](LICENSE), Free for use.

# Feedback

- Issue: Any questions are welcome to communicate in issue
- WeChat: hevake\_lee (Note: cpp-tbox)
- QQ Group: 738084942 (cpp-tbox 技术交流)

# Encourage us

If this project makes your work easier and you leave work earlier, please give me more encouragement.
You can do these:

- Light up three combos for it: Star, Watch, Fork;
- Recommend to colleagues and partners around you, and recommend to your readers in technical forums;
- Join the above QQ group, add me on WeChat to enter the WeChat group;
- Positive feedback on issues and suggestions;
- Participate in the development of the project and contribute your strength;
- Let me know which projects it is used in;

MIT License .============. // M A K E / \ // C++ DEV / \ // E A S Y / \/ \ ++ ----------. \/\ . \\ \ \ /\ / \\ \ \ / \\ \ \ / -============' Copyright (c) 2018 Hevake Lee <hevake_lcj@126.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

误判申诉

此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。

如您确认内容无涉及不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。

取消

提交

About

cpp-tbox是一个Linux C++,MIT开源许可的,基于 Reactor 模式的开发框架与组件库。它主要针对智能硬件、机器人、网络服务等开发领域。它提供了一套易于开发、稳定可靠的框架,有:通信库(TCP/UDP/串口)、HTTP、线程池、定时器池、协程、日志、命令终端、状态机、行为树等非常实用的开发组件,以及完备实用的主框架,能为广大开发者节省大量开发与调试时间。

No labels

https://gitee.com/cpp-master/cpp-tbox

README

Use MIT

0 Stars

1 Watching

242 Forks

Cancel