yasio - 輕量級跨平臺異步socket網絡庫

yasio 是一個輕量級跨平臺的異步socket庫，專注於客戶端和基於各種遊戲引擎的遊戲客戶端網絡服務, 支持win32 & linux & apple & android & win10-universal。

應用案例

• 紅警OL手遊項目: 用於客戶端網絡傳輸，並且隨着該項目於2018年10月17日由騰訊遊戲發行正式上線後穩定運行於上百萬移動設備上。
• x-studio軟件項目: 用於實現局域網UDP+TCP發現更新機制。
• xlua集成: 將yasio集成到xlua, 使基於xlua的unity3d可以直接使用yasio的lua綁定接口。

用法

C++

#include "yasio/yasio.hpp"
using namespace yasio;
using namespace yasio::inet;

int main()
{
  io_service service({"www.ip138.com", 80}); // 直接在網絡線程分派網絡事件
  service.set_option(YOPT_S_DEFERRED_EVENT, 0);
  service.start_service([&](event_ptr&& ev) {
    switch (ev->kind())
    {
      case YEK_PACKET: {
        auto packet = std::move(ev->packet());
        fwrite(packet.data(), packet.size(), 1, stdout);
        fflush(stdout);
        break;
      }
      case YEK_CONNECT_RESPONSE:
        if (ev->status() == 0)
        {
          auto transport = ev->transport();
          if (ev->cindex() == 0)
          {
            obstream obs;
            obs.write_bytes("GET /index.htm HTTP/1.1\r\n");

            obs.write_bytes("Host: www.ip138.com\r\n");

            obs.write_bytes("User-Agent: Mozilla/5.0 (Windows NT 10.0; "
                            "WOW64) AppleWebKit/537.36 (KHTML, like Gecko) "
                            "Chrome/79.0.3945.117 Safari/537.36\r\n");
            obs.write_bytes("Accept: */*;q=0.8\r\n");
            obs.write_bytes("Connection: Close\r\n\r\n");

            service.write(transport, std::move(obs.buffer()));
          }
        }
        break;
      case YEK_CONNECTION_LOST:
        printf("The connection is lost.\n");
        break;
    }
  });
  // open channel 0 as tcp client
  service.open(0, YCM_TCP_CLIENT);
  getchar();
}

Lua

local ip138 = "www.ip138.com"
local service = yasio.io_service.new({host=ip138, port=80})
local respdata = ""
-- 傳入網絡事件處理函數啓動網絡服務線程，網絡事件有: 消息包，連接響應，連接丟失
service.start_service(function(ev)
        local k = ev.kind()
        if (k == yasio.YEK_PACKET) then
            respdata = respdata .. ev:packet():to_string()
        elseif k == yasio.YEK_CONNECT_RESPONSE then
            if ev:status() == 0 then -- status爲0表示連接建立成功
                local transport = ev:transport()
                local obs = yasio.obstream.new()
                obs.write_bytes("GET / HTTP/1.1\r\n")

                obs.write_bytes("Host: " .. ip138 .. "\r\n")

                obs.write_bytes("User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.117 Safari/537.36\r\n")
                obs.write_bytes("Accept: */*;q=0.8\r\n")
                obs.write_bytes("Connection: Close\r\n\r\n")

                service.write(transport, obs)
            end
        elseif k == yasio.YEK_CONNECTION_LOST then
            print("request finish, respdata: " ..  respdata)
        end
    end)
-- 將信道0作爲TCP客戶端打開，並向服務器發起異步連接，進行TCP三次握手
service.open(0, yasio.YCM_TCP_CLIENT)

-- 由於lua_State和渲染對象，不支持在其他線程操作，因此分派網絡事件封裝爲全局Lua函數，並且以下函數應該在主線程或者遊戲引擎渲染線程調用
function gDispatchNetworkEvent(...)
    service.dispatch(128) -- 每幀最多處理128個網絡事件
end

_G.yservice = service -- Store service to global table as a singleton instance

使用g++快速運行tcptest測試程序

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

使用CMake編譯yasio的測試程序和示例程序

git clone https://github.com/yasio/yasio
cd yasio
git submodule update --init --recursive
cd build
cmake ..

# 使用CMake命令行編譯
# 或者直接用VS打開 yasio.sln 解決方案
cmake --build . --config Debug

特性:

• 支持IPv6_only網絡。
• 支持處理多個連接的所有網絡事件。
• 支持計時器。
• 支持TCP粘包處理，用戶完全不用關心。
• 支持Lua綁定。
• 支持Cocos2d-x jsb綁定。
• 支持CocosCreator jsb2.0綁定。
• 支持Unity3D C#綁定。
• 支持組播。
• 支持SSL客戶端，基於OpenSSL。
• 支持非阻塞域名解析，基於c-ares。

yasio核心設計，充分利用了多路io複用模型(服務器高併發的基石)，以下是框架圖

集成指導

https://github.com/yasio/yasio/wiki/Integrate-Guides

更多詳細用法，請查看 文檔

更新記錄

yasio-3.31.3 [stable] 更新

1. Optimize API io_service::write, add write raw buf support.
2. Fix issue: https://github.com/yasio/yasio/issues/2084
3. Fix issue: https://github.com/yasio/yasio/issues/2092