README.md

XEngine

网络开发包,网络通信引擎,网络通信中间件,网络通信开发框架

当前版本

V8.19.0.1001

注意

你应该先阅读README.md(English:README.en.md) .如果可以,请阅读XEngine_Docment/开发人员必读.docx
建议使用宋体,阅读更新历史
更多内容,请访问我们的网站:www.xyry.org

项目介绍

XEngine是基于C/C++开发的一套跨平台(支持Windows,Linux,Mac,Android,IOS)稳定可靠的开发框架,他提供了42个模块(SO,DLL,DYLIB)和上千个API函数供你调用,你可以在这套框架上面快速的开发部署你的网络应用程序环境。此引擎不光封装了高性能API函数，还封装了底层网络IO和网络应用与协议相关接口，你可以使用此SDK快速部署与开发大型或者中小型应用服务器以及其他与网络和通信相关的应用程序。他是关于网络通信和后台服务器相关的一整套开发套件,他提供了整个后台服务生命周期的开发库.他为你解决了从网络IO层到应用层的一系列复杂的问题,包括性能问题。
此引擎你可以把他当成一个小型的C接口的BOOST库,只是他更偏向网络通信,后台服务,流媒体协议,音视频编解码,你可以使用这套SDK提供的API,开发你想要的任何网络与通信程序或服务,包括不限于:聊天服务,视频会议,语音会议,文件服务,远程监控,日志服务,HTTP服务,代理服务,数据转发服务,消息服务,安全验证,流媒体服务,音视频编解码,P2P等等相关工具和服务的开发
XEngine拥有一整套完整的线程池模型(从网络IO到业务处理),而不是市面上的伪线程池模型,也不需要莫名其妙的协程,你可以真正实现一套高性服务器

软件目标

学会这套开发通信引擎后,在你以后工作学习中,你会发现开发网络通信相关的应用程序非常轻松愉快.它几乎包含了所有网络通信相关的API函数封装.
此开发包统一使用了C接口方式的导出,模块间函数可以独立使用,也可以全部使用.你可以根据自己需要选择使用的模块.
你甚至可以用我们这套SDK不调用任何系统API就可以开发一套大型的服务器
现在,开始学习这套引擎吧...

部署环境

我们建议你使用git工具下载和更新(windows可以使用TortoiseGit),仅限英文路径,推荐github
git clone https://gitee.com/xyry/libxengine.git
git clone https://github.com/libxengine/xengine.git

Windows

下载完毕后,你可以直接运行主目录下的XEngine_WINEnv.bat文件
执行成功后会在你的系统中添加此目录的用户环境变量
以Visual Studio为例,在你的项目->属性->VC++目录->包含目录添加$(XEngine_Include)头文件环境
x86添加:$(XEngine_Lib32)lib的库目录环境
x64添加:$(XEngine_Lib64)lib的库目录环境

如何使用

WINDOWS下使用我们的库的时候,你需要在你应用程序初始化的时候手动启用WSAStartup(MAKEWORD(2,2),&st_WSAData); 应用程序销毁的时候启用WSAClean() 这个函数才能使用我们的网络库
连接到库,比如基础库:#pragma comment(lib,"XEngine_BaseLib/XEngine_BaseLib")

运行时库

我们发布的软件都使用的是MD编译.需要VS2022的运行时库
大多数时候系统中已经安装运行库了,如果没有，那么我们建议你安装。
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

更新引擎

直接使用git拉取,git pull 即可.

Linux

只支持BIT64位系统。我们提供了环境运行安装脚本，如果在你的系统中运行，安装脚本是基于RockyLinux 9_x64和Ubuntu22.04_x64 位编写。我们的软件支持RedHat,Centos,RockyLinux,Ubuntu和Debian，如果你不是使用的这些系统，那么你需要自己查看我们的依赖库并且安装，只要是64位即可。你可以通过安装脚本 -h 参数查看安装方法.注意:UBUNTU(DEBIAN)和Rocklinux(REDHAT)核心是分开的,无法同时兼容.

如何使用

打开终端
cd libxengine
chmod 777 *
sudo ./XEngine_LINEnv.sh -i 3
此脚本可以单独运行
我们推荐你执行两次环境配置脚本用于检查环境安装是否成功
连接到库,比如基础库:-L ../../../XEngine/XEngine_Release/XEngine_Linux/Ubuntu/XEngine_BaseLib -lXEngine_BaseLib

更新引擎

终端使用git更新:git pull
成功后执行命令:sudo ./XEngine_LINEnv.sh -b -i 3

MacOS

MacOS需要13以及以上的系统,只支持64位系统,安装方式同LINUX,你可以通过安装脚本 -h 参数查看安装方法
在执行此脚本前,请确保你电脑安装了xcode,如果没有,请在终端执行:xcode-select --install
配置brew环境的时候需要你手动输入密码和回车确认信息
我们推荐你执行两次环境配置脚本用于检查环境安装是否成功

如何使用

打开终端,执行./XEngine_LINEnv.sh 如果已经安装过只是升级可以使用 ./XEngine_LINEnv.sh -b -i 3
MacOS链接库(dylib)可以直接放到和程序一样的目录下运行,而不是放到系统目录.具体可以根据你的使用方式决定
此脚本可以单独运行

更新引擎

终端使用git更新:git pull
成功后执行命令:./XEngine_LINEnv.sh -b -i 3

Android

只能通过拷贝SO自己配置环境,拷贝依赖的模块到你的程序中
支持ANDROID10以及以上系统,ARM64位

IOS(IPHONE)

由于系统限制,你只能拷贝依赖的共享库到你的程序目录下放到一起.
支持IOS13以及以上系统,需要ARM64位的架构

使用说明

加载头文件:
#include <pch.h> //预编译,WINDOWS可能需要
#include <系统头文件.h>
using namespace 名词空间; //C++名词空间
#include <XEngine_CommHdr.h>
#include <XEngine_ProtocolHdr.h> //可能需要
#include <XEngine_Include/组件目录/模块名称_Define.h>
#include <XEngine_Include/组件目录/模块名称_Error.h>
#include <你的头文件>
如果遇到某些宏定义重复,请注意你的宏定义加载是否正常或者你的头文件是否加载正确,或者你可以删除我们的重复的宏定义.

目录结构

*libxengine SDK发布文件夹

XEngine_Android Android发布版本文件夹,包括so等
XEngine_IOS IOS发布版本文件夹
XEngine_Mac MacOS系统模块发布文件夹
XEngine_Windows WINDOWS发布版本文件夹,包括lib.dll等
- --x64 64位DLL发布文件夹
  * --XEngine_* 组件目录包含组件拥有的dll和lib
- --x86 32位DLL发布文件夹
  * 同64位
XEngine_Linux LINUX系统模块发布文件夹
- --Centos Centos系统专用发布文件夹
  * --XEngine_* 组件模块发布目录
- --Ubuntu Ubuntu系统专用发布文件夹
  * 同Centos位
XEngine_Include 头文件目录
- --XEngine_CommHdr.h 公用头文件
- --XEngine_ProtocolHdr.h 协议头文件
- --XEngine_Types.h 非WINDOWS系统平台的函数转换头文件
- --XEngine_* 组件头文件目录
XEngine_Docment 文档目录
- --SDK服务协议.docx 协议文档
- --开发人员必读.docx 系统说明文档
- --开发文档.docx 开发组必读,开发规范
- --结构图
XEngine_Configure 配置文件所在文件夹,用于HTTP,SIP等的配置
XEngine_LibPath.conf Linux模块配置文件
CONTRIBUTING.md 贡献名单
README.en.md 英文必读说明
README.md 中文必读
XEngine_LINEnv.sh Linux和MacOS的XEngine安装配置脚本
XEngine_WINEnv.bat Windows环境XEngine安装配置脚本
XEngine_APIDoc.chm API文档
CHANGELOG 最新版本更新说明
COPYRIGHT 第三方版权说明
HOSTORY 以往更新历史
LICENSE XEngine版权说明

学习计划

想要使用这套框架,完整的学习到上手可能需要一周时间.
你可以通过文档了解基础结构,通过查找头文件与全局搜索注释找到想要的功能

学习方式

如果想要做网络服务通信开发,你需要了解XEngine_Core组件的XEngine_Core模块以及XEngine_Client组件的XClient_Socket模块
你还可以查看XEngine_HelpComponents组件的HelpComponents_Packets了解如何处理网络包
更高级的使用可以结合XEngine_HelpComponents组件下的HelpComponents_XLog日志模块与HelpComponents_Database数据库模块使用
当你熟悉这套框架,你可以使用XEngine_StreamMedia组件开发流媒体或者XEngine_AVCoder开发音视频编解码功能
你还可以使用XEngine_RfcComponents组件开发一些常用的协议服务,比如HTTP,WEBSOCKET,SIP等等...