12 Star 47 Fork 24

lutianming / Pasture

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

Pasture

介绍

本项目是一个纯净的TCP/UDP/SSL/KCP网络框架,支持IPv4、IPv6双栈,毫秒级定时器,默认多线程运,Proactor模型,上手简单,业务开发简单方便。

主要特性:

  1. 对TCP/UDP/SSL/KCP连接提供相同的API操作
  2. 绑定IPv6的服务,同时可以接受IPv4的连接
  3. 一个或多个连接绑定一个worker用于处理网络事件,并且都在同一个线程执行,复杂场景下也能轻松实现线程安全
  4. 支持定时器、自定义事件或者信号投递到worker,并且也在worker所在线程执行,
  5. 连接可以从一个woker转移给另一个worker

设计思路:

  1. 全局仅有一个actor,管理所有的accepter和worker
  2. actor将启动 1个accept线程 和 CPU核数 个worker线程
  3. accept线程处理tcp监听事件
  4. worker线程处理连接读写和业务逻辑,以及定时器、自定义事件和信号
  5. accept线程和worker线程拥有相同的逻辑,能处理的事务并不是固定的

接口简洁:

	HSOCKET tcp_sock = HsocketConnect(worker, "127.0.0.1", 1080, TCP_PROTOCOL);
	HSOCKET udp_sock = HsocketConnect(worker, "127.0.0.1", 1080, UDP_PROTOCOL);

	HsocketSSLCreate(tcp_sock, SSL_SERVER, 0, ca_crt, user_crt, pri_key);
	HsocketSSLCreate(tcp_sock, SSL_CLIENT, 0, ca_crt, user_crt, pri_key);

	HsocketKcpCreate(udp_sock, conv, 0);
	HsocketKcpUpdate(udp_sock);

	HsocketSend(sock, data, len);
	HsocketClose(sock);

源码说明

src为源码目录  
actor.h    			头文件  
actor_iocp.cpp    	Windows IOCP 实现  
actor_epoll.cpp    	linux epoll 实现

example示例代码  
echoServer.cpp		回显服务 

使用者只需要选择其中一个.cpp文件在相应平台编译即可,头文件中为不同的平台提供相同的api,基于本框架的项目可以快速完成跨平台移植

示例

// 这是一个回显服务的示例代码
//

#include <iostream>
#include <functional>
#include "actor.h"

#ifdef __WINDOWS__
#define TimeSleep(x) Sleep(x*1000)
#else
#define TimeSleep(x) sleep(x)
#endif // __WINDOWS__

class EchoClient : public BaseWorker		//继承BaseWorker
{
public:
	HSOCKET sock1 = nullptr;
	HSOCKET sock2 = nullptr;
	Timer timer;
	void ConnectionMade(HSOCKET hsock, PROTOCOL protocol) {
		if (hsock == this->sock1) {
			printf("sock1 连接成功\n");
		}
		if (hsock == this->sock2) {
			printf("sock2 连接成功\n");
		}
	};
	void ConnectionFailed(HSOCKET hsock, int err) {};
	void ConnectionClosed(HSOCKET hsock, int err) {
		if (hsock == this->sock1) {
			sock1 = nullptr;
		}
		if (hsock == this->sock2) {
			sock2 = nullptr;
		}
		if (sock1 == nullptr && sock2 == nullptr) {
			timer.close();
		}
	};
	void ConnectionRecved(HSOCKET sock, const char* data, int len) {
		printf("client 接收: [%.*s]\n", len, data);
		HsocketPopBuf(sock, len);
	};
};

class EchoServer: public BaseWorker		//继承BaseWorker
{
public:
	void ConnectionMade(HSOCKET hsock, PROTOCOL protocol) {};
	void ConnectionFailed(HSOCKET hsock, int err) {};
	void ConnectionClosed(HSOCKET hsock, int err) {};
	void ConnectionRecved(HSOCKET hsock, const char* data, int len) {
		printf("server 接收: [%.*s]\n", len, data);
		HsocketSend(hsock, data, len);
		HsocketPopBuf(hsock, len);
		//HsocketClose(sock);	//从容关闭,后续触发ConnectionClosed事件
		//HsocketClosed(sock);	//立即关闭,不触发事件
	};
};

int main(){
	int listen_port = 8000;
	//启动全局reactor
	ActorStart(0);  

	/*通过模板创建一个工厂类*/
	Factory<EchoServer> factory;

	printf("factory 启动\n");
	//factory.listen("0.0.0.0", listen_port);  //仅ipv4
	factory.listen("::", listen_port);		//ipv4、ipv6双协议栈
	printf("正在监听%d端口……\n", listen_port);

	printf("创建EchoClient,并连接127.0.0.1:8000\n");
	EchoClient client;
	client.task([&client, listen_port]() {  //向client所在的线程(非当前线程)安排个任务,用于实现线程安全
		//这一段在woker工作的线程执行
		client.sock1 = HsocketConnect(&client, "127.0.0.1", listen_port, TCP_PROTOCOL); 
		client.sock2 = HsocketConnect(&client, "127.0.0.1", listen_port, TCP_PROTOCOL);
	});
	/* 创建一个定时器,定时发送 hello world */
	client.timer.create(&client, 1000, 3000, [&client]() {
		if (client.sock1)HsocketSend(client.sock1, "hello world 1", 13);
		if (client.sock2)HsocketSend(client.sock2, "hello world 2", 13);
	});

	//TimeSleep(10);
	//printf("factory 优雅关闭\n");
	//factory.stop();
	
	//printf("factory 重启\n");
	//listen_port = 8001;
	//factory.listen("::", listen_port);
	//printf("正在监听%d端口……\n", listen_port);
	//TimeSleep(30);
	//printf("factory 关闭\n");
	//factory.stop();

	while (true){
		TimeSleep(10);
	}
}

常见问题

1.将项目源代码放到自己的工程中,MSVC编译报错如何解决?

源代码文件默认为UTF-8编码,请尝试转换成系统支持的编码格式

以下项目使用本框架

SuperSheeps服务器压力测试的框架: http://www.supersheeps.cn/

木兰宽松许可证, 第1版 木兰宽松许可证, 第1版 2019年8月 http://license.coscl.org.cn/MulanPSL 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第1版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的一方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括仅因您或他人修改“贡献”或其他结合而将必然会侵犯到的专利权利要求。如您或您的“关联实体”直接或间接地(包括通过代理、专利被许可人或受让人),就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 条款结束。 如何将木兰宽松许可证,第1版,应用到您的软件 如果您希望将木兰宽松许可证,第1版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) 2019 lutianming email:641471957@qq.com Pasture is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v1 for more details. Mulan Permissive Software License,Version 1 Mulan Permissive Software License,Version 1 (Mulan PSL v1) August 2019 http://license.coscl.org.cn/MulanPSL Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v1 (this License) with following terms and conditions: 0. Definition Software means the program and related documents which are comprised of those Contribution and licensed under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, or are controlled by, or are under common control with a party to this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. Contribution means the copyrightable work licensed by a particular Contributor under this License. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed, excluding of any patent claims solely be infringed by your or others’ modification or other combinations. If you or your Affiliates directly or indirectly (including through an agent, patent licensee or assignee), institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability The Software and Contribution in it are provided without warranties of any kind, either express or implied. In no event shall any Contributor or copyright holder be liable to you for any damages, including, but not limited to any direct, or indirect, special or consequential damages arising from your use or inability to use the Software or the Contribution in it, no matter how it’s caused or based on which legal theory, even if advised of the possibility of such damages. End of the Terms and Conditions How to apply the Mulan Permissive Software License,Version 1 (Mulan PSL v1) to your software To apply the Mulan PSL v1 to your work, for easy identification by recipients, you are suggested to complete following three steps: i. Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii. Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii. Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) 2019 lutianming email:641471957@qq.com Pasture is licensed under the Mulan PSL v1. You can use this software according to the terms and conditions of the Mulan PSL v1. You may obtain a copy of Mulan PSL v1 at: http://license.coscl.org.cn/MulanPSL THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v1 for more details.

简介

一个跨平台(linux、windows)的tcp/udp/ssl/kcp多线程Proactor网络框架,支持IPv4、IPv6双栈及定时器,平衡性能与业务开发难度,windows下使用IOCP,linux下使用epoll 展开 收起
C++
MulanPSL-1.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/lutianming/pasture.git
git@gitee.com:lutianming/pasture.git
lutianming
pasture
Pasture
master

搜索帮助