mirror of
https://github.com/Stone-Red-Code/RemoteExec.git
synced 2026-09-04 09:06:20 +02:00
Add XML docs
This commit is contained in:
@@ -1,10 +1,32 @@
|
||||
namespace RemoteExec.Shared;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a request to execute a static method on a remote server.
|
||||
/// </summary>
|
||||
public sealed class RemoteExecutionRequest
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the full name of the assembly containing the method.
|
||||
/// </summary>
|
||||
public required string AssemblyName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the full name of the type containing the method.
|
||||
/// </summary>
|
||||
public required string TypeName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the name of the method to execute.
|
||||
/// </summary>
|
||||
public required string MethodName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the assembly-qualified names of the method's parameter types.
|
||||
/// </summary>
|
||||
public required string[] ArgumentTypes { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the arguments to pass to the method.
|
||||
/// </summary>
|
||||
public required object[] Arguments { get; set; }
|
||||
}
|
||||
|
||||
@@ -1,7 +1,17 @@
|
||||
namespace RemoteExec.Shared;
|
||||
|
||||
/// <summary>
|
||||
/// Represents the result of a remote method execution.
|
||||
/// </summary>
|
||||
public sealed class RemoteExecutionResult
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the return value of the executed method, or null if the method returns void.
|
||||
/// </summary>
|
||||
public object? Result { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the exception message if the execution failed, or null if successful.
|
||||
/// </summary>
|
||||
public string? Exception { get; set; }
|
||||
}
|
||||
|
||||
@@ -1,12 +1,42 @@
|
||||
namespace RemoteExec.Shared;
|
||||
|
||||
/// <summary>
|
||||
/// Represents performance and status metrics for a remote execution server.
|
||||
/// </summary>
|
||||
public sealed class ServerMetrics
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the number of active client connections to the server.
|
||||
/// </summary>
|
||||
public int ActiveConnections { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the number of tasks currently being executed on the server.
|
||||
/// </summary>
|
||||
public int ActiveTasks { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the maximum number of tasks that can execute concurrently on the server.
|
||||
/// </summary>
|
||||
public int MaxConcurrentTasks { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the total memory usage of the server process in bytes.
|
||||
/// </summary>
|
||||
public long TotalMemoryUsage { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the CPU usage percentage (0-100) of the server process.
|
||||
/// </summary>
|
||||
public double CpuUsage { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the timestamp when these metrics were captured.
|
||||
/// </summary>
|
||||
public DateTime Timestamp { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the unique identifier for the server.
|
||||
/// </summary>
|
||||
public string ServerId { get; set; } = string.Empty;
|
||||
}
|
||||
@@ -1,7 +1,17 @@
|
||||
namespace RemoteExec.Shared;
|
||||
|
||||
/// <summary>
|
||||
/// Represents a task item in the execution stream, combining a task ID with its execution request.
|
||||
/// </summary>
|
||||
public class TaskItem
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the unique identifier for this task.
|
||||
/// </summary>
|
||||
public Guid TaskId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the execution request details.
|
||||
/// </summary>
|
||||
public required RemoteExecutionRequest Request { get; set; }
|
||||
}
|
||||
Reference in New Issue
Block a user