1 Star 0 Fork 668

Sam / RRQMSocket

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

一、程序集描述

Logo RRQMSocket

NuGet version (SAEA) License Download

说明

RRQMSocket程序集由作者若汝棋茗开发,所有版权归作者所有,程序集源代码在遵循Apache License 2.0的开源协议下,可供其他开发者二次开发及(商业)使用。

交流方式

版本更新历史


  更新时间:2021.03.02
  更新内容:
  ①TCP框架
  1.全面引入RRQMCore中的优质内容,例如内存池,等待数据回传,消息通知等。
  2.TCP传出数据由Byte替换为ByteBlock,具有和流一样的操作。
  3.TcpService采用泛型,避免拆装箱操作。
  4.修复服务器多线程模式下数据解析错误。
  5.增加固定包头,固定长度,终止字符分割三种不同的数据解析功能。

  ②文件传输模块:
  1.极致优化性能,更少的内存申请、更大的传输单元,传输速度达500Mb/s

  ③RPC模块
  1.重新架构RPC,代理生成所有文件,避免元数据泄露问题。
  2.取消反向RPC内容,改为SendBytesWaitReturn方法替代。
  3.重新定义序列化接口,采用分块序列化方式,将主要序列化工作交由系统。

二、程序集功能概述

RRQMSocket是一个整合性网络通信框架,特点是支持高并发、事件驱动、易用性强、二次开发难度低等。其中主要内容包括:TCP服务通信框架、文件传输、RPC等内容,后续还会继续扩展其他组件,希望大家多多支持。

常用类继承图 在这里插入图片描述

三、TCP服务框架

3.1 服务器类(TcpService)

3.1.1 概述

TcpService是所有基于TCP协议类的基类,也是在服务器端创建服务器的对象类,但该类是抽象类,必须通过继承才能创建其具体对象,原因是在该类中,只实现了服务器的管理功能,但未实现其数据接收和处理功能,所以必须倚仗服务器辅助类才能实现其实际功能。其简单介绍如下:

3.1.2 属性、事件及方法概述

a.属性

  • IP:绑定服务器所用到的IP地址。
  • Port:绑定服务器所用到的端口号 。
  • BufferLength:缓存池长度。
  • Logger:日志记录器。
  • MainSocket:Socket主通信器 。
  • IsBand:判断服务器绑定是否成功。
  • IsCheckClientAlive:是否自动检验客户端活性(心跳检测)。
  • BytePool:获取内存池实例,该实例不可直接赋值,但是可以设置其参数。
  • SocketClients:获取已连接并且存活的客户端集合。

b.事件

事件名 触发
ClientConnected 当客户端连接成功时
ClientDisconnected 当客户端断开连接时
c.方法
方法名 功能
-- --
Bind 绑定本地监听IP及端口号
Dispose 断开绑定并且释放资源

3.1.3 创建TCP服务器

具体的创建步骤详见C# 创建高并发、高性能TCP通信框架

3.2 客户端类(TcpClient)

3.2.1 概述

TcpClient是基于TCP协议的客户端抽象类,一般的在接收和处理普通TCP报文时,客户端是不限类型、语言的。但是为统一使用,本程序集仍提供统一类型,其介绍如下:

3.2.2 属性、事件及方法概述

a.属性

  • IP:连接服务器所用到的IP地址。
  • Port:连接服务器所用到的端口号 。
  • BufferLength:缓存池长度。
  • Logger:日志记录器。
  • MainSocket:Socket主通信器 。
  • Online:判断客户端是否连接成功。
  • AllowSend:是否允许发送数据。
  • BytePool:获取内存池实例,该实例不可直接赋值,但是可以设置其参数。
  • DataHandlingAdapter:数据处理适配器。

b.事件

事件名 触发
ConnectedService 当客户端连接成功时
DisConnectedService 当客户端断开连接时
c.方法
方法名 功能
-- --
Connect 连接服务器
Send 发送数据
Dispose 断开绑定并且释放资源

3.3 服务器辅助类(TcpSocketClient)

3.3.1 概述

TcpSocketClient是基于TCP协议的服务器客户端抽象类,因为服务器类只对连接的客户端进行管理和检测,所以对于数据的处理,必须由辅助类实现,可以认为TcpSocketClient就是一个特殊的客户端类,他具有和TcpClient一样的接口功能,是直接参数数据交换的类,其介绍如下:

3.3.2 属性、事件及方法概述

a.属性

  • IP:连接到服务器的远程客户端的IP地址。
  • Port:连接到服务器的远程客户端的端口号 。
  • BufferLength:缓存池长度。
  • Logger:日志记录器。
  • MainSocket:Socket主通信器 。
  • Online:判断TcpSocketClient是否在线。
  • AllowSend:是否允许发送数据。
  • BytePool:获取内存池实例,该实例不可直接赋值,但是可以设置其参数。
  • DataHandlingAdapter:数据处理适配器。

b.事件

c.方法

方法名 功能
Send 发送数据
Dispose 断开绑定并且释放资源

3.3.3 创建TcpSocketClient

具体的创建步骤详见C# 创建高并发、高性能TCP通信框架

四、文件传输模块

4.1概述

文件传输模块是基于TCP协议的网络文件传输类的整合。它适用于局域网、广域网、组合网等各种网络环境中,其主要功能包括上传文件、下载文件、限速传输、断点续传。快速上传、事件通知等。

4.2 文件传输服务器(FileService)

4.2.1 概述

FileService是基于TcpService的类,其功能基础和TcpService一致。但是也有增强功能,其介绍如下:

4.2.2 属性、事件及方法概述

a.属性

  • IP:连接到服务器的远程客户端的IP地址。
  • Port:连接到服务器的远程客户端的端口号 。
  • BufferLength:缓存池长度。
  • Logger:日志记录器。
  • MainSocket:Socket主通信器 。
  • Online:判断TcpSocketClient是否在线。
  • AllowSend:是否允许发送数据。
  • BytePool:获取内存池实例,该实例不可直接赋值,但是可以设置其参数。
  • DataHandlingAdapter:数据处理适配器。
  • DownloadSpeed:下载总速度。
  • UploadSpeed:上传总速度。
  • BreakpointResume:断点续传开关。
  • IsFsatUpload:快速上传开关。

b.事件

事件名 触发
ConnectedService 当客户端连接成功时
DisConnectedService 当客户端断开连接时
BeforeReceiveFile 当客户端请求上传文件之前
BeforeSendFile 当客户端请求下载文件之前
ReceiveFileFinished 接收完客户端上传的文件时
SendFileFinished 发送完客户端下载的文件时
ReceiveSystemMes 当收到客户发送的消息时
ReceivedBytesThenReturn 当收到客户端数据并回传时

c.方法

4.2.3 创建FileService

具体的创建步骤详见C#、Socket文件传输、大文件续传、可高性能、高并发运行、断点续传、数据对象传递等功能

4.3 文件传输客户端(FileClient)

4.3.1 概述

FileClient是基于TcpClient的类,其功能基础和TcpClient一致。但是也有增强功能,其介绍如下:

4.3.2 属性、事件及方法概述

a.属性

  • IP:连接到服务器的远程客户端的IP地址。
  • Port:连接到服务器的远程客户端的端口号 。
  • BufferLength:缓存池长度。
  • Logger:日志记录器。
  • MainSocket:Socket主通信器 。
  • Online:判断TcpSocketClient是否在线。
  • AllowSend:是否允许发送数据。
  • BytePool:获取内存池实例,该实例不可直接赋值,但是可以设置其参数。
  • DataHandlingAdapter:数据处理适配器。
  • DownloadSpeed:下载速度。
  • UploadSpeed:上传速度。
  • UploadFileBlocks:上传文件包集合。
  • DownloadFileBlocks:下载文件包集合。
  • Timeout:单次请求超时时间。
  • UploadProgress:上传进度。
  • DownloadProgress:下载进度。
  • UploadFileInfo:上传文件信息。
  • DownloadFileInfo:下载文件信息。
  • ReceiveDirectory:下载文件存放目录。

b.事件

事件名 触发
ConnectedService 当客户端连接成功时
DisConnectedService 当客户端断开连接时
BeforeUploadFile 当客户端请求上传文件之前
BeforeDownloadFile 当客户端请求下载文件之前
UploadFileFinshed 接收完客户端上传的文件时
DownloadFileFinshed 发送完客户端下载的文件时
TransferFileError 当传输文件发生致命性错误时

c.方法

方法名 功能
Connect 连接服务器
DownloadFile 下载文件
PauseDownload 暂停下载
ResumeDownload 恢复下载
StopDownload 终止下载
UploadFile 上传文件
PauseUpload 暂停上传
ResumeUpload 恢复上传
StopUpload 终止上传
SendSystemMessage 发送消息
SendBytesWaitReturn 发送流并等待返回
Dispose 释放资源

4.3.3 创建FileClient

具体的创建步骤详见C#、Socket文件传输、大文件续传、可高性能、高并发运行、断点续传、数据对象传递等功能

五、 RPC

RPC是远程过程调用(Remote Procedure Call)的缩写形式。客户程序通过接口调用服务内部的标准或自定义函数,获得函数返回的数据进行处理后显示或打印。类似于WCF和WebService。

5.1 RPC服务器(RPCService)

5.1.1 概述

RPC服务器基本上没有其他的概述,直接使用即可。

5.1.2 属性、事件及方法概述

a.属性b.事件c.方法

5.1.3 创建RPCService

具体的创建步骤详见C# RPC高性能微框架,支持任意序列化、out及ref、可使用http协议跨平台

5.2 RPC客户端(RPCClient)

5.2.1 概述

RPC客户端基本上没有其他的概述,直接使用即可。

5.2.2 属性、事件及方法概述

a.属性b.事件c.方法

5.2.3 创建RPCClient

具体的创建步骤详见C# RPC高性能微框架,支持任意序列化、out及ref、可使用http协议跨平台

六、使用其他功能

6.1加密和解密

程序集本身不提供加密及解密服务,所以文件,数据对象,文本等在传输过程中都是直接传输的,但是程序集里面整合了3DES的加密方法,具体使用可以直接调用DataLock的静态方法进行数据的加密和解密。

七、致谢

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

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是一个整合性网络通信框架,特点是支持高并发、事件驱动、易用性强、二次开发难度低等。其中主要内容包括:TCP服务通信框架、文件传输、RPC等内容 展开 收起
C#
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

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

搜索帮助

53164aa7 5694891 3bd8fe86 5694891