LoguxNET.Server.AspNet 1.0.0

LoguxNET.Server.AspNet

Русская версия

ASP.NET Core integration for the Logux server. Provides DI registration, WebSocket middleware, and a BackgroundService engine loop.

Target Framework

net10.0

Structure

LoguxNET.Server.AspNet/
├── LoguxOptions.cs                         Configuration (server + ASP.NET)
├── ILoguxAuthHandler.cs                    Authentication interface
├── ILoguxActionHandler.cs                  Action authorize / process / resend interface
├── ILoguxChannelHandler.cs                 Channel authorize / load interface
├── LoguxConnectionManager.cs               Command queue + Handle↔WebSocket registry
├── LoguxEngineService.cs                   BackgroundService engine loop
├── LoguxWebSocketMiddleware.cs             WebSocket upgrade + read loop
├── EngineCommand.cs                        Internal command types
├── LoguxServiceCollectionExtensions.cs     AddLogux() extension
└── LoguxApplicationBuilderExtensions.cs    UseLogux() extension

Setup

1. Register Services

builder.Services.AddLogux(opts =>
{
    opts.ServerNodeId   = "server:myapp:1";
    opts.Path           = "/logux";       // WebSocket endpoint
    opts.TickIntervalMs = 10;             // engine tick interval
    opts.PingIntervalMs = 5000;
    opts.TimeoutMs      = 10000;
    opts.MaxConnections = 0;              // unlimited
});

2. Implement Handlers

Register all three as singletons in DI:

builder.Services.AddSingleton<ILoguxAuthHandler, MyAuthHandler>();
builder.Services.AddSingleton<ILoguxActionHandler, MyActionHandler>();
builder.Services.AddSingleton<ILoguxChannelHandler, MyChannelHandler>();

3. Add Middleware

app.UseWebSockets();
app.UseLogux();

Handler Interfaces

ILoguxAuthHandler

public interface ILoguxAuthHandler
{
    bool Authenticate(LoguxHandle connection, string nodeId, string token);
}

Called on every connect message. Return true to accept, false to reject.

ILoguxActionHandler

public interface ILoguxActionHandler
{
    bool Authorize(LoguxHandle connection, string actionJson);
    void Process(LoguxHandle connection, string actionJson);
    string? Resend(LoguxHandle connection, string actionJson);
}

ILoguxChannelHandler

public interface ILoguxChannelHandler
{
    bool Authorize(LoguxHandle connection, string channel);
    int Load(LoguxHandle connection, string channel);
}

LoguxOptions

Architecture

  ASP.NET ThreadPool                    Engine Thread (BackgroundService)
  ──────────────────                    ────────────────────────────────
  WS Middleware 1 ──┐                          ┌──► logux_connection_accept()
  WS Middleware 2 ──┤── Channel<Command> ──►   ├──► logux_feed_data()
  WS Middleware N ──┘                          ├──► logux_connection_close()
                                               ├──► logux_tick()
                                               └──► logux_poll_outbound()
                                                        │
                          ┌─────────────────────────────┘
                          ▼
                     ws.SendAsync() (routed by LoguxHandle)

• WebSocket middleware upgrades connections at the configured Path, reads frames, and enqueues EngineCommand items into a Channel<T>.
• LoguxEngineService (BackgroundService) drains the command channel, calls the clogux engine, and routes outbound messages back to WebSocket connections via LoguxConnectionManager.
• WaitToReadAsync with TickIntervalMs timeout ensures low latency on new data while still processing pings/timeouts periodically.

Full Example

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddLogux(opts =>
{
    opts.ServerNodeId = "server:chat:1";
    opts.Path = "/logux";
});
builder.Services.AddSingleton<ILoguxAuthHandler, ChatAuthHandler>();
builder.Services.AddSingleton<ILoguxActionHandler, ChatActionHandler>();
builder.Services.AddSingleton<ILoguxChannelHandler, ChatChannelHandler>();

var app = builder.Build();
app.UseWebSockets();
app.UseLogux();
app.Run();

// --- Handlers ---

class ChatAuthHandler : ILoguxAuthHandler
{
    public bool Authenticate(LoguxHandle conn, string nodeId, string token)
        => token == "secret";
}

class ChatActionHandler : ILoguxActionHandler
{
    public bool Authorize(LoguxHandle conn, string json) => true;
    public void Process(LoguxHandle conn, string json) { /* save to DB */ }
    public string? Resend(LoguxHandle conn, string json) => "chat";
}

class ChatChannelHandler : ILoguxChannelHandler
{
    public bool Authorize(LoguxHandle conn, string channel) => true;
    public int Load(LoguxHandle conn, string channel) => 0;
}