Dalamud/Dalamud/Networking/Rpc/RpcConnection.cs

using System.IO;
using System.Threading;
using System.Threading.Tasks;

using Dalamud.Networking.Rpc.Service;

using Serilog;

using StreamJsonRpc;

namespace Dalamud.Networking.Rpc;

/// <summary>
/// A single RPC client session connected via a stream (named pipe or Unix socket).
/// </summary>
internal class RpcConnection : IDisposable
{
    private readonly Stream stream;
    private readonly RpcServiceRegistry registry;
    private readonly CancellationTokenSource cts = new();

    /// <summary>
    /// Initializes a new instance of the <see cref="RpcConnection"/> class.
    /// </summary>
    /// <param name="stream">The stream that this connection will handle.</param>
    /// <param name="registry">A registry of RPC services.</param>
    public RpcConnection(Stream stream, RpcServiceRegistry registry)
    {
        this.Id = Guid.CreateVersion7();
        this.stream = stream;
        this.registry = registry;

        var formatter = new JsonMessageFormatter();
        var handler = new HeaderDelimitedMessageHandler(stream, stream, formatter);

        this.Rpc = new JsonRpc(handler);
        this.Rpc.AllowModificationWhileListening = true;
        this.Rpc.Disconnected += this.OnDisconnected;
        this.registry.Attach(this.Rpc);

        this.Rpc.StartListening();
    }

    /// <summary>
    /// Gets the GUID for this connection.
    /// </summary>
    public Guid Id { get; }

    /// <summary>
    /// Gets the JsonRpc instance for this connection.
    /// </summary>
    public JsonRpc Rpc { get; }

    /// <summary>
    /// Gets a task that's called on RPC completion.
    /// </summary>
    public Task Completion => this.Rpc.Completion;

    /// <inheritdoc/>
    public void Dispose()
    {
        if (!this.cts.IsCancellationRequested)
        {
            this.cts.Cancel();
        }

        try
        {
            this.Rpc.Dispose();
        }
        catch (Exception ex)
        {
            Log.Debug(ex, "Error disposing JsonRpc for client {Id}", this.Id);
        }

        try
        {
            this.stream.Dispose();
        }
        catch (Exception ex)
        {
            Log.Debug(ex, "Error disposing stream for client {Id}", this.Id);
        }

        this.cts.Dispose();
        GC.SuppressFinalize(this);
    }

    private void OnDisconnected(object? sender, JsonRpcDisconnectedEventArgs e)
    {
        Log.Debug("RPC client {Id} disconnected: {Reason}", this.Id, e.Description);
        this.registry.Detach(this.Rpc);
        this.Dispose();
    }
}