Skip to content

Commit bad881c

Browse files
committed
update:readme and docment
1 parent b1366f4 commit bad881c

File tree

6 files changed

+45
-9
lines changed

6 files changed

+45
-9
lines changed

CHANGELOG

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
XEngine_MQService V3.11.0.1001
2+
3+
增加:MQTT协议服务支持
4+
增加:信息报告支持
5+
修改:jsoncpp模块使用git的子模块替换
6+
修改:分离了版本列表从主配置中
7+
修改:增加了日志的路径配置
8+
修改:信号量有提示了
9+
修改:保存时间配置移动到db配置
10+
修正:日志配置没有效果的问题
11+
修正:关闭客户端处理不正确
12+
修正:绑定消息日志提示不正确
13+
14+
added:mqtt protocol service supported
15+
added:info report supported
16+
modify:jsoncpp module use git submodule instead
17+
modify:detach version list from main configure
18+
modify:added file path of log configure
19+
modify:signal have tips
20+
modify:save time configure move to db configure
21+
fixed:log configure is not work
22+
fixed:close client is incorrect
23+
fixed:bind log print is incorrect
24+
======================================================================================
125
XEngine_MQService V3.10.0.1001
226

327
增加:消息属性增加无限制消息获取

README.en.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ c c++Message Queue Service
1010
#### Software Architecture
1111
the software developed based on xengine,using c/c++ development
1212
the software is a simple and high performance server,Allow users to use it directly without secondary development
13-
the software mainly provides a message queue and dds engine,support http,WEBSOCKET and private protocol api server
13+
the software mainly provides a message queue and dds engine,support http,WEBSOCKET,MQTT and private protocol api server
1414

1515
## Software features
1616
this software support following features
@@ -24,7 +24,7 @@ this software support following features
2424
8. message get time
2525
9. message subcribe
2626
10. support Permission Validation
27-
11. support multi protocol(TCP,WEBSOCKET)
27+
11. support multi protocol(TCP,WEBSOCKET,MQTT)
2828
12. Active delivery acquisition mode or passive subscription notification module
2929
13. get order and start serial pos setting
3030
14. Unlimited load message types
@@ -37,7 +37,7 @@ this software support following features
3737
## install
3838

3939
#### XEngine Evn
40-
you must install XEngine,need V8.15 or above,install XEngine can be refer to xengine Readme docment
40+
you must install XEngine,need V8.31 or above,install XEngine can be refer to xengine Readme docment
4141
GITEE:https://gitee.com/xyry/libxengine
4242
GITHUB:https://github.com/libxengine/xengine
4343

@@ -47,6 +47,15 @@ window Exection XEngine_WINEnv.bat
4747
Linux Exection:sudo ./XEngine_LINEnv.sh -i 3
4848
Macos Exection:./XEngine_LINEnv.sh -i 3
4949

50+
##### Depends on environment
51+
Requires MYSQL service support, execute XEngine_SQLFile/CreateDatabase.sql to create database
52+
Execute XEngine_SQLFile/XEngine_MQData.sql and XEngine_SQLFile/XEngine_MQUser.sql to create the table
53+
54+
#### sub module
55+
Due to the dependent sub-modules, after you checkout the warehouse, execute the following command in the warehouse directory to pull the sub-modules
56+
git submodule init
57+
git submodule update
58+
5059
#### Windows
5160
use vs open and complie,support windows 7sp1 and above
5261
Just Run it.
@@ -71,7 +80,6 @@ same linux
7180
## Installation Instructions
7281
#### Install
7382
Modify the configuration file to what you need, and then run the service directly
74-
need to mysql service support,create database through CreateDatabase.sql,import XEngine_SQLFile/XEngine_MQData.sql and XEngine_SQLFile/XEngine_MQUser.sql to create table.
7583

7684
#### upgrade
7785
If it is an upgrade installation, after downloading the new version and modifying the configuration file, it can be run directly

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ c c++Message Service
1010
## 软件架构
1111
此软件基于XEngine开发.采用C/C++作为开发语言
1212
此软件是一款简易的高性能服务,统一的API接口,让用户几乎不需要二次开发就可以直接使用
13-
此软件主要是提供了消息队列与消息分发引擎,可用于用户消息操作的一个API服务器.支持HTTP,WEBSOCKET和私有协议.
13+
此软件主要是提供了消息队列与消息分发引擎,可用于用户消息操作的一个API服务器.支持HTTP,WEBSOCKET,MQTT和私有协议.
1414
## 软件特性
1515
此软件支持以下特性
1616
1. 消息序列
@@ -23,7 +23,7 @@ c c++Message Service
2323
8. 消息次数
2424
9. 消息订阅
2525
10. 支持权限验证
26-
11. 支持多种协议(TCP,WEBSOCKET)
26+
11. 支持多种协议(TCP,WEBSOCKET,MQTT)
2727
12. 主动投递获取模式或者被动订阅通知模块
2828
13. 获取顺序与开始序列号设置
2929
14. 不限制负载的消息类型
@@ -36,7 +36,7 @@ c c++Message Service
3636
## 安装教程
3737

3838
#### XEngine环境
39-
必须安装XEngine,版本需要V8.15或者以上版本,安装XEngine可以参考其Readme文档
39+
必须安装XEngine,版本需要V8.31或者以上版本,安装XEngine可以参考其Readme文档
4040
GITEE:https://gitee.com/xyry/libxengine
4141
GITHUB:https://github.com/libxengine/xengine
4242

@@ -50,6 +50,11 @@ macos执行:./XEngine_LINEnv.sh -i 3
5050
需要MYSQL服务的支持,执行XEngine_SQLFile/CreateDatabase.sql 创建数据库
5151
分别执行:执行XEngine_SQLFile/XEngine_MQData.sql 和 执行XEngine_SQLFile/XEngine_MQUser.sql 创建表
5252

53+
#### sub module
54+
由于依赖的子模块,在你checkout仓库后,在仓库目录下执行下面的命令拉取子模块
55+
git submodule init
56+
git submodule update
57+
5358
#### Windows
5459
使用VS打开并且编译,支持WINDOWS 7SP1以上系统
5560
直接运行即可
@@ -77,7 +82,6 @@ make FLAGS=CleanAll 清理编译
7782
## 安装指导
7883
#### 安装
7984
修改配置文件为你需要的,然后直接运行服务即可
80-
需要MYSQL服务,使用CreateDatabase.sql创建数据库,然后导入执行XEngine_SQLFile/XEngine_MQData.sql 和 执行XEngine_SQLFile/XEngine_MQUser.sql 创建表
8185

8286
#### 升级
8387
如果是升级安装,下载新版本后修改配置文件就可以直接运行了

XEngine_Docment/Docment_en.docx

1.75 KB
Binary file not shown.

XEngine_Docment/Docment_zh.docx

2.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)