1 Star 0 Fork 648

dalarang / RRQMSocket

forked from 若汝棋茗 / TouchSocket 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

图片名称

合抱之木,生于毫末;九层之台,起于垒土。

图片名称

💿描述

名称 地址 描述
NuGet version (RRQMSocket) Gitee
Github
RRQMSocket是一个整合性的、超轻量级的网络通信框架。
包含了TCP、UDP、Ssl、Channel、Protocol、Token、
租户模式等一系列的通信模块。其扩展组件包含:WebSocket、
大文件传输、RPC、WebApi、XmlRpc、JsonRpc等内容
NuGet version Gitee
Github
RRQMSocketFramework是RRQMSocket系列的增强企业版,
两者在基础功能上没有区别,但是在扩展功能上有一定差异性,
例如RPC中的EventBus、文件传输中的限速功能等,
具体差异请看RRQM商业运营

🎀依赖、扩展库

名称 地址 描述
NuGet version (RRQMCore) Gitee
Github
RRQMCore是为RRQM系提供基础服务功能的库,其中包含:
内存池对象池等待逻辑池AppMessenger3DES加密
Xml快速存储运行时间测量器文件快捷操作
高性能序列化器规范日志接口等。
NuGet version (RRQMSocket.WebSocket) Gitee
Github
RRQMSocket.WebSocket是一个高效,超轻量级的WebSocket框架。
它包含了Service和Client两大组件,支持Ssl,同时定义了文本、二进制或
其他类型数据的快捷发送、分片发送接口,可与js等任意WebSocket组件交互
NuGet version (RRQMSocket.Http) Gitee
Github
RRQMSocket.Http是一个能够简单解析Http的服务组件,
能够快速响应Http服务请求。
NuGet version (RRQMSocket.RPC) Gitee
Github
RPC是一个超轻量、高性能、可扩展的微服务管理平台框架,
目前已完成开发RRQMRPCXmlRpcJsonRpcWebApi部分。
RRQMRPC部分使用RRQM专属协议,支持客户端异步调用
服务端异步触发、以及outref关键字,函数回调等。
在调用效率上也是非常强悍,在调用空载函数,且返回状态时,
10w次调用仅用时3.8秒,不返回状态用时0.9秒。
其他协议调用性能详看性能评测。
NuGet version (RRQMSocket.RPC.XmlRpc) Gitee
Github
XmlRpc是一个扩展于RRQMSocket.RPC的XmlRpc组件,可以通过
该组件创建XmlRpc服务解析器,完美支持XmlRpc数据类型,类型嵌套,
Array等,也能与CookComputing.XmlRpcV2完美对接。
不限Web,Android等平台。
NuGet version (RRQMSocket.RPC.JsonRpc) Gitee
Github
JsonRpc是一个扩展于RRQMSocket.RPC的JsonRpc组件,
可以通过该组件创建JsonRpc服务解析器,支持JsonRpc全部功能,可与Web,Android等平台无缝对接。
NuGet version (RRQMSocket.RPC.WebApi) Gitee
Github
WebApi是一个扩展于RRQMSocket.RPC的WebApi组件,可以通过
该组件创建WebApi服务解析器,让桌面端、Web端、移动端可以
跨语言调用RPC函数。功能支持路由、Get传参、Post传参等。
NuGet version (RRQMSocket.FileTransfer) Gitee
Github
这是一个高性能的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是每次接收之前,从内存池拿一个可用内存块,然后直接用于接收,等收到数据以后,直接就把这个内存块抛出处理,这样就避免了复制操作,虽然只是细小的设计,但是在传输1000w64kb的数据时,性能相差了10倍

数据处理适配器

相信大家都使用过其他的Socket产品,例如HPSocket,SuperSocket等,那么RRQMSocket在设计时也是借鉴了其他产品的优秀设计理念,数据处理适配器就是其中之一,但和其他产品的设计不同的是,RRQMSocket的适配器功能更加强大,它不仅可以提前解析数据包,还可以解析数据对象。例如:可以使用固定包头对数据进行预处理,从而解决数据分包粘包的问题。也可以直接解析HTTP数据协议、WebSocket数据协议等。

兼容性与适配

RRQMSocket提供多种框架模型,能够完全兼容基于TCP、UDP协议的所有协议。例如:TcpService与TcpClient,其基础功能和Socket一模一样,只是增强了框架的坚固性并发性,将连接接收数据通过事件的形式抛出,让使用者能够更加友好的使用。

🔗联系作者

🌟API手册

✨简单示例

更多配置请查看API文档的配置说明文档,一下仅以最简方式创建实例。

【TcpService】

TcpService service = new TcpService();
service.Connecting += (client, e) =>{};//有客户端正在连接
service.Connected += (client, e) =>{};//有客户端连接
service.Disconnected += (client, e) =>{};//有客户端断开连接
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);
//启动
 service.Start();

【TcpClient】

SimpleTcpClient tcpClient = new SimpleTcpClient();
tcpClient.Connected += (client, e) =>{};//成功连接到服务器
tcpClient.Disconnected += (client, e) =>{};//从服务器断开连接,当连接不成功时不会触发。
//载入配置
tcpClient.Setup("127.0.0.1:7789");
tcpClient.Connect();
tcpClient.Send(Encoding.UTF8.GetBytes("RRQM"));

【TcpClient 断线重连】

tcpClient.UseReconnection(tryCount:5,printLog:true);

【FixedHeaderPackageAdapter包模式】

该适配器主要解决TCP粘分包问题,数据格式采用简单而高效的“包头+数据体”的模式,其中包头支持:

  • Byte模式(1+n),一次性最大接收255字节的数据。
  • Ushort模式(2+n),一次最大接收65535字节。
  • Int模式(4+n),一次最大接收2G数据。

以上数据头均采用RRQMBitConverter的默认端模式(小端模式),使用者可以根据需求切换默认端模式。

RRQMBitConverter.DefaultEndianType = EndianType.Little;

【CustomFixedHeaderDataHandlingAdapter】

用户自定义固定包头适配器,主要帮助用户解决具有固定包头的数据帧信息。例如:下列数据格式,仅需要实现几个接口,就能完成解析,详细操作请参照API。

|1|1|1|**********|

【CustomUnfixedHeaderDataHandlingAdapter】

用户自定义不固定包头适配器,主要帮助用户解决具有包头不固定的数据帧信息。例如:最典型的HTTP数据包,其数据头和数据体由“\r\n”隔开,而数据头又因为请求者的请求信息的不同,头部数据也不固定,而数据体的长度,也是由数据头的ContentLength的值显式指定的,所以可以考虑使用CustomUnfixedHeaderDataHandlingAdapter解析,也是仅通过简单的开发,就能实现。

【Ssl加密】

RRQMBox中,放置了一个自制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; }
};

【WS服务器】

WSService wSService = new WSService();
wSService.Received += WSService_Received;
wSService.Connected += WSService_Connected;

var config = new WSServiceConfig();
config.ListenIPHosts = new IPHost[] { new IPHost("127.0.0.1:7789"), new IPHost(7790) };//同时监听两个地址
config.ReceiveType = ReceiveType.IOCP;

wSService.Setup(config).Start();
Console.WriteLine("WS服务器已启动");

【WSs服务器】

创建WSs服务器时,其他配置不变,只需要在config中加入以下代码即可。

RRQMBox中,放置了一个自制Ssl证书,密码为“RRQMSocket”以供测试。使用配置非常方便。

//config.SslOption = new ServiceSslOption() { Certificate = new X509Certificate2("RRQMSocket.pfx", "RRQMSocket"), SslProtocols = SslProtocols.Tls12 };//Ssl配置,当为null的时候,相当于创建了ws服务器,当赋值的时候,相当于wss服务器。
config.ReceiveType = ReceiveType.Select;//在没有ssl配置时,请使用IOCP模式,速度会好些,使用ssl时,可以选择Select和BIO,区别请看API

【WS客户端】

SimpleWSClient client = new SimpleWSClient();
WSClientConfig config = new WSClientConfig();
config.RemoteIPHost = new IPHost("127.0.0.1:7789");
client .Setup(config);
client .Connect();
Console.WriteLine("连接成功");
while (true)
{
    client.Send(Console.ReadLine());
}

注意:当使用域名连接时,IPHost中的字符串必须显式指定端口,例如百度地址:IPHost("ws://baidu.com:80")

【WSs客户端】

同样的,在客户端配置中,只需要加入以下代码即可。

注意:当使用域名连接时,TargetHost为域名,例如连接到IPHost("ws://baidu.com:80")时,TargetHost应当填写:baidu.com

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; }
};
config.ReceiveType = ReceiveType.BIO;

【WS 接收数据(服务器、客户端均可用)】

private static void MyWSClient_Received(IWSClientBase client, WSDataFrame dataFrame)
{
    switch (dataFrame.Opcode)
    {
        case WSDataType.Cont:
            Console.WriteLine($"收到中间数据,长度为:{dataFrame.PayloadLength}");
            break;
        case WSDataType.Text:
            Console.WriteLine(dataFrame.GetMessage());
            break;
        case WSDataType.Binary:
            if (dataFrame.FIN)
            {
                Console.WriteLine($"收到二进制数据,长度为:{dataFrame.PayloadLength}");
            }
            else
            {
                Console.WriteLine($"收到未结束的二进制数据,长度为:{dataFrame.PayloadLength}");
            }
            break;
        case WSDataType.Close:
            break;
        case WSDataType.Ping:
            break;
        case WSDataType.Pong:
            break;
        default:
            break;
    }
}

🧲应用场景模拟

场景入口


致谢

谢谢大家对我的支持,如果还有其他问题,请加群QQ:234762506讨论。

Giteye chart

后续开发计划

  1. FTP功能开发

支持作者

支持入口

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

【RRQMSocket】RRQMSocket是一个整合性的、超轻量级的网络通信框架。包含了TCP、UDP、Ssl、Channel、Protocol、Token、租户模式等一系列的通信模块。其扩展组件包含:WebSocket、大文件传输、RPC、WebApi、XmlRpc、JsonRpc等内容 展开 收起
C#
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C#
1
https://gitee.com/dalarang/RRQMSocket.git
git@gitee.com:dalarang/RRQMSocket.git
dalarang
RRQMSocket
RRQMSocket
master

搜索帮助