# knet

**Repository Path**: cageq/knet

## Basic Information

- **Project Name**: knet
- **Description**: 基于asio二次封装的C++17网络库，接口简单。支持tcp/udp/kcp/http/websocket
- **Primary Language**: C++
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 63
- **Forks**: 18
- **Created**: 2020-08-26
- **Last Updated**: 2025-08-07

## Categories & Tags

**Categories**: web-dev-toolkits

**Tags**: None

## README

## KNet 
 
 简单的网络编程库封装，基于ASIO standalone版本封装，核心特点是设计了极简API，让网络编程变得非常简单。服务端使用了“1 => n”线程模型，监听一个线程，多个工作线程（n >= 0), 单个连接的所有事件和数据回调都在一个线程。尽可能提升服务器性能。API部分都是线程安全的，放心使用。支持headonly使用，包含头文件即可。 


## 编译示例代码

    库本身不需要编译，内置了一些示例代码，可以进行编译。 最新版本使用了C++17语言的一些特性，需要支持C++17的编译器和CMake工具。 由于国内访问github困难，内置了依赖的第三方包，如fmt，spdlog等,可以直接使用根目录下的./build.sh 可自动展开进行编译（需要先安装unzip等工具）。

```shell

git submodule init 

git submodule update --recursive 

cmake . 

make -j4 

# or 
./build.sh 

```


## 创建Tcp服务器

```cpp

#include "knet.hpp"
using namespace knet::tcp;
 
//Sample protocol head 
struct UserMsgHead {
    uint32_t length; //body length 
    uint32_t type;
    char     data[0];  
}; 
 

#include "knet.hpp"
using namespace knet::tcp; 
class TcpSession : public TcpConnection<TcpSession> {
    public:
       virtual int32_t handle_package(const char * data, uint32_t len ) override{ 
            //sample usage message head 
            if (len  < sizeof(UserMsgHead)){
                return 0; 
            }
            UserMsgHead * head = (UserMsgHead*) data;  
            return head->length + sizeof(UserMsgHead); 
        }

        //all net events
        virtual bool handle_event(NetEvent evt) override { 
            return true; 
        }

        //one whole message, divided by handle_package  
        virtual bool handle_data(char * data, uint32_t dataLen) override{
            return true; 
        }
}; 

TcpListener<TcpSession> listener;
listener.start(8899); 

```



## 创建Tcp客户端

```cpp

//使用和服务器相同的TcpSession 

TcpConnector<TcpSession>  connector;
connector.start(); 
connector.add_connection("127.0.0.1", 8899);

```

## UDP/KCP/HTTP/WEBSOCK

对UDP/KCP/HTTP/WebSocket 进行了简单的封装，可以初步使用。