Skip to content
forked from xtaci/libkcp

kcp client session library for iOS/Android

License

Notifications You must be signed in to change notification settings

ruleless/libkcp

 
 

Repository files navigation

libkcp

[![Powered][1]][2] [![Build Status][3]][4] [1]: https://img.shields.io/badge/KCP-Powered-blue.svg [2]: https://github.com/skywind3000/kcp [3]: https://travis-ci.org/xtaci/libkcp.svg?branch=master [4]: https://travis-ci.org/xtaci/libkcp kcp client session library for iOS/Android, compatible with kcp-go.
kcp 客户端库,可用于iOS/Android, 与kcp-go兼容。

Features

  1. Optimized for Real-Time Strategy Game. 针对实时游戏优化设计。
  2. Stream based interface, you can easily switch from your TCP based protocol to libkcp or dualstack. 流接口,方便切换现有TCP协议,或实现双栈通信。
  3. Less than 300 LOC, just copy source codes to your projects and play. 极简设计,拷走即用。

Usage

libkcp has designed as a Frame-Driven library, the main loop was supposed as:
libkcp 被设计为 帧驱动 的库,主循环如:

GameInit()
NetworkInit()
While(not gameover) Do      // e.g:  A 30FPS Game
       Network.Read()
       Network.Write()
       Network.Update()
       Game.Logic()
       Game.Render()
       Wait(33ms)   // clock
End

The Read/Write/Update functions of libkcp are guaranteed to be non-blocking.
Read/Write/Update 函数保证是 非阻塞 的调用。

Please read main.cpp for library usage.
阅读main.cpp 学习使用方法。

Demo

start echo server(golang)

$go get github.com/xtaci/kcp-go
$go run kcpserver.go

compile and run libkcp, and watch output.

启动echo服务器(golang)

$go get github.com/xtaci/kcp-go
$go run kcpserver.go

编译并运行项目,观察输出。

Caveats

  1. FEC has not implemented yet. 没有前向纠错
  2. Packet level encryption has not implemented yet. 没有包级加密

Troubleshooting

  1. C++11 is required for compiling. 需要C++11进行编译。
  2. Make sure you are using Listen() function in kcp-go as server listener. 兼容服务器端默认参数,请确保使用标准Listen()函数在服务器端监听。

About

kcp client session library for iOS/Android

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 82.4%
  • C++ 15.8%
  • Go 1.4%
  • CMake 0.4%