README.en.md · libxengine/libxengine

[中文](README.md) ||  [English](README.en.md)
# XEngine
Network and Media Development Kit, Communication Engine and Middleware, Network Communication Development Framework, Streaming Media Development Framework, Audio and Video Development Framework

## Now Version is
V9.2.0.1001RC
  
## Note  
You should read README.md(English:README.en.md) first. If you can, please read XEngine_Docment/开发人员必读.docx  
For more content,please visit our website: www.xyry.org
  
## Description
XEngine is a stable and reliable development framework based on C/C++, designed to be cross-platform (supporting Windows, Linux, Mac, Android, and iOS). It offers 47 modules (SO, DLL, DYLIB) and thousands of API functions for you to utilize. With this framework, you can rapidly develop and deploy your network application environment. This engine provides high-performance interfaces for low-level network I/O and network application-related protocols. You can use this framework to quickly deploy and develop large or small-scale application servers as well as other network and protocol-related applications. It encompasses a comprehensive set of development frameworks concerning network protocols, streaming media, audio-video, and servers, providing development libraries for the entire service lifecycle. It addresses a series of complex issues from network I/O to the application layer, including performance concerns  
This engine can be viewed as a small-scale BOOST library with a C interface, but it leans more towards network communication, backend services, general network protocols, streaming media protocols, audio-video encoding/decoding. You can utilize the APIs provided by this framework to develop any network and communication programs or services you desire, including but not limited to: chat services, video conferencing, voice conferencing, file services, remote monitoring, logging services, HTTP services, proxy services, data forwarding services, messaging services, security authentication, streaming media services, audio-video encoding/decoding, P2P, and other related tools and services  
XEngine has a complete set of thread pool models (from network IO to business processing), instead of the pseudo-thread pool model on the market, and there is no need for inexplicable coroutines, you can really implement a set of high-performance servers
  
## Software goals
After learning this set of development communication engine, in your future work and study, you will find that the development of network communication-related applications is very easy and happy, and there will be no troubles.You can accomplish in one week what others may take 1-3 months to complete.  
This development kit uses the export of C interface, and the functions between modules can be used independently or all. You can choose the module to use according to your needs.  
Now, let's start learning this engine...
#### learn to
If you want to use this framework, it may take a week to fully learn to get started.  
You can understand the infrastructure through the documentation, you can find Function by search header file or comments
  
#### learning method
If you want to do network service communication development, you need to understand the XEngine_Core module of the XEngine_Core component and the XClient_Socket module of the XEngine_Client component  
You can also look at HelpComponents_Packets of the XEngine_HelpComponents component to see how network packets are handled  
More advanced use can be combined with the HelpComponents_XLog log module under the XEngine_HelpComponents component and the HelpComponents_Database database module  
When you are familiar with this framework, you can use the XEngine_StreamMedia component to develop streaming media or XEngine_AVCodec to develop audio and video codec functions  
You can also use the XEngine_RfcComponents component to develop some common protocol services, such as HTTP, WEBSOCKET, SIP, etc...
#### Learn tutorials
You can also watch the video tutorials we provide to learn more about how to use each component module:https://www.xyry.org/Learn.docx
  
## Deployment environment
We recommend you to use git tool download and update(windows can use TortoiseGit),only english path  
Note: More available system versions will only be released on github. It is recommended to use github  
git clone https://gitee.com/libxengine/libxengine.git  
git clone https://github.com/libxengine/libxengine.git
  
#### Windows
After the download is complete, you can directly run the XEngine_WINEnv.bat file in the home directory  
Note: The git version defaults to 64bit. If you need 32BIT, you need to download it from the github release page and put it in another directory to run the XEngine_WINEnv32 script file  
After the execution is successful, the user environment variable of this directory will be added to your system  
Take Visual Studio as an example, add in your project->properties->VC++ directory  
include directory $(XEngine_Include) header file environment  
add $(XEngine_Lib32) to the library directory for x86 arch  
add $(XEngine_Lib64) for x64 arch  
###### how to use
When using our library under WINDOWS, you need to enable WSAStartup(MAKEWORD(2,2),&st_WSAData) when you program start and use WSAClean() when your program destory to use our network library  
link to the library,sush as base library:#pragma comment(lib,"XEngine_BaseLib/XEngine_BaseLib")  
###### Runtime library
The software we release is compiled using MD. The runtime library of VS2022 is required  
Most of the time, the runtime library is already installed on the system, if not, then we recommend that you install it  
x86(VS2015-VS2022):https://aka.ms/vs/17/release/vc_redist.x86.exe  
X64(VS2015-VS2022):https://aka.ms/vs/17/release/vc_redist.x64.exe
###### UPDate
Use git to pull directly
  
#### Linux
Only supports BIT64 bit system. We provide an environment to run the installation script, the installation script is based on Ubuntu24.04. Our software supports Ubuntu and Debian. If you are not using these systems, then you need to check our dependent libraries and install them, you can view the installation method through the -h parameter of the installation script.  
Note: UBUNTU (DEBIAN) and RockyLinux (REDHAT) cores are separate, It is currently not compatible.
###### how to use
open terminal  
cd libxengine  
chmod 777 *  
sudo ./XEngine_LINEnv.sh -i 3  
the script can be run by self  
We recommend that you execute the environment configuration script twice to check whether the environment installation is successful  
link to the library,sush as base library:-lXEngine_BaseLib  
###### UPDate
terminate execution in the xengine dir:git pull  
Execute the command after success:sudo ./XEngine_LINEnv.sh -b -i 6 to clean,and sudo ./XEngine_LINEnv.sh -b -i 3 to install  
If there is a major update, it is recommended to clean up and run sudo . /XEngine_LINEnv.sh -i 3 to reprocess the environment.
#### MacOS
MacOS requires system 13 and above,install like to linux,you can view the installation method through the -h parameter of the installation script.  
please make sure xcode is installed in you system before execution this script.if not,please execution:xcode-select --install  
When configuring the brew environment, you need to manually enter the password and press Enter to confirm the information  
We recommend that you execute the environment configuration script twice to check whether the environment installation is successful
###### how to use
You can refer to LINUX for the installation and update methods, they are all the same  
the script can be run by self
  
#### Android
copy depend file into your project,ANDROID environment needs to be downloaded from the GITHUB release page  
support ANDROID system 10 and above,ARM64
  
#### IOS(IPHONE)
Due to system limitations, you can only copy the dependent shared libraries to your program directory and put them together,IOS environment needs to be downloaded from the GITHUB release page  
Support IOS15 and above systems, ARM64-bit architecture is required

## System Version
load header file:  
#include <pch.h> //Precompiled, Windows may require  
#include <system  header.h>  
using namespace *;                //C++ NAME SPACE  
#include <XEngine_CommHdr.h>  
#include <XEngine_ProtocolHdr.h> //maybe need  
#include <XEngine_Include/components_dir/moduename_Define.h>  
#include <XEngine_Include/components_dir/moduename_Error.h>  
#include <your  header  file>
  
## Directory Structure
  
*libxengine            SDK Release dir
* XEngine_Android          Android Release version folder
* XEngine_IOS              IOS Release version folder
* XEngine_Mac              MacOS System Release version folder
* XEngine_Windows          WINDOWS Release version folder(x86_64)
* XEngine_Linux           LINUX release version folder(UBuntu24.04)
* XEngine_Include         Header Folder
 * --XEngine_CommHdr.h      Public header file
 * --XEngine_ProtocolHdr.h  protocol header
 * --XEngine_Types.h        Function conversion header files for non-WINDOWS system platforms
 * --XEngine_*              Components Header
 * XEngine_Docment        Docment Dir
 * --SDK服务协议.docx        Protocol Docment
 * --开发人员必读.docx       Xengine docment
 * --开发文档.docx           develop docment
 * --结构图
* XEngine_Configure        Configure file Dir,for http and sip configure
* CONTRIBUTING.md          CONTRIBUTING List
* XEngine_LINEnv.sh        Linux And MacOS Env XEngine Install Configure Script
* XEngine_WINEnv64.bat     Windows Env 64BIT XEngine Install Configure Script
* XEngine_WINEnv32.bat     Windows Env 32BIT XEngine Install Configure Script
* XEngine_APIDoc.chm       API Docment
* README.en.md             english readme
* README.md                chinese readme
* CHANGELOG                Latest version update instructions
* COPYRIGHT                Third-party library copyright notice
* HOSTORY                  update history
* LICENSE                  XEngine copyright notice
  
## Follow us
If you think this software is helpful to you, please give us a START  
and wechat qr scan to follow us  
![qrcode](https://www.xyry.org/qrcode.jpg)

### component struct
* Codec component: used for audio and video codec development and filter, transcoding and other operations
* Basic components: including basic time, string, algorithm, file, event, handle and other operations
* Client Components: Contains regular TCP and UDP client development, as well as other advanced client development SDKs
* Core components: including various high-performance network services, high-performance thread pools and network-related basic protocol development, etc.
* Helping components: including protocol group unpacking, binary group unpacking, decompression, database related SDK development
* Network components: SDKs for network-related protocols and tools development
* Standard Components: Modules developed for protocols introduced by the RFC standards organization.
* Streaming Media Components: Interface modules for client-server protocol-related development of streaming media protocols
* System components: SDK development components related to the system platform

## Contribution Guidelines
Repository: https://github.com/libxengine/xengine  
License Information: https://www.xyry.org/auth.html  
If you are contributing code, please fork the repository and write your code in your own fork. Once completed, submit a PR to the develop branch of our repository.  
You must strictly follow the coding standards outlined in the Development Document.docx when writing your code.refer<环境配置.docx>to configure your develop env  
If you only need to compile and use the code, please switch to the master branch in our repository, as the develop branch is for development purposes and is not intended for regular use.

## Software Architecture
![软件架构图](https://www.xyry.org/XEngine_StructPic/EngineFrameWork.png  "软件架构图")
![引擎模块图](https://www.xyry.org/XEngine_StructPic/EngineRelation.png  "引擎模块图")
  
### components struct picture
![音视频编解码组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_AVCodec.png  "音视频编解码组件结构图")
![基础组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_BaseLib.png  "基础组件结构图")
![客户端组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_Client.png  "客户端组件结构图")
![核心组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_Core.png  "核心组件结构图")
![帮助组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_HelpComponents.png  "帮助组件结构图")
![网络组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_NetHelp.png  "网络组件结构图")
![标准组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_RfcComponents.png  "标准组件结构图")
![流媒体组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_StreamMedia.png  "流媒体组件结构图")
![系统组件结构图](https://www.xyry.org/XEngine_StructPic/XEngine_SystemSdk.png  "系统组件结构图")

libxengine/libxengine

简介

发行版

贡献者

近期动态

libxengine/libxengine .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

libxengine/libxengine