Nalix.SDK

Nalix.SDK là gói transport phía client cấp 3 để kết nối các ứng dụng .NET 10 (console, desktop, di động, hoặc client Unity/Godot) với máy chủ Nalix qua TCP hoặc UDP.

Luồng kết nối client#

flowchart TD
    A["TransportOptions"] --> B["TcpSession / UdpSession"]
    B --> C["ConnectAsync()"]
    C --> D["ConnectWithResumeAsync() / HandshakeAsync()"]
    D --> E["OnReady Fired & KeepAlive Started"]
    E --> F["SendAsync() / RequestAsync<TResponse>() / Subscribe<T>()"]

Thành phần cốt lõi#

• TransportSession — Lớp cơ sở trừu tượng triển khai ITransportSession, State (SessionState), WaitUntilReadyAsync, OnConnected, OnReady, OnDisconnected, OnMessageReceived, OnError, probe keepalive và ghép cặp các request đang chờ.
• TcpSession — Phiên client TCP có khung, dùng pool SocketAsyncEventArgs và hỗ trợ kết nối lại tự động.
• UdpSession — Phiên datagram UDP đi kèm hoặc độc lập, tự động thêm token phiên 8 byte (SessionToken) đã thương lượng qua TCP.
• SessionState — Trạng thái runtime tạm thời (Secret, SessionToken, EncryptionEnabled, LocalPort), tách khỏi TransportOptions bền vững.
• Mở rộng transport (Nalix.SDK.Transport.Extensions):
  • HandshakeExtensions (HandshakeAsync)
  • ResumeExtensions (ResumeSessionAsync, ConnectWithResumeAsync)
  • RequestExtensions (RequestAsync<TResponse>, TryRequestAsync<TResponse>, CallAsync<TResponse>)
  • StreamExtensions (StreamAsync<TResponse>)
  • ControlExtensions & PingExtensions (NewControl, SendControlAsync, AwaitControlAsync, PingAsync, SyncTimeAsync)
  • CipherExtensions & RekeyExtensions (UpdateCipherAsync, RekeyAsync)
  • TransportSessionSubscriptions (On<TPacket>, OnExact<TPacket>, Subscribe(params IDisposable[]))
• Phân phối luồng (Nalix.SDK.Dispatch) — IThreadDispatcher và InlineDispatcher để chuyển gói tin nhận được sang luồng chính của game engine hoặc UI.
• Sinh client RPC có kiểu ([RpcService]) — RpcClientGenerator tự động sinh các triển khai <ServiceName>_RpcClient được phân giải qua session.CreateRpcClient<TService>() cho các interface có chú thích [RpcService].

Ví dụ nhanh#

using Nalix.SDK.Options;
using Nalix.SDK.Transport;
using Nalix.SDK.Transport.Extensions;

TransportOptions options = new()
{
    Address = "127.0.0.1",
    Port = 57206,
    AutoReconnectEnabled = true
};

using TcpSession client = new(options);
client.OnConnected += (_, _) => Console.WriteLine("Socket connected");
client.OnReady += (_, _) => Console.WriteLine("Handshake/resume complete");
client.OnDisconnected += (_, ex) => Console.WriteLine($"Disconnected: {ex?.Message}");

await client.ConnectAsync();
await client.HandshakeAsync(); // Thương lượng bí mật phiên X25519 và bật mã hóa

MyResponsePacket reply = await client.RequestAsync<MyResponsePacket>(
    new MyRequestPacket(),
    RequestOptions.Default.WithTimeout(5_000).WithEncrypt());

await client.DisconnectAsync();

Tham chiếu TransportOptions (Nalix.SDK.Options)#

TransportOptions kế thừa từ ConfigurationLoader và có thể được khởi tạo trực tiếp trong mã hoặc nạp từ INI qua ConfigurationManager.Instance.Get<TransportOptions>().

Tham chiếu RequestOptions (Nalix.SDK.Options)#

Trang API chính#

• Transport Session
• TCP Session
• Handshake Extensions
• Resume Extensions
• Session Extensions
• Cipher Extensions
• Request Options
• Chẩn đoán phiên
• Phân phối luồng