GameFrameX.SuperSocket.WebSocket 1.3.0

<div align="center">

<img src="https://download.alianblank.com/gameframex/gameframex_logo_320.png" alt="Game Frame X Logo" width="160" />

GameFrameX.SuperSocket

All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams

<br />

Documentation · Quick Start · QQ Group: 467608841 / 233840761

<br />

English | 简体中文 | 繁體中文 | 日本語 | 한국어

</div>

Project Overview

GameFrameX.SuperSocket is the GameFrameX maintained fork of SuperSocket — a light weight extensible socket application framework written in pure C#. You can use it to build an always connected socket application easily without thinking about how to use socket, how to maintain the socket connections and how socket works.

The upstream architecture and public APIs are preserved, so a project written against SuperSocket keeps working. On top of that this fork carries the changes GameFrameX game servers need: the .NET 10 build target, DI/constructor injection support, and the KCP / ReliableSession protocol adaptations for weak-network game traffic.

Features

• Light weight and extensible — build always connected socket applications without managing sockets by hand.
• Pure C#, so it integrates into any existing .NET system.
• Protocol decoding pipeline with pipeline filters and package decoders.
• TCP is the default transport; UDP, KCP and ReliableSession are explicit opt-ins.
• KCP transport for reliable delivery over UDP datagrams, with retransmission and window control.
• ReliableSession protocol frame contract and binary codec for logical session resume, replay cursors, ack ranges, snapshot fallback and close/error frames.
• Command pattern request handling.
• WebSocket server and client, plus Kestrel integration.
• DI / constructor injection friendly host builder.
• .NET 10 build target.

Quick Start

Installation

Install the modules you need from NuGet.org:

dotnet add package GameFrameX.SuperSocket.Server
dotnet add package GameFrameX.SuperSocket.ProtoBase

The Kcp and ReliableSession modules come with the next release; until then, build them from a source checkout:

git clone https://github.com/GameFrameX/GameFrameX.SuperSocket.git
cd GameFrameX.SuperSocket
dotnet build GameFrameX.SuperSocket.slnx

Run the test suite from the same checkout:

dotnet test GameFrameX.SuperSocket.slnx
dotnet test test/GameFrameX.SuperSocket.ReliableSession.Tests/GameFrameX.SuperSocket.ReliableSession.Tests.csproj

Usage Examples

Transport Selection

TCP remains the default transport. UDP, KCP, and ReliableSession are explicit choices:

Server: Enable KCP

Reference GameFrameX.SuperSocket.Kcp, keep your normal package pipeline and handler, then add UseKcp(...) to the host builder:

using System.Text;
using GameFrameX.SuperSocket.Kcp;
using GameFrameX.SuperSocket.ProtoBase;
using GameFrameX.SuperSocket.Server.Host;

var builder = SuperSocketHostBuilder
    .Create<TextPackageInfo, LinePipelineFilter>()
    .UseKcp(options =>
    {
        // Unset nullable options keep KCP's internal defaults.
        options.NoDelay = true;
        options.NoDelayLevel = 1;
        options.Interval = 10;
        options.Resend = 2;
        options.NoCongestionControl = true;
        options.SendWindow = 512;
        options.ReceiveWindow = 512;
        options.MaxDatagramSize = 4096;

        // Raise this explicitly when you expect minute-level packet blackout.
        options.DeadLink = 120;
    })
    .UsePackageHandler(async (session, package) =>
    {
        // Handle the decoded SuperSocket package exactly as you do on TCP.
        await session.SendAsync(Encoding.UTF8.GetBytes(package.Text + "\r\n"));
    });

UseKcp(...) registers the KCP listener/factory and the default in-process session container when one has not already been registered. The default KCP server session identity is built from the remote endpoint plus the KCP Conv read from the incoming UDP packet. Endpoint/NAT migration is therefore not supported by the KCP transport layer alone.

Client: Use KCP

Reference GameFrameX.SuperSocket.Kcp, configure EasyClient with AsKcp(...), and then use the normal receive/send APIs on the client:

using System.Net;
using System.Text;
using GameFrameX.SuperSocket.Client;
using GameFrameX.SuperSocket.Kcp;
using GameFrameX.SuperSocket.ProtoBase;

var remoteEndPoint = new IPEndPoint(IPAddress.Loopback, 4040);
var client = new EasyClient<TextPackageInfo>(new LinePipelineFilter());

client.AsKcp(remoteEndPoint, new KcpConnectionOptions
{
    // Conv = 0 lets the client generate a non-zero conversation id.
    Conv = 0,
    NoDelay = true,
    NoDelayLevel = 1,
    Interval = 10,
    Resend = 2,
    MaxDatagramSize = 4096
});

client.StartReceive();
await ((IEasyClient)client).SendAsync(Encoding.UTF8.GetBytes("ping\r\n"));

AsKcp(...) creates and binds a UDP socket, assigns or generates Conv, creates a KcpPipeConnection, starts the KCP update loop, and starts receiving UDP packets for that connection. Set client.LocalEndPoint before AsKcp(...) when the client must bind a specific local UDP endpoint.

KCP Configuration Notes

• Leave nullable options unset unless you have a measured reason to tune them; unset values keep KCP internal defaults.
• For realtime game-style traffic, common starting points are NoDelay = true, NoDelayLevel = 1, Interval = 10, Resend = 2, and tuned send/receive windows.
• For conservative throughput, keep more defaults and avoid disabling congestion control.
• DeadLink is the maximum retransmission count for one KCP segment. The internal default is not a minute-level blackout policy; raise it deliberately when your acceptance condition requires longer blackout tolerance.
• IdleTimeout belongs to the connection lifetime layer. It is not a logical session recovery window.
• MaxDatagramSize should fit your network MTU strategy. Oversized UDP datagrams raise fragmentation and loss risk.

ReliableSession Protocol Model

Reference GameFrameX.SuperSocket.ReliableSession when you need the protocol frame contract and binary codec:

using System.Text;
using GameFrameX.SuperSocket.ReliableSession;

var codec = new ReliableSessionFrameCodec();
var sessionId = new SessionId(Guid.NewGuid());

var hello = new ReliableSessionHelloFrame
{
    ClientInstanceId = new ClientInstanceId(Guid.NewGuid()),
    ProtocolVersion = ReliableSessionProtocol.WireVersion,
    RequestedOptions = new ReliableSessionHandshakeOptions
    {
        HeartbeatInterval = TimeSpan.FromSeconds(5),
        HeartbeatTimeout = TimeSpan.FromSeconds(15),
        RecoveryWindow = TimeSpan.FromMinutes(2),
        ReplayWindowSize = 1024
    }
};

var helloBytes = codec.Encode(hello);
var decodedHello = (ReliableSessionHelloFrame)codec.Decode(helloBytes);

var data = new ReliableSessionDataFrame
{
    SessionId = sessionId,
    MessageId = new MessageId(1),
    Sequence = new Sequence(1),
    Payload = Encoding.UTF8.GetBytes("move:1,2")
};

var dataBytes = codec.Encode(data);
var decodedData = (ReliableSessionDataFrame)codec.Decode(dataBytes);

var ack = new ReliableSessionAckFrame
{
    SessionId = sessionId,
    Ranges = new[] { new AckRange(new Sequence(1), new Sequence(1)) }
};

var ackBytes = codec.Encode(ack);
var decodedAck = (ReliableSessionAckFrame)codec.Decode(ackBytes);

ReliableSession currently defines and validates these frame kinds: Hello, HelloAck, Resume, ResumeAck, Heartbeat, Data, Ack, SnapshotRequest, Snapshot, Close, and Error. The codec expects one complete ReliableSession frame per buffer; transport stream splitting/framing belongs in a later adapter.

Current boundaries:

• No server/client runtime switch enables ReliableSession yet.
• No automatic heartbeat timer, reconnect loop, resume-token store, replay cache, dedup cache, or snapshot provider is included yet.
• KCP keeps using endpoint plus Conv as its transport session identity. ReliableSession's SessionId plus ResumeToken is the future logical-session resume contract, not current KCP endpoint migration support.
• C3 test coverage is protocol/codec end-to-end coverage, including lifecycle, 10s/30s/60s blackout resume scripts, replay, snapshot fallback, duplicate/reordered frames, and ack ranges. It is not runtime transport integration coverage.

Architecture

The modules layer from protocol primitives up to the host:

• Primitives / ProtoBase — primitive interfaces and protocol decoding.
• Connection / Channel — the underlying communications abstraction and the request pipeline.
• Server / Server.Abstractions / Client / ClientEngine / Client.Proxy — host, server and client endpoints.
• Command — command pattern request handling on top of the server.
• Udp / Kcp / ReliableSession — the optional transports and the logical session protocol.
• WebSocket / WebSocket.Server / Kestrel / Http — HTTP-family protocols and hosting.

Platform Support

• .NET 10.0
• Windows, macOS, Linux

Dependencies

Beyond the .NET base class library, the modules depend on Microsoft.Extensions.* (Configuration, DependencyInjection, Hosting, Logging, Options), System.IO.Pipelines, and the Microsoft.AspNetCore.App framework reference for the Kestrel module.

Documentation & Resources

• Documentation
• GitHub Repository
• Issue Tracker
• Upstream Project
• Upstream Documentation

Community & Support

<img src="https://cdn.jsdelivr.net/npm/devicon@2/icons/linkedin/linkedin-original.svg" height="28" alt="LinkedIn" />

Changelog

See Releases for the version history.

License

See LICENSE for license information.