# kcp_latency_demo

**Repository Path**: hellyguo/kcp_latency_demo

## Basic Information

- **Project Name**: kcp_latency_demo
- **Description**: a demo for use libkcp
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2023-01-04
- **Last Updated**: 2024-07-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: kcp, udp, 低延时

## README

# 样本

测试 [KCP](https://github.com/skywind3000/kcp/) 延时的样例程序

**说明**

为了达到最佳延时效果，按 `KCP` 的建议，每次都调用 `ikcp_flush` 函数进行强制发送。

## 结构

- `kcpsrv` 监听 `udp` `12345` 端口
- `kcpcli` 监听 `udp` `54321` 端口

1. `kcpcli` 连接到 `kcpsrv` 的监听端口上，每隔 `1ms` 上送执行时的时间戳。
2. `kcpsrv` 接收到报文后，用当前时间与报文时间戳相减，得到单次通讯延时。
3. `kcpsrv` 将 `KCP` 底层确认包发送到 `kcpcli` 的监听端口。

## 测试结果

- 纯 `kcp` 测试结果：[纯 kcp 实现](result.00.kcp.md)
- `kcp` + `pthread` 测试结果：[kcp + pthread 实现](result.01.pthread.md)
- `kcp` + `libev` 测试结果：[kcp + libev 实现](result.02.libev.md)
- `kcp` + `libev` 带负载测试结果：[kcp + libev 带负载实现](result.03.libev.payload.md)

从测试结果看，相当稳定。

## 编译

**前提**

- 将 `libkcp.a` 及 `libev.a` 放于 `lib` 内
- 或将 `libkcp.a` 及 `libev.a` 安装到 `/usr` 下

```shell
$> mkdir build
$> cd build
$> cmake .. && make
```

可打开 `kcpdemo.h` 中的 `__DEBUG` 宏，添加更多输出信息

## 执行

开两个终端

**终端1**

```shell
$> cd build
$> ./kcpsrv[n]
or
$> ./kcpsrv[n] <client ip(format: a.b.c.d)> #n=4,5
```

**终端2**

```shell
$> cd build
$> ./kcpcli[n]
or
$> ./kcpcli[n] <server ip(format: a.b.c.d)> #n=4,5
```

`n` 可取 `[0,1,2,3,4,5]`, 分别对应于:

| 编号 | 含义 |
|-----|-----|
| 0 | 纯 `kcp` 实现 |
| 1 | `kcp`+`pthread` 实现 |
| 2 | `kcp`+`libev` 实现 |
| 3 | `kcp`+`libev` 带负载实现 |
| 4 | `kcp`+`libev` 支持远端实现 |
| 5 | `kcp`+`libev` 支持远端实现，延时为客户端发出并收回时间 |

## 最佳效果

通过将应用绑定在不同的 `CPU` 核，得到最佳性能

```shell
taskset -c 0,1 ./kcpsrv4 127.0.0.1 &
taskset -c 4,5 ./kcpcli4 127.0.0.1

taskset -c 0,1 ./kcpsrv5 127.0.0.1 &
taskset -c 4,5 ./kcpcli5 127.0.0.1
```

## TODO

1. ~~添加负载，测试不同负载下的结果~~

## 缺陷

1. ~~目前无法支持太多次连续调用~~
    > 原因：`KCP` 的队列不支持多线程操作，需要在一个线程中操作
2. ~~使用了线程锁，延迟降低严重~~
    > 原因：`kcpcli` 一次只读一个包过慢，一次性读取足够多就能加速

## 感谢

感谢[林伟](https://github.com/skywind3000/)大佬提供的优秀网络库！