Categorygithub.com/lexesv/kcp-go
modulepackage
2.0.3+incompatible
Repository: https://github.com/lexesv/kcp-go.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
25
Dependents
0
Files
2.3k SLOC

# README

kcp-go

GoDoc Powered MIT licensed Build Status Go Report Card Coverage Statusd

Claude_Shannon

Introduction

kcp-go is a full-featured reliable-UDP library for golang. It provides reliable, ordered, and error-checked delivery of a stream of octets between applications running on hosts communicating over an IP network.

Features

  1. Optimized for Real-Time Strategy Game.
  2. Compatible with skywind3000's C version with modifications.
  3. Cache friendly and Memory optimized design in golang.
  4. Compatible with net.Conn and net.Listener.
  5. FEC(Forward Error Correction) Support with Reed-Solomon Codes
  6. Packet level encryption support with AES, TEA, 3DES, Blowfish, Cast5, Salsa20, etc. in CFB mode.

Conventions

Control messages like SYN/FIN/RST in TCP are not defined in KCP, you need some keepalive mechanims in the application-level. a real world example is to use some multiplexing protocol over session, such as smux, see kcptun for example.

Documentation

For complete documentation, see the associated Godoc.

Specification

Frame Format

Usage

Client: full demo

kcpconn, err := kcp.DialWithOptions("192.168.0.1:10000", nil, 10, 3)

Server: full demo

lis, err := kcp.ListenWithOptions(":10000", nil, 10, 3)

Performance

  型号名称：	MacBook Pro
  型号标识符：	MacBookPro12,1
  处理器名称：	Intel Core i5
  处理器速度：	2.7 GHz
  处理器数目：	1
  核总数：	2
  L2 缓存（每个核）：	256 KB
  L3 缓存：	3 MB
  内存：	8 GB

$ go test -run Speed
new client 127.0.0.1:61165
total recv: 16777216
time for 16MB rtt with encryption 570.41176ms
&{BytesSent:33554432 BytesReceived:33554432 MaxConn:2 ActiveOpens:1 PassiveOpens:1 CurrEstab:1 InErrs:0 InCsumErrors:0 InSegs:42577 OutSegs:42641 OutBytes:48111336 RetransSegs:92 FastRetransSegs:92 LostSegs:0 RepeatSegs:0 FECRecovered:1 FECErrs:0 FECSegs:8514}
PASS
ok  	github.com/xtaci/kcp-go	0.600s

Links

  1. https://github.com/xtaci/libkcp -- Official client library for iOS/Android(C++11)
  2. https://github.com/skywind3000/kcp -- A Fast and Reliable ARQ Protocol
  3. https://github.com/klauspost/reedsolomon -- Reed-Solomon Erasure Coding in Go

Status

Production Ready

Donation

donate

All donations on this project will be used to support the development of gonet/2.

# Functions

Dial connects to the remote address "raddr" on the network "udp".
DialWithOptions connects to the remote address "raddr" on the network "udp" with packet encryption.
Listen listens for incoming KCP packets addressed to the local address laddr on the network "udp",.
ListenWithOptions listens for incoming KCP packets addressed to the local address laddr on the network "udp" with packet encryption, dataShards, parityShards defines Reed-Solomon Erasure Coding parameters.
NewAESBlockCrypt https://en.wikipedia.org/wiki/Advanced_Encryption_Standard.
NewBlowfishBlockCrypt https://en.wikipedia.org/wiki/Blowfish_(cipher).
NewCast5BlockCrypt https://en.wikipedia.org/wiki/CAST-128.
NewConn establishes a session and talks KCP protocol over a packet connection.
NewKCP create a new kcp control object, 'conv' must equal in two endpoint from the same connection.
NewNoneBlockCrypt does nothing but copying.
NewSalsa20BlockCrypt https://en.wikipedia.org/wiki/Salsa20.
NewSimpleXORBlockCrypt simple xor with key expanding.
NewTEABlockCrypt https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm.
NewTripleDESBlockCrypt https://en.wikipedia.org/wiki/Triple_DES.
NewTwofishBlockCrypt https://en.wikipedia.org/wiki/Twofish.
NewXTEABlockCrypt https://en.wikipedia.org/wiki/XTEA.
ServeConn serves KCP protocol for a single packet connection.

# Constants

No description provided by the author
need to send IKCP_CMD_WASK.
need to send IKCP_CMD_WINS.
cmd: ack.
cmd: push data.
cmd: window probe (ask).
cmd: window size (tell).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
7 secs to probe window size.
up to 120 secs to probe window.
No description provided by the author
No description provided by the author
normal min rto.
no delay min rto.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

DefaultSnmp is the global KCP connection statistics collector.

# Structs

ConnectedUDPConn is a wrapper for net.UDPConn which converts WriteTo syscalls to Write syscalls that are 4 times faster on some OS'es.
No description provided by the author
KCP defines a single KCP connection.
No description provided by the author
Segment defines a KCP segment.
Snmp defines network statistics indicator.
No description provided by the author

# Interfaces

BlockCrypt defines encryption/decryption methods for a given byte slice.

# Type aliases

Output is a closure which captures conn and calls conn.Write.