lib/Core/AdNoctem.Substrate.Diagnostics.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>AdNoctem.Substrate.Diagnostics</name> </assembly> <members> <member name="T:AdNoctem.Substrate.Diagnostics.ErrorTranslation"> <summary>Known diagnostic guidance. Recognizing a code never authorizes suppressing a failure or retrying an operation.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ErrorTranslator"> <summary>Maps known native error codes to curated guidance. Unknown or ambiguous codes remain untranslated.</summary> </member> <member name="M:AdNoctem.Substrate.Diagnostics.ErrorTranslator.Translate(System.Exception,System.Nullable{AdNoctem.Substrate.Diagnostics.ErrorDomain},System.String)"> <remarks>Recognized outer-to-inner HRESULTs take priority. Multiple distinct recognized text codes are ambiguous and return null. Exception traversal is bounded at 32 levels. This method never logs the exception or its potentially sensitive message.</remarks> </member> <member name="T:AdNoctem.Substrate.Diagnostics.LogEntry"> <summary>An immutable event; properties are strings to avoid retaining arbitrary mutable application objects or formatting them implicitly.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ILogSink"> <summary>A caller-provided destination for structured log events.</summary> <remarks>Implementations define their concurrency and durability guarantees. Sink failures propagate to the caller.</remarks> </member> <member name="M:AdNoctem.Substrate.Diagnostics.ILogSink.WriteAsync(AdNoctem.Substrate.Diagnostics.LogEntry,System.Threading.CancellationToken)"> <summary>Writes an event using the destination's cancellation and persistence policy.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.LogManager"> <summary>Explicit ordered fan-out. Sinks belong to the caller; sink errors propagate and already-written events cannot be rolled back.</summary> </member> <member name="M:AdNoctem.Substrate.Diagnostics.LogManager.WriteAsync(AdNoctem.Substrate.Diagnostics.LogEntry,System.Threading.CancellationToken)"> <summary>Writes to each configured sink in order, stopping at the first exception or cancellation.</summary> <remarks>Earlier sinks may already have persisted the event. The manager does not dispose sinks or retry writes.</remarks> </member> <member name="M:AdNoctem.Substrate.Diagnostics.LogManager.Write(AdNoctem.Substrate.Diagnostics.LogEntry,System.Threading.CancellationToken)"> <summary>Blocks until the ordered sink writes complete; errors propagate without an aggregate wrapper.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.JsonLineLogSink"> <summary>Serializes writes as JSON lines to a caller-selected writer. No console, path, timestamp, or redaction policy is inferred.</summary> </member> <member name="M:AdNoctem.Substrate.Diagnostics.JsonLineLogSink.#ctor(System.IO.TextWriter,System.Boolean)"> <param name="writer">Destination writer. This sink serializes its own writes, not writes made through other references.</param> <param name="leaveOpen">Keep the supplied writer open when disposing the sink; defaults to true.</param> </member> <member name="M:AdNoctem.Substrate.Diagnostics.JsonLineLogSink.WriteAsync(AdNoctem.Substrate.Diagnostics.LogEntry,System.Threading.CancellationToken)"> <summary>Appends one structured event as a JSON line, without automatic flushing.</summary> <remarks>Cancellation is observed before acquiring the write lock and before writing; an in-flight TextWriter write cannot be cancelled. A writer failure may leave a partial line. Disposal waits for an active write, rejects queued writes and honors leaveOpen.</remarks> </member> <member name="M:AdNoctem.Substrate.Diagnostics.JsonLineLogSink.FlushAsync(System.Threading.CancellationToken)"> <summary>Flushes the writer after active writes complete. Cancellation does not interrupt an in-flight writer flush.</summary> </member> <member name="M:AdNoctem.Substrate.Diagnostics.JsonLineLogSink.Dispose"> <summary>Waits for an active write and closes the writer only when ownership was explicitly transferred.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ProcessCommandLine"> <summary>Parses Windows executable command lines. Does not expand environment variables or evaluate shell syntax.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ProcessManager"> <summary>Runs Windows executables without a shell. Each call owns and closes its process and redirected stream handles.</summary> </member> <member name="M:AdNoctem.Substrate.Diagnostics.ProcessManager.StartDetached(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Threading.CancellationToken)"> <summary>Starts an independent process, closes the launch handle and returns its ID. No completion, output capture or termination is implied.</summary> <remarks>The caller explicitly accepts that the child outlives this operation. No shell, elevation or credential selection is performed.</remarks> </member> <member name="M:AdNoctem.Substrate.Diagnostics.ProcessManager.RunAsync(AdNoctem.Substrate.Diagnostics.ProcessRequest,System.Threading.CancellationToken)"> <remarks>Cancellation before launch throws; after launch the configured stop policy returns completed evidence. Launch and cleanup failures throw. Synchronous process creation cannot be interrupted by cancellation.</remarks> </member> <member name="M:AdNoctem.Substrate.Diagnostics.ProcessManager.QuoteArgument(System.String)"> <summary>Quotes one argument according to Windows C runtime rules; the result is not a command for cmd.exe or PowerShell.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ProcessStopBehavior"> <summary>Specifies how cancellation or timeout affects a started process. WaitForExit can continue waiting without terminating native work.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ProcessRequest"> <summary>A shell-free Windows process request. Arguments and environment are copied; credentials must not be placed in arguments.</summary> </member> <member name="M:AdNoctem.Substrate.Diagnostics.ProcessRequest.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String},System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Nullable{System.TimeSpan},AdNoctem.Substrate.Diagnostics.ProcessStopBehavior,System.Int32,System.Nullable{System.TimeSpan})"> <remarks>WaitForExit checks cancellation before launch, then records stop requests without interrupting the child. It can wait indefinitely. TerminateTree is best effort for descendants still attached to the process tree; detached processes are outside this ownership boundary. Output beyond the per-stream limit is drained and discarded. A zero limit captures nothing.</remarks> </member> <member name="T:AdNoctem.Substrate.Diagnostics.ProcessResult"> <summary>Completed process evidence. Nonzero exit codes and requested stops are data, not automatic retry or success policy.</summary> </member> <member name="T:AdNoctem.Substrate.Diagnostics.RobocopyExitResult"> <summary>Decodes Robocopy's result without executing the vendor tool.</summary> </member> </members> </doc> |