StellaOps.Router.Transport.Tcp.Server
Router TCP transport, server side: the listener a gateway accepts microservice connections with.
| Package | StellaOps.Router.Transport.Tcp.Server |
| Component | Router |
| Licence | BUSL-1.1 (Router licence) |
| Package kind | Library |
| Target framework | net10.0 |
To add the package to a project, see Installing Stella Ops packages.
Namespaces
| Namespace | Types |
|---|---|
StellaOps.Router.Transport.Tcp.Server | 3 |
StellaOps.Router.Transport.Tcp.Server namespace
| Type | Kind | Description |
|---|---|---|
TcpTransportServer | class | TCP transport server implementation for the gateway. |
TcpTransportServerPlugin | class | Plugin for the server side of the TCP transport, which a gateway listens with. |
TcpTransportServerServiceCollectionExtensions | class | Extension methods for registering the server side of the TCP transport. |
TcpTransportServer class
public sealed class TcpTransportServer : IGatewayConnectionTransportServer, IAsyncDisposable
TCP transport server implementation for the gateway.
TcpTransportServer(IOptions<TcpTransportOptions>, ILogger<TcpTransportServer>) constructor
public TcpTransportServer(IOptions<TcpTransportOptions> options, ILogger<TcpTransportServer> logger)
Initializes a new instance of the TcpTransportServerclass.
ConnectionCount property
public int ConnectionCount { get; }
Gets the number of active connections.
TransportType property
public TransportType TransportType { get; }
The transport this server provides.
OnConnection event
public event Action<string, ConnectionState>? OnConnection
Event raised when a connection is established.
OnDisconnection event
public event Action<string>? OnDisconnection
Event raised when a connection is lost.
OnFrame event
public event Action<string, Frame>? OnFrame
Event raised when a frame is received.
CloseConnection(string) method
public bool CloseConnection(string connectionId)
Closes a connection.
Parameters
connectionId: The connection identifier.
Returns
true when the connection existed and was closed.
DisposeAsync() method
public ValueTask DisposeAsync()
See IAsyncDisposable.DisposeAsync().
GetConnection(string) method
public TcpConnection? GetConnection(string connectionId)
Gets a connection by ID.
Parameters
connectionId: The connection ID.
Returns
The connection, or null if not found.
GetConnections() method
public IEnumerable<TcpConnection> GetConnections()
Gets all active connections.
SendFrameAsync(string, Frame, CancellationToken) method
public Task SendFrameAsync(string connectionId, Frame frame, CancellationToken cancellationToken = default)
Sends a frame to a connection.
Parameters
connectionId: The connection ID.frame: The frame to send.cancellationToken: Cancellation token.
StartAsync(CancellationToken) method
public Task StartAsync(CancellationToken cancellationToken)
Starts listening for incoming connections.
Parameters
cancellationToken: Cancellation token.
StopAsync(CancellationToken) method
public Task StopAsync(CancellationToken cancellationToken)
Stops accepting new connections.
Parameters
cancellationToken: Cancellation token.
TcpTransportServerPlugin class
public sealed class TcpTransportServerPlugin : IRouterTransportPlugin
Plugin for the server side of the TCP transport, which a gateway listens with. The client side is TcpTransportPluginin StellaOps.Router.Transport.Tcp; both carry the transport name tcp.
TcpTransportServerPlugin() constructor
public TcpTransportServerPlugin()
Creates an instance of TcpTransportServerPlugin.
DisplayName property
public string DisplayName { get; }
Gets the human-readable display name for this transport.
Mode property
public RouterTransportMode Mode { get; }
Gets the side of the transport this plugin registers: RouterTransportMode.Client, RouterTransportMode.Server, or RouterTransportMode.Both. IRouterTransportPlugin.Register(RouterTransportRegistrationContext)refuses a context that asks for a side outside this value (RouterTransportRegistrationContext.EnsureSupportedBy(IRouterTransportPlugin)).
TransportName property
public string TransportName { get; }
Gets the transport name (e.g., “tcp”, “tls”, “udp”, “rabbitmq”, “inmemory”, “messaging”), shared by the client and the server plugin of one transport.
Register(RouterTransportRegistrationContext) method
public void Register(RouterTransportRegistrationContext context)
Registers transport services into the DI container for the side the context asks for.
Parameters
context: The registration context containing services, configuration, and transport mode.
Exceptions
InvalidOperationException: The context asks for a side this plugin does not provide.
TcpTransportServerServiceCollectionExtensions class
public static class TcpTransportServerServiceCollectionExtensions
Extension methods for registering the server side of the TCP transport.
AddTcpTransportServer(IServiceCollection, Action<TcpTransportOptions>) extension method
public static IServiceCollection AddTcpTransportServer(this IServiceCollection services, Action<TcpTransportOptions>? configure = null)
Adds TCP transport server services to the service collection.
Parameters
services: The service collection.configure: Optional configuration action.
Returns
The service collection.
