SocketCommand.Abstractions 1.0.6

⚡ SocketCommand

SocketCommand is a modern, extensible NuGet package that makes socket-based command communication simple and powerful in .NET applications.

Built on top of .NET hosting, it supports:

• 🔁 Command-based duplex communication
• 🧱 Entity serialization
• 🔒 AES encryption
• 📦 Compression
• 📡 UDP-based peer discovery
• 💉 Dependency Injection-friendly design

📦 Installation

SocketCommand consists of two packages:

Install via NuGet:

dotnet add package SocketCommand.Hosting
dotnet add package SocketCommand.Abstractions
dotnet add package SocketCommand.Compression.7Zip

⚙️ Configuration

Define your settings in appsettings.json:

{
  "SocketCommand": {
    "Port": 5000,
    "BufferSize": 1024,
    "UdpPort": 5052,
    "UdpSecret": "s3cr3t!",
    "AESKey": "jiwlQEjVDC67rIbte8n0XoZZzgXE4cSnRlj81YZaAf4=",
    "AESIV": "ivgVH9nmCwAafSK2jhyA1Q=="
  }
}

💄 Decorating Entities

Entities that are to be used as commands or responses must be decorated with the SocketCommandAttribute and OrderAttribute. The order attribute must batch on entities on both ends.

[SocketMessage]
public class TestEntity
{
    [Order(1)]
    public int Id { get; set; }

    [Order(2)]
    public string Name { get; set; }
}

🚀 Usage

Host Initialization

var builder = Host.CreateApplicationBuilder(args);

builder.AddSocketCommand()
    .With7ZipCompression()
    .WithAESEncryption()
    .WithCommand("ping", async (ISocketManager caller) =>
    {
        Console.WriteLine("ping");
        await caller.Send("ping");
    });

await builder.Build().StartAsync();

Connecting as Client

var connectionManager = host.Services.GetRequiredService<IConnectionManager>();
var discoveries = await connectionManager.Discover();

var found = discoveries.FirstOrDefault();
if (found != null)
{
    var connection = await connectionManager.ConnectTo(found.Address, found.Port);
    await connection.Send("testdata", new TestObject { Id = 3, Name = "Test" });
}

Full Example with DI and Logging

var builder = Host.CreateDefaultBuilder(args);

builder.AddSocketCommand(sb =>
{
    sb.WithAESEncryption()
      .With7ZipCompression()
      .WithUdpDiscovery()
      .WithCommand("ping", async (ISocketManager caller) =>
      {
          Console.WriteLine("ping");
          await caller.Send("ping");
      })
      .WithCommand("testdata", async (TestObject obj, ILogger<TestObject> logger) =>
      {
          logger.LogInformation("Received: {Id} - {Name}", obj.Id, obj.Name);
      });
});

await builder.Build().StartAsync();

🧩 Customization

You can plug in your own compression or encryption strategies:

builder.AddSocketCommand()
    .WithCompression<CustomCompressor>()
    .WithEncryption<CustomEncryptor>();

Implement:

• ISocketMessageCompressor
• ISocketMessageEncryption

and register them via generics or manual DI.

🛠️ Requirements

• .NET 8
• Works in console apps, Windows services, and ASP.NET Core projects