# RRQMSocket
**Repository Path**: sunhacker/RRQMSocket
## Basic Information
- **Project Name**: RRQMSocket
- **Description**: 【RRQMSocket】RRQMSocket是一个整合性的、超轻量级的网络通信框架。包含了TCP、UDP、Ssl、Channel、Protocol、Token、租户模式等一系列的通信模块。其扩展组件包含:WebSocket、大文件传输、RPC、WebApi、XmlRpc、JsonRpc等内容
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/RRQM_Home
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 808
- **Created**: 2022-01-15
- **Last Updated**: 2022-06-14
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
[](https://www.nuget.org/packages/RRQMSocket/)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[](https://www.nuget.org/packages/RRQMSocket/)
[](https://gitee.com/dotnetchina/RRQMSocket/stargazers)
[](https://gitee.com/dotnetchina/RRQMSocket/members)
合抱之木,生于毫末;九层之台,起于垒土。
## 💿描述
| 名称|地址 |描述|
|---|---|---|
|[](https://www.nuget.org/packages/RRQMSocket/)|[Gitee](https://gitee.com/dotnetchina/RRQMSocket)
[Github](https://github.com/RRQM/RRQMSocket)| RRQMSocket是一个整合性的、超轻量级的网络通信框架。
包含了TCP、UDP、Ssl、Channel、Protocol、Token、
租户模式等一系列的通信模块。其扩展组件包含:WebSocket、
大文件传输、RPC、WebApi、XmlRpc、JsonRpc等内容|
|[](https://www.nuget.org/packages/RRQMSocketFramework/)|[Gitee](https://gitee.com/dotnetchina/RRQMSocket)
[Github](https://github.com/RRQM/RRQMSocket) |**RRQMSocketFramework**是RRQMSocket系列的增强企业版,
两者在基础功能上没有区别,但是在扩展功能上有一定差异性,
例如RPC中的EventBus、文件传输中的限速功能等,
具体差异请看[RRQM商业运营](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E5%95%86%E4%B8%9A%E8%BF%90%E8%90%A5)|
## 🎀依赖、扩展库
| 名称|地址 |描述|
|---|---|---|
| [](https://www.nuget.org/packages/RRQMCore)|[Gitee](https://gitee.com/dotnetchina/RRQMSocket)
[Github](https://github.com/RRQM/RRQMSocket) | RRQMCore是为RRQM系提供基础服务功能的库,其中包含:
**内存池**、**对象池**、**等待逻辑池**、**AppMessenger**、**3DES加密**、
**Xml快速存储**、**运行时间测量器**、**文件快捷操作**、
**高性能序列化器**、**规范日志接口**等。 |
| [](https://www.nuget.org/packages/rrqmsocket.websocket)|[Gitee](https://gitee.com/dotnetchina/RRQMSocket)
[Github](https://github.com/RRQM/RRQMSocket) | RRQMSocket.WebSocket是一个高效,超轻量级的WebSocket框架。
它包含了Service和Client两大组件,支持Ssl,同时定义了文本、二进制或
其他类型数据的快捷发送、分片发送接口,可与js等任意WebSocket组件交互|
| [](https://www.nuget.org/packages/rrqmsocket.http)|[Gitee](https://gitee.com/dotnetchina/RRQMSocket)
[Github](https://github.com/RRQM/RRQMSocket) | RRQMSocket.Http是一个能够简单解析Http的服务组件,
能够快速响应Http服务请求。|
|[](https://www.nuget.org/packages/rrqmsocket.rpc)|[Gitee](https://gitee.com/RRQM_Home/rrqmsocket.rpc)
[Github](https://github.com/RRQM/RRQMSocket.RPC) |RPC是一个超轻量、高性能、可扩展的微服务管理平台框架,
目前已完成开发**RRQMRPC**、**XmlRpc**、**JsonRpc**、**WebApi**部分。
**RRQMRPC**部分使用RRQM专属协议,支持客户端**异步调用**,
服务端**异步触发**、以及**out**和**ref**关键字,**函数回调**等。
在调用效率上也是非常强悍,在调用空载函数,且返回状态时,
**10w**次调用仅用时**3.8**秒,不返回状态用时**0.9**秒。
其他协议调用性能详看性能评测。
|[](https://www.nuget.org/packages/rrqmsocket.rpc.xmlrpc)|[Gitee](https://gitee.com/RRQM_Home/rrqmsocket.rpc)
[Github](https://github.com/RRQM/RRQMSocket.RPC) | XmlRpc是一个扩展于RRQMSocket.RPC的XmlRpc组件,可以通过
该组件创建XmlRpc服务解析器,完美支持XmlRpc数据类型,类型嵌套,
Array等,也能与CookComputing.XmlRpcV2完美对接。
不限Web,Android等平台。|
| [](https://www.nuget.org/packages/rrqmsocket.rpc.jsonrpc)|[Gitee](https://gitee.com/RRQM_Home/rrqmsocket.rpc)
[Github](https://github.com/RRQM/RRQMSocket.RPC) | JsonRpc是一个扩展于RRQMSocket.RPC的JsonRpc组件,
可以通过该组件创建JsonRpc服务解析器,支持JsonRpc全部功能,可与Web,Android等平台无缝对接。|
|[](https://www.nuget.org/packages/rrqmsocket.rpc.webapi)|[Gitee](https://gitee.com/RRQM_Home/rrqmsocket.rpc)
[Github](https://github.com/RRQM/RRQMSocket.RPC) | WebApi是一个扩展于RRQMSocket.RPC的WebApi组件,可以通过
该组件创建WebApi服务解析器,让桌面端、Web端、移动端可以
跨语言调用RPC函数。功能支持路由、Get传参、Post传参等。|
| [](https://www.nuget.org/packages/rrqmsocket.filetransfer)|[Gitee](https://gitee.com/RRQM_Home/rrqmsocket.filetransfer)
[Github](https://github.com/RRQM/RRQMSocket.FileTransfer) | 这是一个高性能的C/S架构的文件传输框架,您可以用它传输
**任意大小**的文件,它可以完美支持**上传下载混合式队列传输**、
**断点续传**、 **快速上传** 、**传输限速**、**获取文件信息**、**删除文件**等。
在实际测试中,它的传输速率可达1000Mb/s。 |
## 🖥支持环境
- .NET Framework4.5及以上。
- .NET Core3.1及以上。
- .NET Standard2.0及以上。
## 🥪支持框架
- WPF
- Winform
- Blazor
- Xamarin
- Mono
- Unity(在IL2cpp编译时,需要导入源码)
- 其他(即所有C#系)
## 🌴RRQMSocket特点速览
#### 传统IOCP和RRQMSocket
RRQMSocket的IOCP和传统也不一样,就以微软官方示例为例,使用MemoryBuffer开辟一块内存,均分,然后给每个会话分配一个区接收,等收到数据后,再**复制**源数据,然后把复制的数据进行处理。而RRQMSocket是每次接收之前,从内存池拿一个可用内存块,然后**直接用于接收**,等收到数据以后,直接就把这个内存块抛出处理,这样就避免了**复制操作**,虽然只是细小的设计,但是在传输**1000w**次**64kb**的数据时,性能相差了**10倍**。
#### 数据处理适配器
相信大家都使用过其他的Socket产品,例如HPSocket,SuperSocket等,那么RRQMSocket在设计时也是借鉴了其他产品的优秀设计理念,数据处理适配器就是其中之一,但和其他产品的设计不同的是,RRQMSocket的适配器功能更加强大,它不仅可以提前解析数据包,还可以解析数据对象。例如:可以使用固定包头对数据进行预处理,从而解决**数据分包**、**粘包**的问题。也可以直接解析**HTTP**数据协议、WebSocket数据协议等。
#### 兼容性与适配
RRQMSocket提供多种框架模型,能够完全兼容基于TCP、UDP协议的所有协议。例如:TcpService与TcpClient,其基础功能和Socket一模一样,只是增强了框架的**坚固性**和**并发性**,将**连接**和**接收数据**通过事件的形式抛出,让使用者能够更加友好的使用。
## 🔗联系作者
- [CSDN博客主页](https://blog.csdn.net/qq_40374647)
- [哔哩哔哩视频](https://space.bilibili.com/94253567)
- [源代码仓库主页](https://gitee.com/RRQM_Home)
- 交流QQ群:234762506
## 🌟API手册
- [ API首页 ](https://gitee.com/RRQM_Home/RRQMBox/wikis/API%E6%89%8B%E5%86%8C)
- [说明](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E8%AF%B4%E6%98%8E(%E4%BD%BF%E7%94%A8%E5%89%8D%E5%BF%85%E8%A6%81%E9%98%85%E8%AF%BB))
- [ 历史更新 ](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E5%8E%86%E5%8F%B2%E6%9B%B4%E6%96%B0)
- [ 商业运营 ](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E5%95%86%E4%B8%9A%E8%BF%90%E8%90%A5)
- [疑难解答](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E7%96%91%E9%9A%BE%E8%A7%A3%E7%AD%94)
## ✨简单示例
**_更多配置请查看API文档的配置说明文档,一下仅以最简方式创建实例。_**
【TcpService】
```
SimpleTcpService service = new SimpleTcpService();
service.Connected += (client, e) =>{//有客户端连接};
service.Disconnected += (client, e) =>{//有客户端断开连接};
service.Connecting += (client, e) =>{//e.IsPermitOperation = false;//是否允许连接};
service.Received += (client, byteBlock, obj) =>
{
//从客户端收到信息
string mes = Encoding.UTF8.GetString(byteBlock.Buffer, 0, byteBlock.Len);
Console.WriteLine($"已从{client.Name}接收到信息:{mes}");//Name即IP+Port
};
//声明配置
var config = new TcpServiceConfig();
config.ListenIPHosts = new IPHost[] { new IPHost("127.0.0.1:7789"), new IPHost(7790) };//同时监听两个地址
//载入配置
service.Setup(config);
//启动
try
{
service.Start();
Console.WriteLine("简单服务器启动成功");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
```
【TcpClient】
```
SimpleTcpClient tcpClient = new SimpleTcpClient();
tcpClient.Connected += (client, e) =>{//成功连接到服务器};
tcpClient.Disconnected += (client, e) =>{//从服务器断开连接,当连接不成功时不会触发。};
//载入配置
tcpClient.Setup("127.0.0.1:7789");
tcpClient.Connect();
tcpClient.Send(new byte[]{1,2,3});
```
【Ssl加密】
在[RRQMBox](https://gitee.com/RRQM_Home/RRQMBox/tree/master/Ssl%E8%AF%81%E4%B9%A6%E7%9B%B8%E5%85%B3)中,放置了一个自制Ssl证书,密码为“RRQMSocket”以供测试。使用配置非常方便。
在服务器中只需设置配置SslOption属性和接收模式(接收模式在Ssl模式下只支持BIO和Select)。
```
config.SslOption = new ServiceSslOption() { Certificate = new X509Certificate2("RRQMSocket.pfx", "RRQMSocket"), SslProtocols = SslProtocols.Tls12 };
config.ReceiveType = ReceiveType.Select;
```
客户端配置
```
config.ReceiveType = ReceiveType.BIO;
config.SslOption = new ClientSslOption()
{
ClientCertificates = new X509CertificateCollection() { new X509Certificate2("RRQMSocket.pfx", "RRQMSocket") },
SslProtocols = SslProtocols.Tls12,
TargetHost = "127.0.0.1",
CertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => { return true; }
};
```
## 🧲应用场景模拟
[场景入口](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E5%BA%94%E7%94%A8%E5%9C%BA%E6%99%AF%E6%A8%A1%E6%8B%9F)
***
## 致谢
谢谢大家对我的支持,如果还有其他问题,请加群QQ:234762506讨论。
[](https://giteye.net/chart/RJ9NH249)
## 后续开发计划
1. FTP功能开发
## 支持作者
[支持入口](https://gitee.com/RRQM_Home/RRQMBox/wikis/%E6%94%AF%E6%8C%81%E4%BD%9C%E8%80%85)