Documentation

Network API Reference

Read time 2 minutes Package: Nalix.Network
On this page

Namespaces: Nalix.Network.Connections, Nalix.Network.Listeners.Tcp, Nalix.Network.Listeners.Udp, Nalix.Network.Listeners.Web, Nalix.Network.Protocols, Nalix.Network.RateLimiting, Nalix.Network.Options
Assembly: Nalix.Network

Nalix.Network is the server-side transport engine. It manages raw TCP, UDP, and WebSocket sockets, enforces multi-layer admission and callback backpressure, maintains the sharded connection registry, and delivers framed payloads into IProtocol.

Master Transport Landscape

Architecture Diagram
flowchart TD
    subgraph Listeners["Layer 1: Listeners"]
        TCP["TcpListenerBase"]
        UDP["UdpListenerBase / UdpPassthroughListener"]
        WS["WebSocketListenerBase"]
    end

    subgraph Core["Layer 2: Connection & Registry"]
        Conn["Connection / WebSocketConnection / PassthroughConnection"]
        Hub["ConnectionHub (Sharded ConnectionRegistry)"]
    end

    subgraph Transport["Layer 3: Framed Socket I/O"]
        SC["SocketConnection (SAEA + Framing + Fragmentation)"]
        STCP["SocketTcpTransport"]
        SUDP["SocketUdpTransport"]
        WST["WebSocketTransport"]
    end

    subgraph Support["Layer 4: Guards & Timers"]
        TW["TimingWheel"]
        Lim["ConnectionGuard / DatagramGuard"]
        AC["AsyncCallback (Process / Post / High-Priority Lanes)"]
    end

    WS -->|Inherits| TCP
    Listeners -->|Accept / Resolve| Conn
    Conn -->|Registers in| Hub
    Conn -->|Owns| SC
    SC -->|Wrapped by| STCP
    Conn -->|Optional companion| SUDP
    Conn -->|WebSocket framing| WST
    SC -->|Dispatches via| AC
    TW -.->|Reaps idle| Conn
    Lim -.->|Gatekeeps| Listeners

Progressive Reading Order

  1. Socket Connection — Internal SAEA receive/send engine, length/VarInt framing, fragmentation, and Layer 1 pending-packet throttling.
  2. TCP Listener and UDP Listener — Socket activation, ConnectionGuard / DatagramGuard admission, PROXY protocol parsing, and 8-byte token + 4-byte MAC UDP authentication.
  3. Connection — High-level IConnection implementation owning identity (ConnectionId), cryptographic context (Secret, Algorithm), Attributes, and event bridges.
  4. Connection Hub — Sharded ConnectionRegistry (MIX64 hash sharding), zero-allocation snapshot broadcasting, and IReportable telemetry.
  5. Timing Wheel — Hashed wheel timer for low-overhead idle connection reaping.

Core Areas

Connection Subsystem

Protocols & Transport

Network Options