ThreeByte.LinkLib.UdpLink 1.0.3

📡 ThreeByte.LinkLib.UdpLink

Asynchronous UDP client with message queuing, configurable endpoints, and thread-safe operation.

✨ Features

📦 Installation

dotnet add package ThreeByte.LinkLib.UdpLink

or via the NuGet Package Manager:

Install-Package ThreeByte.LinkLib.UdpLink

🚀 Quick Start

using ThreeByte.LinkLib.UdpLink;

// Send to a remote device on port 9000, listen on local port 9001
var udp = new AsyncUdpLink("192.168.1.50", remotePort: 9000, localPort: 9001);

// Subscribe to incoming data
udp.DataReceived += (s, e) =>
{
    byte[]? data = udp.GetMessage();
    if (data != null)
        Console.WriteLine($"Received {data.Length} bytes");
};

udp.ErrorOccurred += (s, ex) =>
    Console.WriteLine($"Error: {ex.Message}");

// Send a datagram
byte[] payload = System.Text.Encoding.ASCII.GetBytes("PING");
udp.SendMessage(payload);

// Check for queued data
while (udp.HasData)
{
    byte[]? response = udp.GetMessage();
}

// Clean up
udp.Dispose();

Dynamic Local Port

// Let the OS assign a local port (default behavior)
var udp = new AsyncUdpLink("10.0.0.1", remotePort: 8080);

📖 API Reference

AsyncUdpLink

Constructors

AsyncUdpLink(string address, int remotePort, int localPort = 0, bool enabled = true)
AsyncUdpLink(UdpLinkSettings settings, bool enabled = true)

Properties

Methods

Events

🔧 Configuration

Use UdpLinkSettings for structured configuration:

// With explicit local port
var settings = new UdpLinkSettings("10.0.0.1", remotePort: 8080, localPort: 8081);

// With dynamic local port (default 0)
var settings = new UdpLinkSettings("10.0.0.1", remotePort: 8080);

🏗️ Architecture

┌────────────────────────────────────────────┐
│              AsyncUdpLink                  │
│                                            │
│  ┌──────────────┐    ┌──────────────────┐  │
│  │  Send (Async) │    │ Receive (Async)  │  │
│  │ → Remote:Port │    │ ← Local:Port     │  │
│  └──────┬───────┘    └────────┬─────────┘  │
│         │                     │            │
│         ▼                     ▼            │
│  ┌──────────────────────────────────────┐  │
│  │     Thread-Safe Message Queue        │  │
│  │          (FIFO, max 100)             │  │
│  └──────────────────────────────────────┘  │
│         │                                  │
│         ▼                                  │
│  ┌──────────────────────────────────────┐  │
│  │   Event Dispatch (Data / Error)      │  │
│  └──────────────────────────────────────┘  │
└────────────────────────────────────────────┘

💡 TCP vs UDP — When to Use This Package

🎯 Platform Support

📄 License

Part of the ThreeByte.LinkLib family of communication libraries.