fca978de07
Sweep of 203 source files resolving CommentChecker findings: add <summary>/<param>/<returns>/<inheritdoc> where missing, and remove resolved task/issue tracking markers (Tests-NNN, Worker-NNN, Server-NNN, Task N) from code comments. Comment/doc-only — no logic changes. Server+Tests build clean under TreatWarningsAsErrors.
187 lines
6.2 KiB
C#
187 lines
6.2 KiB
C#
using Google.Protobuf.WellKnownTypes;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Server.Grpc;
|
|
|
|
/// <summary>
|
|
/// Maps between worker IPC types and gRPC contract types.
|
|
/// </summary>
|
|
public sealed class MxAccessGrpcMapper
|
|
{
|
|
private readonly TimeProvider _timeProvider;
|
|
|
|
/// <summary>
|
|
/// Initializes the mapper with an optional time provider.
|
|
/// </summary>
|
|
/// <param name="timeProvider">Time provider for timestamps; defaults to system time if null.</param>
|
|
public MxAccessGrpcMapper(TimeProvider? timeProvider = null)
|
|
{
|
|
_timeProvider = timeProvider ?? TimeProvider.System;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Maps a gRPC MX command request to a worker command.
|
|
/// </summary>
|
|
/// <param name="request">Request payload.</param>
|
|
/// <returns>The mapped <see cref="WorkerCommand"/> ready for worker dispatch.</returns>
|
|
public WorkerCommand MapCommand(MxCommandRequest request)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(request);
|
|
ArgumentNullException.ThrowIfNull(request.Command);
|
|
|
|
return new WorkerCommand
|
|
{
|
|
Command = request.Command.Clone(),
|
|
EnqueueTimestamp = Timestamp.FromDateTimeOffset(_timeProvider.GetUtcNow()),
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Maps a worker command reply to a gRPC MX command reply.
|
|
/// </summary>
|
|
/// <param name="reply">Worker command reply.</param>
|
|
/// <returns>The mapped <see cref="MxCommandReply"/>, or a protocol-violation reply if the worker reply carried no public payload.</returns>
|
|
public MxCommandReply MapCommandReply(WorkerCommandReply reply)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(reply);
|
|
|
|
if (reply.Reply is null)
|
|
{
|
|
return new MxCommandReply
|
|
{
|
|
ProtocolStatus = ProtocolViolation("Worker command reply did not contain a public reply payload."),
|
|
};
|
|
}
|
|
|
|
return reply.Reply.Clone();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Maps a worker event to a gRPC MX event.
|
|
/// </summary>
|
|
/// <param name="workerEvent">Worker event to map.</param>
|
|
/// <returns>The mapped <see cref="MxEvent"/>, or an unspecified-family event if the worker event carried no public payload.</returns>
|
|
public MxEvent MapEvent(WorkerEvent workerEvent)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(workerEvent);
|
|
|
|
return workerEvent.Event?.Clone() ?? new MxEvent
|
|
{
|
|
Family = MxEventFamily.Unspecified,
|
|
RawStatus = "Worker event did not contain a public event payload.",
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates an OK protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.Ok"/>.</returns>
|
|
public static ProtocolStatus Ok(string message = "OK")
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.Ok,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates an InvalidRequest protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.InvalidRequest"/>.</returns>
|
|
public static ProtocolStatus InvalidRequest(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.InvalidRequest,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a SessionNotFound protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.SessionNotFound"/>.</returns>
|
|
public static ProtocolStatus SessionNotFound(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.SessionNotFound,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a SessionNotReady protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.SessionNotReady"/>.</returns>
|
|
public static ProtocolStatus SessionNotReady(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.SessionNotReady,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a WorkerUnavailable protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.WorkerUnavailable"/>.</returns>
|
|
public static ProtocolStatus WorkerUnavailable(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.WorkerUnavailable,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a Timeout protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.Timeout"/>.</returns>
|
|
public static ProtocolStatus Timeout(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.Timeout,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a Canceled protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.Canceled"/>.</returns>
|
|
public static ProtocolStatus Canceled(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.Canceled,
|
|
Message = message,
|
|
};
|
|
}
|
|
|
|
/// <summary>
|
|
/// Creates a ProtocolViolation protocol status.
|
|
/// </summary>
|
|
/// <param name="message">Status message.</param>
|
|
/// <returns>A <see cref="ProtocolStatus"/> with code <see cref="ProtocolStatusCode.ProtocolViolation"/>.</returns>
|
|
public static ProtocolStatus ProtocolViolation(string message)
|
|
{
|
|
return new ProtocolStatus
|
|
{
|
|
Code = ProtocolStatusCode.ProtocolViolation,
|
|
Message = message,
|
|
};
|
|
}
|
|
}
|