github-repos/kcp
1
0
Fork 0
mirror of https://github.com/skywind3000/kcp.git synced 2025-02-22 01:50:09 +08:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source 
update readme
This commit is contained in:
Linwei 2014-12-30 17:22:33 +08:00
parent c5a877d2aa
commit 91bc738f9a
1 changed files with 17 additions and 16 deletions

33
README.md
View File

@ -1,5 +1,5 @@
KCP - A Fast and Reliable ARQ Protocol KCP - A Fast and Reliable ARQ Protocol
=== ======================================
# 简介 # 简介
@ -13,7 +13,7 @@ KCP是一个快速可靠协议，能以比 TCP浪费10%-20%的带宽的代价，
现，那么简单的拷贝这两个文件到现有项目中，稍微编写两行代码，即可使用。 现，那么简单的拷贝这两个文件到现有项目中，稍微编写两行代码，即可使用。
## 【技术特性】 # 技术特性
TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的是充分利用带宽。而KCP TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的是充分利用带宽。而KCP
是为流速设计的（单个数据包从一端发送到一端需要多少时间），以10%-20%带宽浪费的 是为流速设计的（单个数据包从一端发送到一端需要多少时间），以10%-20%带宽浪费的
@ -21,34 +21,34 @@ TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的
大运河，而KCP是水流湍急的小激流。KCP有正常模式和快速模式两种，通过以下策略达 大运河，而KCP是水流湍急的小激流。KCP有正常模式和快速模式两种，通过以下策略达
到提高流速的结果： 到提高流速的结果：
### RTO翻倍vs不翻倍： #### RTO翻倍vs不翻倍：
TCP超时计算是RTOx2，这样连续丢三次包就变成RTOx8了，十分恐怖，而KCP启动快速 TCP超时计算是RTOx2，这样连续丢三次包就变成RTOx8了，十分恐怖，而KCP启动快速
模式后不x2，只是x1.5（实验证明1.5这个值相对比较好），提高了传输速度。 模式后不x2，只是x1.5（实验证明1.5这个值相对比较好），提高了传输速度。
### 选择性重传 vs 全部重传： #### 选择性重传 vs 全部重传：
TCP丢包时会全部重传从丢的那个包开始以后的数据，KCP是选择性重传，只重传真正 TCP丢包时会全部重传从丢的那个包开始以后的数据，KCP是选择性重传，只重传真正
丢失的数据包。 丢失的数据包。
### 快速重传： #### 快速重传：
发送端发送了1,2,3,4,5几个包，然后收到远端的ACK: 1, 3, 4, 5，当收到ACK3时， 发送端发送了1,2,3,4,5几个包，然后收到远端的ACK: 1, 3, 4, 5，当收到ACK3时，
KCP知道2被跳过1次，收到ACK4时，知道2被跳过了2次，此时可以认为2号丢失，不用 KCP知道2被跳过1次，收到ACK4时，知道2被跳过了2次，此时可以认为2号丢失，不用
等超时，直接重传2号包，大大改善了丢包时的传输速度。 等超时，直接重传2号包，大大改善了丢包时的传输速度。
### 延迟ACK vs 非延迟ACK： #### 延迟ACK vs 非延迟ACK：
TCP为了充分利用带宽，延迟发送ACK（NODELAY都没用），这样超时计算会算出较大 TCP为了充分利用带宽，延迟发送ACK（NODELAY都没用），这样超时计算会算出较大
RTT时间，延长了丢包时的判断过程。KCP的ACK是否延迟发送可以调节。 RTT时间，延长了丢包时的判断过程。KCP的ACK是否延迟发送可以调节。
### UNA vs ACK+UNA： #### UNA vs ACK+UNA：
ARQ模型响应有两种，UNA（此编号前所有包已收到，如TCP）和ACK（该编号包已收到 ARQ模型响应有两种，UNA（此编号前所有包已收到，如TCP）和ACK（该编号包已收到
），光用UNA将导致全部重传，光用ACK则丢失成本太高，以往协议都是二选其一，而 ），光用UNA将导致全部重传，光用ACK则丢失成本太高，以往协议都是二选其一，而
KCP协议中，除去单独的 ACK包外，所有包都有UNA信息。 KCP协议中，除去单独的 ACK包外，所有包都有UNA信息。
### 非退让流控： #### 非退让流控：
KCP正常模式同TCP一样使用公平退让法则，即发送窗口大小由：发送缓存大小、接收 KCP正常模式同TCP一样使用公平退让法则，即发送窗口大小由：发送缓存大小、接收
端剩余接收缓存大小、丢包退让及慢启动这四要素决定。但传送及时性要求很高的小 端剩余接收缓存大小、丢包退让及慢启动这四要素决定。但传送及时性要求很高的小
@ -56,9 +56,9 @@ TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的
性及带宽利用率之代价，换取了开着BT都能流畅传输的效果。 性及带宽利用率之代价，换取了开着BT都能流畅传输的效果。
## 【基本使用】 # 基本使用
1. 创建 KCP对象： * 创建 KCP对象：
```cpp ```cpp
// 初始化 kcp对象，conv为一个表示会话编号的整数，和tcp的 conv一样，通信双 // 初始化 kcp对象，conv为一个表示会话编号的整数，和tcp的 conv一样，通信双
@ -66,7 +66,7 @@ TCP是为流量设计的（每秒内可以传输多少KB的数据），讲究的
ikcpcb *kcp = ikcp_create(conv, user); ikcpcb *kcp = ikcp_create(conv, user);
``` ```
2. 设置回调函数： * 设置回调函数：
```cpp ```cpp
@ -81,7 +81,7 @@ int udp_output(const char *buf, int len, ikcpcb *kcp, void *user)
kcp->output = udp_output; kcp->output = udp_output;
``` ```
3. 循环调用 update： * 循环调用 update：
```cpp ```cpp
// 以一定频率调用 ikcp_update来更新 kcp状态，并且传入当前时钟（毫秒单位） // 以一定频率调用 ikcp_update来更新 kcp状态，并且传入当前时钟（毫秒单位）
@ -89,7 +89,7 @@ kcp->output = udp_output;
ikcp_update(kcp, millisec); ikcp_update(kcp, millisec);
``` ```
4. 输入一个下层数据包： * 输入一个下层数据包：
```cpp ```cpp
// 收到一个下层数据包（比如UDP包）时需要调用： // 收到一个下层数据包（比如UDP包）时需要调用：
@ -99,7 +99,7 @@ ikcp_input(kcp, received_udp_packet, received_udp_size);
送数据。而另一端使用ikcp_recv(kcp, ptr, size)来接收数据。 送数据。而另一端使用ikcp_recv(kcp, ptr, size)来接收数据。
## 【协议配置】 # 协议配置
协议默认模式是一个标准的 ARQ，需要通过配置打开各项加速开关： 协议默认模式是一个标准的 ARQ，需要通过配置打开各项加速开关：
@ -139,7 +139,8 @@ ikcp_input(kcp, received_udp_packet, received_udp_size);
kcp->rx_minrto = 10; kcp->rx_minrto = 10;
``` ```
## 【内存分配器】 # 最佳实践
#### 内存分配器
默认KCP协议使用 malloc/free进行内存分配释放，如果应用层接管了内存分配，可以用 默认KCP协议使用 malloc/free进行内存分配释放，如果应用层接管了内存分配，可以用
ikcp_allocator来设置新的内存分配器，注意要在一开始设置： ikcp_allocator来设置新的内存分配器，注意要在一开始设置：
@ -149,7 +150,7 @@ ikcp_allocator来设置新的内存分配器，注意要在一开始设置：
``` ```
## 【前向纠错注意】 #### 前向纠错注意
为了进一步提高传输速度，下层协议也许会使用前向纠错技术。需要注意，前向纠错会 为了进一步提高传输速度，下层协议也许会使用前向纠错技术。需要注意，前向纠错会
根据冗余信息解出原始数据包。相同的原始数据包不要两次input到KCP，否则将会导致 根据冗余信息解出原始数据包。相同的原始数据包不要两次input到KCP，否则将会导致