9 Star 34 Fork 7

kibaamor / knet

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

knet

English Version

一个跨平台的无锁且支持定时器的C++11网络库。

AppVeyor License Standard FOSSA Status

目录


特点

  • 支持Window、Linux、MacOS、FreeBSD
  • 同时支持同步、异步两种使用方式
  • 易于扩展,支持网络粘包
  • 代码少,无第三方库依赖
  • 无锁设计,每个连接的创建销毁逻辑都在同一个固定的线程中处理
  • 支持定时器,如心跳发送与检测

编译环境

  • CMake 3.15 及以上
  • Clang 3.8及以上(如果你使用Clang编译)
  • Visual Studio 2015及以上(Windows)
  • G++ 5及以上(Linux)
  • Xcode 9.4 及以上(MacOS)

如何使用

vcpkg

vcpkg install knet

从源代码编译安装

# 克隆源代码
git clone https://github.com/KibaAmor/knet.git # 或者 https://gitee.com/kibaamor/knet.git

# 进入项目目录
cd knet

# 生产编译工程文件
cmake . -B build

# 编译Release
cmake --build build --config Release

# 运行测试
(cd build && ctest --output-on-failure)

# 安装
(cd build && sudo make install)

核心概念

knet的核心概念是:socket的生产-消费

本质来说:客户端连接服务器服务器接受客户端的连接都是创建可以读写socket。而创建socket后,客户端和服务器对socket的操作都是一样的发送消息和接受消息。那么这个过程就可以看作是一个生成socket和消费socket的过程。如下图:

   producer                       consumer
┌───────────┐                  ┌──────────────┐
│ connector │    ——————————>   │    worker    │
│           │      socket      │              │
│ acceptor  │    ——————————>   │ async_worker │
└───────────┘                  └──────────────┘
  • connector 连接器,在客户端连接服务器时使用
  • acceptor 接收器,在服务器想要接受客户端连接时使用
  • worker socket的同步处理逻辑
  • async_worker socket的异步处理逻辑

示例程序

echo服务器和客户端

example目录下提供了使用knet实现的echo服务器echo客户端.

通信协议

┌───────────────┬──────┐
│ 数据大小(4字节) │ 数据 │
└───-───────────┴──────┘

网络包前4个字节为后面数据的大小,紧跟在后面的为数据。

echo服务器

echo服务器将接收到的数据原封不动的发回给客户端。

同时还设置了定时器检查是否在指定的时间内收到了客户端的消息,如果未在指定时间收到客户端消息,将关闭与客户端的连接。

服务器提供了两种:

echo客户端

客户端启动后主动连接服务器(如果连接不上服务器,则会自动重连服务器),连接成功后,会主动给服务器发送不完整的网络包。

在收到服务器返回的网络包时,会对数据封包进行校验,失败时会断开连接。

客户端也提供了两种:

授权

FOSSA Status

MIT License Copyright (c) 2020 Kiba Amor Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

A cross platform lock-free and timer-supported(heartbeat etc.) C++11 network library.一个跨平台的无锁且支持定时器(如:心跳)的C++11网络库。 展开 收起
C++ 等 2 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/kibaamor/knet.git
git@gitee.com:kibaamor/knet.git
kibaamor
knet
knet
master

搜索帮助