NetConduit.WebSocket 1.1.4

NetConduit

Transport-agnostic stream multiplexer for .NET. Creates multiple virtual channels over a single bidirectional stream.

N streams → 1 stream (mux) → N streams (demux)

Features

• Multiple channels over a single TCP/WebSocket/any stream connection
• Credit-based backpressure for flow control
• Priority queuing - higher priority frames sent first
• Auto-reconnection with channel state restoration
• Native AOT compatible - no reflection in core
• Modern .NET - targets .NET 8, 9, and 10

Installation

# Core package
dotnet add package NetConduit

# TCP transport helper
dotnet add package NetConduit.Tcp

# WebSocket transport helper  
dotnet add package NetConduit.WebSocket

Quick Start

TCP Server

using NetConduit;
using NetConduit.Tcp;

// Accept a TCP connection
var connection = await TcpMultiplexer.AcceptAsync(listener);
var runTask = await connection.StartAsync();

// Accept channels from clients
await foreach (var channel in connection.Multiplexer.AcceptChannelsAsync())
{
    // Each channel is a Stream - read data
    var buffer = new byte[1024];
    var bytesRead = await channel.ReadAsync(buffer);
    Console.WriteLine($"Received on {channel.ChannelId}: {Encoding.UTF8.GetString(buffer, 0, bytesRead)}");
}

TCP Client

using NetConduit;
using NetConduit.Tcp;

// Connect to server
var connection = await TcpMultiplexer.ConnectAsync("localhost", 5000);
var runTask = await connection.StartAsync();

// Open a channel and send data
var channel = await connection.Multiplexer.OpenChannelAsync(
    new ChannelOptions { ChannelId = "my-channel" });

await channel.WriteAsync(Encoding.UTF8.GetBytes("Hello, Server!"));
await channel.DisposeAsync();  // Sends FIN, closes channel gracefully

WebSocket

using NetConduit;
using NetConduit.WebSocket;

// Client
var connection = await WebSocketMultiplexer.ConnectAsync("ws://localhost:5000/ws");
var runTask = await connection.StartAsync();

// Server (ASP.NET Core)
app.MapGet("/ws", async (HttpContext context) =>
{
    var webSocket = await context.WebSockets.AcceptWebSocketAsync();
    var connection = WebSocketMultiplexer.Accept(webSocket);
    var runTask = await connection.StartAsync();
    // ...
});

Core Concepts

Channels

Channels are simplex (one-way) streams:

• WriteChannel: Opened by this side for sending data
• ReadChannel: Accepted from remote side for receiving data

For bidirectional communication, open two channels:

// Side A opens a channel - gets WriteChannel
var sendChannel = await muxA.OpenChannelAsync(new() { ChannelId = "A-to-B" });

// Side B accepts it - gets ReadChannel  
var receiveChannel = await muxB.AcceptChannelAsync("A-to-B");

// For reverse direction, Side B opens another channel
var reverseSend = await muxB.OpenChannelAsync(new() { ChannelId = "B-to-A" });
var reverseReceive = await muxA.AcceptChannelAsync("B-to-A");

Raw Stream Usage

Channels inherit from Stream, so they work with any streaming API:

// Open a channel
var channel = await mux.OpenChannelAsync(new() { ChannelId = "data" });

// Use as Stream - works with StreamReader/Writer, CopyToAsync, etc.
using var writer = new StreamWriter(channel);
await writer.WriteLineAsync("Hello!");
await writer.FlushAsync();

Priority

Set channel priority at open time (0-255, higher = higher priority):

// Control messages - highest priority
var controlChannel = await mux.OpenChannelAsync(new() 
{ 
    ChannelId = "control",
    Priority = ChannelPriority.Highest  // 255
});

// Bulk data - lower priority
var dataChannel = await mux.OpenChannelAsync(new() 
{ 
    ChannelId = "bulk-data",
    Priority = ChannelPriority.Low  // 64
});

Backpressure

Adaptive credit-based flow control prevents fast senders from overwhelming slow receivers:

var options = new ChannelOptions
{
    ChannelId = "controlled",
    MinCredits = 64 * 1024,            // 64KB minimum buffer
    MaxCredits = 4 * 1024 * 1024,      // 4MB maximum buffer (starts here)
    CreditGrantThreshold = 0.5,        // Auto-grant when 50% consumed
    SendTimeout = TimeSpan.FromSeconds(30)  // Timeout if credits exhausted
};

var channel = await mux.OpenChannelAsync(options);

Transits

Transits add semantic meaning to channels. Use extension methods on the multiplexer for easy creation:

using NetConduit.Transits;

// Open a write-only stream
var writeStream = await mux.OpenStreamAsync("upload");

// Accept a read-only stream
var readStream = await mux.AcceptStreamAsync("download");

// Open a duplex stream with single channel ID
// Creates "chat>>" for writing and accepts "chat<<" for reading
var duplex = await mux.OpenDuplexStreamAsync("chat");

// Or specify separate channel IDs
var duplex2 = await mux.OpenDuplexStreamAsync("my-out", "their-out");

// Open a message transit with single channel ID
// Creates "rpc>>" for sending and accepts "rpc<<" for receiving
var transit = await mux.OpenMessageTransitAsync<Request, Response>(
    "rpc",
    MyContext.Default.Request,
    MyContext.Default.Response);

MessageTransit - Send/receive JSON messages

using NetConduit.Transits;
using System.Text.Json.Serialization;

// Define message types with AOT-compatible serialization
public record ChatMessage(string User, string Text);

[JsonSerializable(typeof(ChatMessage))]
public partial class ChatContext : JsonSerializerContext { }

// Create transit with single channel ID (uses "chat>>" and "chat<<")
var transit = await mux.OpenMessageTransitAsync<ChatMessage, ChatMessage>(
    "chat",
    ChatContext.Default.ChatMessage,
    ChatContext.Default.ChatMessage);

// Send/receive messages
await transit.SendAsync(new ChatMessage("Alice", "Hello!"));
var msg = await transit.ReceiveAsync();
Console.WriteLine($"{msg.User}: {msg.Text}");

DuplexStreamTransit - Bidirectional stream

// Open duplex stream with single channel ID (uses "data>>" and "data<<")
var duplex = await mux.OpenDuplexStreamAsync("data");

// Use with any Stream API
await duplex.WriteAsync(data);
var bytesRead = await duplex.ReadAsync(buffer);

StreamTransit - Simplex stream

// Open/accept streams directly from multiplexer
var writeStream = await mux.OpenStreamAsync("upload");
var readStream = await mux.AcceptStreamAsync("download");

Reconnection

NetConduit supports automatic reconnection with channel state restoration:

var options = new MultiplexerOptions
{
    EnableReconnection = true,
    ReconnectTimeout = TimeSpan.FromSeconds(60),
    ReconnectBufferSize = 1024 * 1024  // 1MB buffer for pending data
};

var mux = new StreamMultiplexer(stream, stream, options);

mux.OnDisconnected += () => Console.WriteLine("Disconnected, waiting for reconnect...");
mux.OnReconnected += () => Console.WriteLine("Reconnected!");

// After network disruption, reconnect with new streams
await mux.ReconnectAsync(newReadStream, newWriteStream);

Configuration

MultiplexerOptions

ChannelOptions

Statistics

// Multiplexer stats
var stats = mux.Stats;
Console.WriteLine($"Bytes sent: {stats.BytesSent}");
Console.WriteLine($"Open channels: {stats.OpenChannels}");
Console.WriteLine($"Last ping RTT: {stats.LastPingRtt}");

// Per-channel stats
var channelStats = channel.Stats;
Console.WriteLine($"Channel bytes: {channelStats.BytesSent}");

Samples

The repository includes complete sample applications:

Run samples:

# Chat server
cd samples/NetConduit.Samples.ChatCli
dotnet run -- server 5000 Alice

# Chat client (another terminal)
dotnet run -- client 5000 localhost Bob

Architecture

┌──────────────────────────────────────────────────────────────┐
│                         Application                          │
├──────────────────────────────────────────────────────────────┤
│  Transit Layer (Optional)                                    │
│  ┌────────────────┐  ┌────────────────┐  ┌────────────────┐  │
│  │ MessageTransit │  │ StreamTransit  │  │ DuplexStream   │  │
│  └───────┬────────┘  └───────┬────────┘  └───────┬────────┘  │
├──────────┴───────────────────┴───────────────────┴───────────┤
│                         NetConduit                           │
│  - Frame encoding/decoding (9-byte header)                   │
│  - Channel management (string ChannelId)                     │
│  - Credit-based backpressure                                 │
│  - Priority queuing                                          │
│  - Ping/pong heartbeat                                       │
│  - GOAWAY graceful shutdown                                  │
├──────────────────────────────────────────────────────────────┤
│  Transport Layer                                             │
│  ┌────────────────┐  ┌────────────────┐  ┌────────────────┐  │
│  │ NetConduit.Tcp │  │ NetConduit.WS  │  │  Any Stream    │  │
│  └────────────────┘  └────────────────┘  └────────────────┘  │
└──────────────────────────────────────────────────────────────┘

Frame Format

┌─────────────────────────────────────────────────────────────┐
│ Channel Index (4B) │ Flags (1B) │ Length (4B) │ Payload     │
└─────────────────────────────────────────────────────────────┘

• 9-byte header, big-endian encoding
• Max 16MB payload (configurable)
• Frame types: DATA, INIT, FIN, ACK, ERR

Performance

NetConduit uses several techniques for high performance:

• System.IO.Pipelines for zero-copy reads
• ArrayPool<byte> for buffer reuse
• Channel<T> for lock-free queuing
• stackalloc for header serialization
• BinaryPrimitives for fast encoding

Benchmarks

Raw TCP vs Multiplexed TCP Comparison

Compares N separate TCP connections (Raw TCP) vs 1 TCP connection with N multiplexed channels (Mux TCP):

*Raw TCP fails at 1000 connections × 1MB due to socket exhaustion (OS ephemeral port limits)

Key Insights:

• Low channel counts (1-10): Near parity performance, Mux adds minimal overhead (~1.02-1.52x)
• High channel counts (1000): Mux outperforms Raw TCP by 14-15% due to connection pooling efficiency
• Resource efficiency: Mux uses 1 TCP connection vs N connections, drastically reducing OS overhead
• Extreme concurrency: At 100+ channels with 1MB data, Raw TCP hits OS socket limits while Mux's single-connection design avoids this
• Trade-off: Small overhead at low counts, significant advantage at high counts
• Best use cases: Mux excels when you need many logical streams over limited connections (WebSocket, mobile, firewalls, NAT traversal)

Running Benchmarks

cd benchmarks/NetConduit.Benchmarks
dotnet run -c Release

Available benchmark classes:

• TcpVsMuxBenchmark - Direct Raw TCP vs Multiplexed comparison
• ThroughputBenchmark - Throughput with varying channel counts and data sizes
• ScalabilityBenchmark - Scalability across different scenarios

License

MIT License - see LICENSE for details.

Contributing

Contributions welcome! Please read our contributing guidelines before submitting PRs.