Class TerminalUdpRouter

Namespace

OneImlx.Terminal.Runtime

Assembly

OneImlx.Terminal.dll

The default ITerminalRouter<TContext> for UDP server communication.

public class TerminalUdpRouter : ITerminalRouter<TerminalUdpRouterContext>

Inheritance

object

TerminalUdpRouter

Implements

ITerminalRouter<TerminalUdpRouterContext>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This class implements the ITerminalRouter<TContext> interface and is responsible for handling UDP server communication. It runs a terminal as a UDP server on the specified IP endpoint and listens for incoming UDP datagrams. Unlike TCP, UDP is connectionless, allowing this server to receive messages from multiple clients without establishing a dedicated connection for each. Messages can be received and processed concurrently from various sources, making UDP suitable for scenarios where low latency or high-throughput communication is required, albeit with the trade-off of reliability.

The server can be gracefully stopped by canceling the provided cancellation token in the context, ensuring any ongoing operations are terminated and resources are cleanly released.

Constructors

TerminalUdpRouter(ITerminalExceptionHandler, IOptions<TerminalOptions>, ITerminalTextHandler, ITerminalProcessor, ILogger<TerminalUdpRouter>)

Initializes a new instance of the TerminalUdpRouter class.

public TerminalUdpRouter(ITerminalExceptionHandler exceptionHandler, IOptions<TerminalOptions> terminalOptions, ITerminalTextHandler textHandler, ITerminalProcessor terminalProcessor, ILogger<TerminalUdpRouter> logger)

Parameters

exceptionHandler ITerminalExceptionHandler

The handler for exceptions that occur during routing.

terminalOptions IOptions<TerminalOptions>

Configuration options for the terminal.

textHandler ITerminalTextHandler

The handler for processing text data.

terminalProcessor ITerminalProcessor

The terminal processing queue.

logger ILogger<TerminalUdpRouter>

The logger for logging information and errors.

Properties

IsRunning

Gets a value indicating whether the TerminalUdpRouter is running.

public bool IsRunning { get; protected set; }

Property Value

bool

Name

The terminal router name.

public string Name { get; }

Property Value

string

Methods

RunAsync(TerminalUdpRouterContext)

Asynchronously runs the UDP router, listening for incoming UDP packets and processing them.

public Task RunAsync(TerminalUdpRouterContext context)

Parameters

context TerminalUdpRouterContext

The UDP router context containing configuration and runtime information.

Returns

Task

A task that represents the asynchronous operation.

See Also

TerminalConsoleRouter

TerminalTcpRouter