/yasio

A multi-platform support c++11 library with focus on asio (asynchronous socket I/O) for any client applications.

Primary LanguageC++OtherNOASSERTION

yasio logo

YASIO - Yet Another Socket I/O library.

Latest Release 996.icu LICENSE GitHub stars GitHub forks codeql

English

yasio 是一个轻量级跨平台的异步socket库,专注于客户端和基于各种游戏引擎的游戏客户端网络服务, 支持windows、macos、ios、android、linux、freebsd以及其他类unix操作系统。

支持平台

Build Status (github)
Windows(msvc,clang,mingw) Windows Build Status
Windows(vs2013) Windows VS2013 status
Android Android Build Status
iOS/tvOS/watchOS iOS Build Status
Linux Linux Build Status
macOS macOS Build Status
FreeBSD FreeBSD Build Status
Solaris Solaris Build Status

应用案例

  • 放置少女(HD):用于cocos和unity重制版客户端网络传输。
  • 红警OL手游项目:用于客户端网络传输,并且随着该项目于2018年10月17日由腾讯游戏发行正式上线后稳定运行于上千万移动设备上。
  • x-studio软件项目:网络解决方案。
  • QttAudio:语音连麦聊天集成方案。

集成案例

  • Unity
    • yasio_unity:Unity 纯C#封装,打开场景SampleScene运行即可。
    • xlua:将yasio集成到xlua, 打开场景U3DScripting运行即可。
  • UnrealEngine
  • axmol:作为axmol游戏引擎的网络解决方案。

文档

使用g++快速运行tcptest测试程序

g++ tests/tcp/main.cpp --std=c++11 -DYASIO_HEADER_ONLY -lpthread -I./ -o tcptest && ./tcptest

使用CMake编译yasio的测试程序和示例程序

git clone --recursive https://github.com/yasio/yasio
cd yasio

# 如果是macOS Xcode, 这里命令应该换成:cmake -B build -GXcode
cmake -B build

# 使用CMake命令行编译, 如果需要调试,则使用相应平台IDE打开即可:
# a. Windows:使用VisualStudio打开build/yasio.sln
# b. macOS:使用Xcode打开build/yasio.xcodeproj
cmake --build build --config Debug

# # 者直接用VS打开 

关于 build.ps1

  • 跨平台, 可以运行在 Windows, Linux, macOS

  • 所有Github CI使用该脚本

  • 支持选项

    • -p: 构建目标平台,支持: win32,winuwp,linux,android,osx,ios,tvos,watchos
    • -a: 构建目标平台CPU架构: x86,x64,arm,arm64
    • -cc: 构建C/C++编译器: clang, msvc, gcc, 默认空,使用当前宿主OS下可用编译器;
      对于Visual Studio还可以是 msvc-120, mvsc-140, mvsc-160,来明确指定使用VS哪个版本 msvc 进行编译
    • -xc: 额外的CMake参数,例如: -xc '-DCXX_STD=23','-DYASIO_ENABLE_EXT_HTTP=OFF'
  • 构建目标支持表

    构建宿主OS 构建目标平台 构建工具链
    Windows win32,winuwp msvc,clang,gcc
    Linux linux,android gcc,clang
    macOS osx,ios,tvos,watchos clang

特性:

  • 支持TCP,UDP,KCP传输,且API是统一的。
  • 支持TCP粘包处理,业务完全不必关心。ds
  • 支持组播。
  • 支持IPv4/IPv6或者苹果IPv6_only网络。
  • 支持处理多个连接的所有网络事件。
  • 支持微秒级定时器。
  • 支持Lua绑定。
  • 支持Cocos2d-x jsb绑定。
  • 支持CocosCreator jsb2.0绑定
  • 支持Unity3D
  • 支持虚幻引擎
  • 支持SSL客户端/服务端, 基于OpenSSL/MbedTLS。
  • 支持非阻塞域名解析,基于c-ares。
  • 支持Header Only集成方式,只需要定义编译预处理器宏YASIO_HEAD_ONLY=1即可。
  • 支持Unix Domain Socket。
  • 支持二进制读写,两个工具类obstream/ibstream非常方便使用。
  • 支持和.net兼容的整数压缩编码方式:7Bit Encoded Int/Int64

关于C++14/17/20

yasio提供了如下可在C++11编译器下使用的C++14/17/20标准库组件,请查看 yasio/string_view.hpp, yasio/shared_mutex.hpp, yasio/memory.hpp

  • cxx14::make_unique
  • cxx17::string_view
  • cxx17::shared_mutex
  • cxx20::starts_with
  • cxx20::ends_with

关于 OpenSSL 预编译库 (Windows)

yasio 的cmake脚本默认选择OpenSSL 作为SSL支持库,并且会自动从build1k下载, 且预编译库使用 VS2022(MSVC-14.37) 编译,如果你的系统未安装该版本,请传入CMake参数-DYASIO_SSL_BACKEND=2,例如使用项目 提供的跨平台一键编译脚本 build.ps1

powershell build.ps1 -p win32 -a x64 -xc "'-DYASIO_SSL_BACKEND=2'"

框架图

image

QQ交流群

点击加入:829884294