KcpTransport：高性能实时网络通信的C实现

KcpTransport：高性能实时网络通信的C#实现

KcpTransport KcpTransport is a Pure C# implementation of RUDP for high-performance real-time network communication 项目地址: https://gitcode.com/gh_mirrors/kc/KcpTransport

项目介绍

KcpTransport 是一个纯C#实现的RUDP（Reliable User Datagram Protocol）库，专为高性能实时网络通信设计。它提供了类似于 System.Net.Quic 的 KcpListener、KcpConnection 和 KcpStream，所有读写操作都基于流的方式进行，类似于TCP中的 NetworkStream。KcpTransport 提供了一个易于使用且现代的异步API，支持 async/await，并且未来计划实现对ASP.NET Kestrel Transport的支持，以便替换gRPC和MagicOnion的传输层。

项目技术分析

KcpTransport 基于KCP协议，KCP是一种高效的可靠UDP传输协议，广泛应用于需要实时性能的场景，如游戏、音视频传输等。KCP本身没有系统调用，因此可以完全在C#中实现，并利用.NET最新的UDP Socket改进和 async/await 支持。

KcpTransport 实现了Syn Cookie握手、连接管理、不可靠通信和KeepAlive等功能，未来还将支持加密。它目前仅支持 .NET 8，但计划未来支持 .NET Standard 2.1 和 Unity。

项目及技术应用场景

KcpTransport 适用于以下场景：

• 实时游戏：需要低延迟和高可靠性的网络通信。
• 音视频传输：需要快速传输和重传机制的应用。
• 分布式系统：需要高效可靠的点对点通信。
• IoT设备：需要轻量级且高效的通信协议。

项目特点

1. 高性能：基于KCP协议，提供高效的可靠UDP传输。
2. 纯C#实现：无需依赖外部库，完全在C#中实现。
3. 现代异步API：支持 async/await，简化异步编程。
4. 流式操作：所有读写操作基于流，类似于TCP的 NetworkStream。
5. 多平台支持：未来计划支持 .NET Standard 2.1 和 Unity。
6. 低延迟：适用于需要实时性能的应用场景。

快速开始

KcpTransport 通过NuGet分发，当前仅支持 .NET 8。你可以通过以下命令安装：

PM> Install-Package KcpTransport

在服务器端，使用 KcpListener.ListenAsync 来生成连接；在客户端，使用 KcpConnection.ConnectAsync 来连接服务器。通过 OpenOutboundStreamAsync 获取用于读写操作的 Stream。

using KcpTransport;
using System.Text;

var server = RunEchoServer();
var client = RunEchoClient();

await await Task.WhenAny(server, client);

static async Task RunEchoServer()
{
    var listener = await KcpListener.ListenAsync("127.0.0.1", 11000);

    while (true)
    {
        var connection = await listener.AcceptConnectionAsync();
        ConsumeClient(connection);
    }

    static async void ConsumeClient(KcpConnection connection)
    {
        using (connection)
        using (var stream = await connection.OpenOutboundStreamAsync())
        {
            try
            {
                var buffer = new byte[1024];
                while (true)
                {
                    var len = await stream.ReadAsync(buffer);
                    var str = Encoding.UTF8.GetString(buffer, 0, len);
                    Console.WriteLine("Server Request  Received: " + str);
                    await stream.WriteAsync(Encoding.UTF8.GetBytes(str));
                }
            }
            catch (KcpDisconnectedException)
            {
                Console.WriteLine($"Disconnected, Id:{connection.ConnectionId}");
            }
        }
    }
}

static async Task RunEchoClient()
{
    using var connection = await KcpConnection.ConnectAsync("127.0.0.1", 11000);
    using var stream = await connection.OpenOutboundStreamAsync();

    var buffer = new byte[1024];
    while (true)
    {
        Console.Write("Input Text:");
        var inputText = Console.ReadLine();
        await stream.WriteAsync(Encoding.UTF8.GetBytes(inputText!));
        var len = await stream.ReadAsync(buffer);
        var str = Encoding.UTF8.GetString(buffer, 0, len);
        Console.WriteLine($"Client Response Received: " + str);
    }
}

配置选项

KcpListener 和 KcpConnection 在创建时可以传递选项进行配置，例如：

var listener = await KcpListener.ListenAsync(new KcpListenerOptions
{
    ListenEndPoint = new IPEndPoint(IPAddress.Parse("127.0.0.1"), listenPort),
    EventLoopCount = 1,
    KeepAliveDelay = TimeSpan.FromSeconds(10),
    ConnectionTimeout = TimeSpan.FromSeconds(20),
});

低级API

KcpTransport 还提供了低级API，直接使用 ikcp.c 和 ikcp.h 中定义的方法。通过 KcpTransport.LowLevel.KcpMethods，你可以直接调用 ikcp_*** 函数。

using KcpTransport;
using KcpTransport.LowLevel;
using System.Diagnostics;
using System.Runtime.InteropServices;
using System.Text;
using static KcpTransport.LowLevel.KcpMethods;

public class SampleLowLevel : IDisposable
{
    GCHandle user;
    unsafe IKCPCB* kcp;
    bool isDisposed;
    readonly long startingTimestamp;

    public unsafe SampleLowLevel(uint conversationId, delegate* managed<byte*, int, IKCPCB*, void*, int> output, object user)
    {
        this.user = GCHandle.Alloc(this);
        this.kcp = ikcp_create(conv: conversationId, user: (void*)GCHandle.ToIntPtr(this.user));
        ikcp_setoutput(kcp, output);
        this.startingTimestamp = Stopwatch.GetTimestamp();
        Update();
    }

    public unsafe int Send(ReadOnlySpan<byte> data)
    {
        fixed (byte* ptr = data)
        {
            return ikcp_send(kcp, ptr, data.Length);
        }
    }

    public unsafe int InputData(ReadOnlySpan<byte> data)
    {
        fixed (byte* ptr = data)
        {
            return ikcp_input(kcp, ptr, data.Length);
        }
    }

    public unsafe int PeekSize()
    {
        return ikcp_peeksize(kcp);
    }

    public unsafe int ReceiveData(Span<byte> buffer)
    {
        fixed (byte* ptr = buffer)
        {
            return ikcp_recv(kcp, ptr, buffer.Length);
        }
    }

    public unsafe void Update()
    {
        var elapsed = Stopwatch.GetElapsedTime(startingTimestamp);
        var currentTimestamp = (uint)(elapsed.TotalMilliseconds * 1000);
        ikcp_update(kcp, currentTimestamp);
    }

    public void Dispose()
    {
        if (!isDisposed)
        {
            isDisposed = true;
            unsafe
            {
                ikcp_release(kcp);
            }
            user.Free();
        }
    }
}

KcpTransport 是一个强大的工具，适用于需要高性能实时网络通信的场景。无论是游戏开发、音视频传输还是分布式系统，KcpTransport 都能为你提供稳定、高效的解决方案。赶快尝试一下吧！

KcpTransport KcpTransport is a Pure C# implementation of RUDP for high-performance real-time network communication 项目地址: https://gitcode.com/gh_mirrors/kc/KcpTransport