Add XML docs

This commit is contained in:
Stone_Red
2025-12-23 15:15:18 +01:00
parent 55f26b3a92
commit 3e339b2b7a
26 changed files with 377 additions and 4 deletions
@@ -10,6 +10,10 @@ namespace RemoteExec.Client;
public partial class RemoteExecutor
{
/// <summary>
/// Starts the remote executor, connecting to all configured servers and beginning task distribution.
/// </summary>
/// <param name="cancellationToken">A cancellation token to cancel the operation.</param>
public async Task StartAsync(CancellationToken cancellationToken = default)
{
// Dispose previous cancellation token source if exists
@@ -40,6 +44,10 @@ public partial class RemoteExecutor
distributorTask = Task.Run(() => DistributorLoop(distributorCts.Token), distributorCts.Token);
}
/// <summary>
/// Stops the remote executor, disconnecting from all servers and stopping task distribution.
/// </summary>
/// <param name="cancellationToken">A cancellation token to cancel the operation.</param>
public async Task StopAsync(CancellationToken cancellationToken = default)
{
logger.LogInformation("Stopping RemoteExecutor...");