New transport layer

Author: meruune

.editorconfig

@@ -0,0 +1,4 @@
+[*.cs]
+
+# MA0003: Add parameter name to improve readability
+dotnet_diagnostic.MA0003.severity = none

external/manifest.json

@@ -1,7 +1,7 @@
 {
-    "version": "1.0.0.1",
+    "version": "1.0.0.2",
     "display_name": "Amethyst Tracking Relay",
     "download": "plugin_Relay.zip",
-    "changelog": "Initial release.",
+    "changelog": "New transport layer.",
     "guid": "K2VRTEAM-AME2-APII-DVCE-TRACKINGRELAY"
 }

plugin_Relay.sln

@@ -5,6 +5,11 @@ VisualStudioVersion = 17.5.33103.201
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "plugin_Relay", "plugin_Relay\plugin_Relay.csproj", "{3C5DB9DE-D479-4160-815D-7B664F6AC8EF}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{08D1A2A1-5642-4C23-82D4-24C5E63D4522}"
+	ProjectSection(SolutionItems) = preProject
+		.editorconfig = .editorconfig
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|x64 = Debug|x64

plugin_Relay/AmethystLogger.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Collections.Concurrent;
+using Amethyst.Plugins.Contract;
+using Microsoft.Extensions.Logging;
+
+namespace plugin_Relay;
+
+public sealed class AmethystHostLogger(string name, IAmethystHost host) : ILogger
+{
+    public IDisposable BeginScope<TState>(TState state) where TState : notnull
+    {
+        return default!;
+    }
+
+    public bool IsEnabled(LogLevel logLevel)
+    {
+        return true;
+    }
+
+    public void Log<TState>(
+        LogLevel logLevel,
+        EventId eventId,
+        TState state,
+        Exception exception,
+        Func<TState, Exception, string> formatter)
+    {
+        if (logLevel < LogLevel.Information || host is null) return;
+        host.Log($"[{eventId.Id}: {logLevel}] {name} - {formatter(state, exception)}");
+    }
+}
+
+[ProviderAlias("AmethystHost")]
+public sealed class AmethystHostLoggerProvider(IAmethystHost host) : ILoggerProvider
+{
+    private readonly ConcurrentDictionary<string, AmethystHostLogger> _loggers =
+        new(StringComparer.OrdinalIgnoreCase);
+
+    public ILogger CreateLogger(string categoryName)
+    {
+        return _loggers.GetOrAdd(categoryName, name => new AmethystHostLogger(name, host));
+    }
+
+    public void Dispose()
+    {
+        _loggers.Clear();
+    }
+}

plugin_Relay/Models/Contract.cs

@@ -1,144 +1,92 @@
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Collections.ObjectModel;
-using System.Linq;
-using System.Numerics;
+using System.Threading;
 using System.Threading.Tasks;
 using Amethyst.Plugins.Contract;
-using MagicOnion;
-using MessagePack;
-using MessagePack.Formatters;
-using MessagePack.Resolvers;
+using MemoryPack;
+using Microsoft.Extensions.Logging;
+using Stl.Rpc;
 
 namespace plugin_Relay.Models;
 
 #nullable enable
 
-public interface IRelayClient
+public interface IRelayClient : IRpcService
 {
-    void OnRequestShutdown(string reason = "", bool fatal = false); // Push to the client
-    void OnRefreshInterface(string reason = "", bool fatal = false); // Push to the client
+    Task OnRequestShutdown(string reason = "", bool fatal = false, CancellationToken cancellationToken = default); // Push to the client
+    Task OnRefreshInterface(CancellationToken cancellationToken = default); // Push to the client
 }
 
-public interface IRelayService : IStreamingHub<IRelayService, IRelayClient>
+public interface IRelayService : IRpcService
 {
-    Task<long> PingService(); // Test service connection -> receive time
-    Task<bool> RequestShutdown(string reason = "", bool fatal = false);
+    Task<long> PingService(CancellationToken cancellationToken = default); // Test service connection -> receive time
+    Task<bool> RequestShutdown(string reason = "", bool fatal = false, CancellationToken cancellationToken = default);
 
-    public Task<string> GetRemoteHostname(); // Check remote host's name
-    public Task<List<TrackingDevice>> ListTrackingDevices(); // List available devices
-    public Task<TrackingDevice?> GetTrackingDevice(string guid); // Null for not found
-    public Task<List<TrackedJoint>?> GetTrackedJoints(string guid); // Null if invalid
+    Task<string> GetRemoteHostname(CancellationToken cancellationToken = default); // Check remote host's name
+    Task<List<TrackingDevice>> ListTrackingDevices(CancellationToken cancellationToken = default); // List available devices
+    Task<TrackingDevice?> GetTrackingDevice(string guid, CancellationToken cancellationToken = default); // Null for not found
+    Task<List<TrackedJoint>?> GetTrackedJoints(string guid, CancellationToken cancellationToken = default); // Null if invalid
 
-    public Task<TrackingDevice?> DeviceInitialize(string guid); // Init remote device
-    public Task<TrackingDevice?> DeviceShutdown(string guid); // Shutdown remote device
-    public Task<TrackingDevice?> DeviceSignalJoint(string guid, int jointId); // Joints
+    Task<TrackingDevice?> DeviceInitialize(string guid, CancellationToken cancellationToken = default); // Init remote device
+    Task<TrackingDevice?> DeviceShutdown(string guid, CancellationToken cancellationToken = default); // Shutdown remote device
+    Task<TrackingDevice?> DeviceSignalJoint(string guid, int jointId, CancellationToken cancellationToken = default); // Joints
 }
 
-public class CustomResolver : IFormatterResolver
-{
-    public static readonly IFormatterResolver Instance = new CustomResolver();
-
-    // Resolve the formatter for the ImportedClass
-    public IMessagePackFormatter<T> GetFormatter<T>()
-    {
-        if (typeof(T) == typeof(TrackedJoint)) return (IMessagePackFormatter<T>)new TrackedJointFormatter();
-        if (typeof(T) == typeof(TrackingDevice)) return (IMessagePackFormatter<T>)new TrackingDeviceFormatter();
-
-        // Fallback to other resolvers
-        return StandardResolver.Instance.GetFormatter<T>();
-    }
-}
+#nullable disable
 
-public class TrackedJointFormatter : IMessagePackFormatter<TrackedJoint>
+public class TrackedJointFormatter : MemoryPackFormatter<TrackedJoint>
 {
-    public void Serialize(ref MessagePackWriter writer, TrackedJoint value, MessagePackSerializerOptions options)
+    // Unity does not support scoped and TBufferWriter so change signature to `Serialize(ref MemoryPackWriter writer, ref AnimationCurve value)`
+    public override void Serialize<TBufferWriter>(ref MemoryPackWriter<TBufferWriter> writer, scoped ref TrackedJoint value)
     {
-        writer.WriteArrayHeader(22);
-
-        writer.Write(value.Name);
-        writer.Write((int)value.Role);
-        writer.Write(value.Position.X);
-        writer.Write(value.Position.Y);
-        writer.Write(value.Position.Z);
-        writer.Write(value.Orientation.X);
-        writer.Write(value.Orientation.Y);
-        writer.Write(value.Orientation.Z);
-        writer.Write(value.Orientation.W);
-        writer.Write(value.Velocity.X);
-        writer.Write(value.Velocity.Y);
-        writer.Write(value.Velocity.Z);
-        writer.Write(value.Acceleration.X);
-        writer.Write(value.Acceleration.Y);
-        writer.Write(value.Acceleration.Z);
-        writer.Write(value.AngularVelocity.X);
-        writer.Write(value.AngularVelocity.Y);
-        writer.Write(value.AngularVelocity.Z);
-        writer.Write(value.AngularAcceleration.X);
-        writer.Write(value.AngularAcceleration.Y);
-        writer.Write(value.AngularAcceleration.Z);
-        writer.Write((int)value.TrackingState);
+        if (value == null)
+        {
+            writer.WriteNullObjectHeader();
+            return;
+        }
+        
+        writer.WritePackable(new SerializableTrackedJoint(value));
     }
 
-    public TrackedJoint Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
+    public override void Deserialize(ref MemoryPackReader reader, scoped ref TrackedJoint value)
     {
-        reader.ReadArrayHeader();
-        return new TrackedJoint
+        if (reader.PeekIsNull())
         {
-            Name = reader.ReadString(),
-            Role = (TrackedJointType)reader.ReadInt32(),
-            Position = new Vector3(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()),
-            Orientation = new Quaternion(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()),
-            Velocity = new Vector3(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()),
-            Acceleration = new Vector3(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()),
-            AngularVelocity = new Vector3(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()),
-            AngularAcceleration = new Vector3(reader.ReadSingle(), reader.ReadSingle(), reader.ReadSingle()),
-            TrackingState = (TrackedJointState)reader.ReadInt32()
-        };
+            reader.Advance(1); // Skip null block
+            value = null;
+            return;
+        }
+
+        var wrapped = reader.ReadPackable<SerializableTrackedJoint>();
+        value = wrapped.TrackedJoint;
     }
 }
 
-public class TrackingDeviceFormatter : IMessagePackFormatter<TrackingDevice>
+public class TrackingDeviceFormatter : MemoryPackFormatter<TrackingDevice>
 {
-    public void Serialize(ref MessagePackWriter writer, TrackingDevice value, MessagePackSerializerOptions options)
+    // Unity does not support scoped and TBufferWriter so change signature to `Serialize(ref MemoryPackWriter writer, ref AnimationCurve value)`
+    public override void Serialize<TBufferWriter>(ref MemoryPackWriter<TBufferWriter> writer, scoped ref TrackingDevice value)
     {
-        writer.WriteArrayHeader(12);
+        if (value == null)
+        {
+            writer.WriteNullObjectHeader();
+            return;
+        }
 
-        writer.Write(value.DeviceGuid);
-        //writer.Write(value.SessionGuid.ToString());
-        writer.Write(value.DeviceName);
-        writer.Write(value.RemoteDeviceStatusString);
-        writer.Write(value.RemoteDeviceStatus);
-        writer.Write(value.IsInitialized);
-        writer.Write(value.IsSkeletonTracked);
-        writer.Write(value.IsPositionFilterBlockingEnabled);
-        writer.Write(value.IsPhysicsOverrideEnabled);
-        writer.Write(value.IsFlipSupported);
-        writer.Write(value.IsAppOrientationSupported);
-        writer.Write(value.IsSettingsDaemonSupported);
-        // ReSharper disable once ConditionalAccessQualifierIsNonNullableAccordingToAPIContract
-        writer.Write(value.ErrorDocsUri?.ToString());
+        writer.WritePackable(new SerializableTrackingDevice(value));
     }
 
-    public TrackingDevice Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
+    public override void Deserialize(ref MemoryPackReader reader, scoped ref TrackingDevice value)
     {
-        reader.ReadArrayHeader();
-        return new TrackingDevice
+        if (reader.PeekIsNull())
         {
-            DeviceGuid = reader.ReadString(),
-            //SessionGuid = Guid.TryParse(reader.ReadString(), out var guid) ? guid : Guid.NewGuid(),
-            DeviceName = reader.ReadString(),
-            RemoteDeviceStatusString = reader.ReadString(),
-            RemoteDeviceStatus = reader.ReadInt32(),
-            IsInitialized = reader.ReadBoolean(),
-            IsSkeletonTracked = reader.ReadBoolean(),
-            IsPositionFilterBlockingEnabled = reader.ReadBoolean(),
-            IsPhysicsOverrideEnabled = reader.ReadBoolean(),
-            IsFlipSupported = reader.ReadBoolean(),
-            IsAppOrientationSupported = reader.ReadBoolean(),
-            IsSettingsDaemonSupported = reader.ReadBoolean(),
-            // ReSharper disable once AssignNullToNotNullAttribute
-            ErrorDocsUri = Uri.TryCreate(reader.ReadString(), UriKind.RelativeOrAbsolute, out var uri) ? uri : null
-        };
+            reader.Advance(1); // Skip null block
+            value = null;
+            return;
+        }
+
+        var wrapped = reader.ReadPackable<SerializableTrackingDevice>();
+        value = wrapped.TrackingDevice;
     }
-}
+}