Joseph Doherty
b86c6bb47f
Resolve all CommentChecker findings across the gateway server, worker, tests, and .NET client (314 -> 0 real issues): add missing <returns>/<summary>/<param> on public and test members, convert Stream/interface overrides to <inheritdoc/>, and remove internal task/issue tracking IDs (SEC-*, IPC-*, WRK-*, GWC-*, TST-*, Client.Dotnet-*) from shipped code documentation while preserving the design rationale prose. Shipped comments should not carry internal bookkeeping, and complete XML docs keep the analyzer/TreatWarningsAsErrors gate and generated API docs clean. The 6 remaining flags are heuristic false positives (MD5, UTC-4, capacity-1, near-1601) left intact so real documentation is not corrupted. Claude-Session: https://claude.ai/code/session_01DMXXvNuPekkkrTEyPNxEkW
55 lines
2.6 KiB
C#
55 lines
2.6 KiB
C#
using Grpc.Core;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Client;
|
|
|
|
/// <summary>Transport layer for Galaxy Repository gRPC operations.</summary>
|
|
internal interface IGalaxyRepositoryClientTransport
|
|
{
|
|
/// <summary>Gets the client options used to configure this transport.</summary>
|
|
MxGatewayClientOptions Options { get; }
|
|
|
|
/// <summary>Gets the underlying gRPC client, or <c>null</c> if not yet initialized.</summary>
|
|
GalaxyRepository.GalaxyRepositoryClient? RawClient { get; }
|
|
|
|
/// <summary>Tests the connection to the Galaxy Repository server.</summary>
|
|
/// <param name="request">The test connection request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>The test connection reply.</returns>
|
|
Task<TestConnectionReply> TestConnectionAsync(
|
|
TestConnectionRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Gets the last deploy time from the Galaxy Repository server.</summary>
|
|
/// <param name="request">The get last deploy time request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>The last deploy time reply.</returns>
|
|
Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
|
GetLastDeployTimeRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Discovers the object hierarchy in the Galaxy Repository.</summary>
|
|
/// <param name="request">The discover hierarchy request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>The discovered hierarchy reply.</returns>
|
|
Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
|
DiscoverHierarchyRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Returns direct children of a parent in the Galaxy hierarchy.</summary>
|
|
/// <param name="request">The browse children request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>The browse children reply.</returns>
|
|
Task<BrowseChildrenReply> BrowseChildrenAsync(
|
|
BrowseChildrenRequest request,
|
|
CallOptions callOptions);
|
|
|
|
/// <summary>Watches for deployment events from the Galaxy Repository server.</summary>
|
|
/// <param name="request">The watch deploy events request.</param>
|
|
/// <param name="callOptions">gRPC call options (timeout, cancellation, etc.).</param>
|
|
/// <returns>An asynchronous stream of deploy events.</returns>
|
|
IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
|
WatchDeployEventsRequest request,
|
|
CallOptions callOptions);
|
|
}
|