Archived
162 lines
14 KiB
HTML
162 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Message Management | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Message Management | HiAPI-C# 2025 ">
|
|
|
|
|
|
<link rel="icon" href="../../img/HiAPI.favicon.ico">
|
|
<link rel="stylesheet" href="../../public/docfx.min.css">
|
|
<link rel="stylesheet" href="../../public/main.css">
|
|
<meta name="docfx:navrel" content="../../toc.html">
|
|
<meta name="docfx:tocrel" content="toc.html">
|
|
|
|
<meta name="docfx:rel" content="../../">
|
|
|
|
|
|
|
|
<meta name="loc:inThisArticle" content="In this article">
|
|
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
|
|
<meta name="loc:searchNoResults" content="No results for "{query}"">
|
|
<meta name="loc:tocFilter" content="Filter by title">
|
|
<meta name="loc:nextArticle" content="Next">
|
|
<meta name="loc:prevArticle" content="Previous">
|
|
<meta name="loc:themeLight" content="Light">
|
|
<meta name="loc:themeDark" content="Dark">
|
|
<meta name="loc:themeAuto" content="Auto">
|
|
<meta name="loc:changeTheme" content="Change theme">
|
|
<meta name="loc:copy" content="Copy">
|
|
<meta name="loc:downloadPdf" content="Download PDF">
|
|
|
|
<script type="module" src="./../../public/docfx.min.js"></script>
|
|
|
|
<script>
|
|
const theme = localStorage.getItem('theme') || 'auto'
|
|
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
|
<header class="bg-body border-bottom">
|
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
|
<div class="container-xxl flex-nowrap">
|
|
<a class="navbar-brand" href="../../index.html">
|
|
<img id="logo" class="svg" src="../../img/HiAPI.logo.png" alt="">
|
|
|
|
</a>
|
|
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
|
|
<i class="bi bi-three-dots"></i>
|
|
</button>
|
|
<div class="collapse navbar-collapse" id="navpanel">
|
|
<div id="navbar">
|
|
<form class="search" role="search" id="search">
|
|
<i class="bi bi-search"></i>
|
|
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<main class="container-xxl">
|
|
<div class="toc-offcanvas">
|
|
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
|
|
<div class="offcanvas-header">
|
|
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
|
|
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
|
|
</div>
|
|
<div class="offcanvas-body">
|
|
<nav class="toc" id="toc"></nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="content">
|
|
<div class="actionbar">
|
|
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
|
|
<i class="bi bi-list"></i>
|
|
</button>
|
|
|
|
<nav id="breadcrumb"></nav>
|
|
</div>
|
|
|
|
<article data-uid="Technique-MessageManagement">
|
|
<h1 id="message-management">Message Management</h1>
|
|
|
|
<p>HiNc applications use three independent message categories. Each category serves a distinct purpose and should not be mixed.</p>
|
|
<h2 id="categories">Categories</h2>
|
|
<h3 id="1-diagnostic--iprogressimessage">1. Diagnostic — <code>IProgress<IMessage></code></h3>
|
|
<p>Operation-scoped progress and diagnostic messages. The caller provides an <code>IProgress<IMessage></code> sink to the callee, which reports progress, warnings, and errors through it. Every <a class="xref" href="../../api/Hi.Common.Messages.IMessage.html">IMessage</a> carries a <a class="xref" href="../../api/Hi.Common.Messages.Severity.html">Severity</a>, a <a class="xref" href="../../api/Hi.Common.Messages.Category.html">Category</a>, and a filterable id.</p>
|
|
<ul>
|
|
<li><strong>Session-scoped</strong>: <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_ShellProgress">ShellProgress</a> feeds the <a class="xref" href="../../anatomy/shell/session-message-panel.html">Session Message Panel</a>; <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_StepDiagnosticProgress">StepDiagnosticProgress</a> retains step-anchored diagnostics and <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_NcDiagnosticProgress">NcDiagnosticProgress</a> retains NC-parsing diagnostics.</li>
|
|
<li><strong>XML IO chain</strong>: <a class="xref" href="../../api/Hi.Common.XmlUtils.XFactory.html">XFactory</a> threads <code>IProgress<IMessage></code> through all deserialization calls so that parsing errors are reported to the caller rather than a global handler.</li>
|
|
<li><strong>Script-level</strong>: <a class="xref" href="../../api/Hi.MachiningProcs.SessionShell.html#Hi_MachiningProcs_SessionShell_ShellProgress">ShellProgress</a> exposes the session sink to user scripts.</li>
|
|
<li><strong>Per-call</strong>: inject a <a class="xref" href="../../api/Hi.Common.Messages.MessageCollector.html">MessageCollector</a> to buffer one call's messages and read them back afterwards (e.g., to return them inline in an HTTP response).</li>
|
|
<li><strong>Project IO</strong>: <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_LoadProject_">LoadProject</a> and <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_ReloadProject_">ReloadProject</a> take a sink of their own, because project IO runs outside any session and none of the session sinks above exists while it runs. A load-time diagnostic — a referenced STL missing on disk, a child XML that will not deserialize — does not fail the load; the project comes up without that geometry and the call returns normally. Passing no sink leaves the application log as the only witness, and the caller sees an unqualified success.</li>
|
|
</ul>
|
|
<h4 id="reporting-to-a-sink-and-the-log-at-once">Reporting to a sink and the log at once</h4>
|
|
<p>An operation a caller may or may not be watching reports to both: always to the service <code>ILogger</code>, and additionally to an injected <code>IProgress<IMessage></code> when there is one. <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_EnableCollisionDetection_">EnableCollisionDetection</a>, <a class="xref" href="../../api/Hi.MachiningProcs.LocalProjectService.html#Hi_MachiningProcs_LocalProjectService_ResetRuntime_">ResetRuntime</a> and the two project-load entry points share that shape, and the parameter being optional is what lets a host with no caller to answer to — a script, a desktop shell — behave exactly as it did before the sink existed.</p>
|
|
<p>The counterpart obligation is that one operation reports one diagnostic once. Where a later stage re-reads what an earlier one has already reported on — the XML round trip that materialises execution equipment re-walks the sources the deserialization pass just read — that stage stays logger-only deliberately, so a caller collecting a project load does not receive every missing file twice.</p>
|
|
<h4 id="reporting-helpers-and-the-args-channel">Reporting helpers, and the args channel</h4>
|
|
<p>Use the <a class="xref" href="../../api/Hi.Common.Messages.MessageUtil.html">MessageUtil</a> id-first helpers to report typed messages. Each is named <code>{Category}{Severity}</code> — <code>SystemError</code>, <code>SystemWarning</code>, <code>ValidationWarning</code>, <code>ConfigurationWarning</code>, … — takes the structured id first, and is null-safe on the sink.</p>
|
|
<p>Every helper has a <code>{Category}{Severity}Fmt</code> sibling that takes a <code>FormattableString</code> in place of the <code>string</code>. The sibling keeps the template and the values interpolated into it on the message itself, as <a class="xref" href="../../api/Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetFormat">GetFormat()</a> and <a class="xref" href="../../api/Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetArgs">GetArgs()</a>, so a consumer holding a translation of that template can re-render the message in another language instead of dropping the numbers. The notification stays the invariant English rendering, so a value carried in it never picks up a decimal separator from a locale. What a client does with the pair, and why the English template is load-bearing rather than descriptive, is under <a class="xref" href="../../anatomy/platform/i18n.html">Internationalization</a>.</p>
|
|
<pre><code class="lang-csharp">progress.SystemErrorFmt("StlFile-Read--Failed", $"File Reading Failed: {path}");
|
|
</code></pre>
|
|
<div class="IMPORTANT">
|
|
<h5>Important</h5>
|
|
<p><strong>The sibling is opted into by name, and nothing reports its absence.</strong> An interpolated literal handed to the plain helper binds to <code>string</code>, is formatted on the spot, and the template is gone: the call compiles, reads identically at the site, and produces a message no client can translate. Report through <code>Fmt</code> wherever the text interpolates a value. Where it does not, stay on the plain helper — a client swaps a hole-less message by id alone, so giving it a template only adds a way for the equality gate to miss.</p>
|
|
</div>
|
|
<h3 id="2-ui-error-notification--messageboardutil">2. UI Error Notification — <code>MessageBoardUtil</code></h3>
|
|
<p>Toast-style popups for immediate user attention (e.g., “File saved”, “Load failed”). <a class="xref" href="../../api/Hi.Common.Messages.MessageBoardUtil.html">MessageBoardUtil</a> triggers the <code>ShowMessageBoard</code> event consumed by the GUI layer.</p>
|
|
<div class="NOTE">
|
|
<h5>Note</h5>
|
|
<p><code>MessageBoardUtil</code> is not yet mature for all scenarios. In practice, <code>ILogger</code> with level-filtered treatment is often applied instead.</p>
|
|
</div>
|
|
<h3 id="3-app-log--ilogger">3. App Log — <code>ILogger</code></h3>
|
|
<p>Standard .NET <code>ILogger</code> for application-level logging. Use <a class="xref" href="../../api/Hi.Common.Messages.ActionProgress-1.html">ActionProgress<T></a>.<a class="xref" href="../../api/Hi.Common.Messages.ActionProgress-1.html#Hi_Common_Messages_ActionProgress_1_FromLogger_">FromLogger</a> to bridge <code>IProgress<object></code> APIs to an <code>ILogger</code> instance:</p>
|
|
<pre><code class="lang-csharp">IProgress<object> progress = ActionProgress<object>.FromLogger(logger);
|
|
</code></pre>
|
|
<p>This routes each reported <a class="xref" href="../../api/Hi.Common.Messages.IMessage.html">IMessage</a> (or raw <code>Exception</code>) to the appropriate log level (<code>LogError</code>, <code>LogWarning</code>, <code>LogInformation</code>) based on its severity — with one precedence worth knowing: a message carrying an <code>Exception</code> as its detail goes to <code>LogError</code> with that exception attached whatever severity the message itself declares, so a warning that names an exception is logged as an error.</p>
|
|
<p>A null <code>logger</code> is accepted and becomes a no-op sink. A host built without dependency injection has none to hand over, and this bridge is reached from the error-reporting path itself, so a version that threw on a null logger would turn the first reported error into a crash inside the code meant to describe it.</p>
|
|
<h2 id="basic-component--utility-level">Basic-Component / Utility Level</h2>
|
|
<p>Low-level utilities (e.g., in <code>Hi.Common</code>, <code>Hi.Geom</code>) cannot assume which category the caller intends. These APIs accept <code>Action<Exception></code> or <code>IProgress<IMessage></code> as parameters so the caller decides how to handle messages:</p>
|
|
<pre><code class="lang-csharp">await task.CatchExceptions(ex => progress?.Report(ex));
|
|
</code></pre>
|
|
<h2 id="design-rationale">Design Rationale</h2>
|
|
<p>Static/global message sinks mix the three categories, making it unclear whether a message is diagnostic, UI notification, or app log. The current pattern threads the handler explicitly through the call chain so each caller decides the appropriate category.</p>
|
|
<h2 id="see-also">See Also</h2>
|
|
<ul>
|
|
<li><a href="xml-io.html">About XML IO</a> — the other cross-cutting service, and the one that threads a progress channel through deserialization</li>
|
|
<li><a href="../scripting/shell-progress.html">ShellProgress</a> — the session-scoped face of the diagnostic channel, as a script sees it</li>
|
|
</ul>
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</div>
|
|
|
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
|
|
|
</div>
|
|
|
|
<div class="affix">
|
|
<nav id="affix"></nav>
|
|
</div>
|
|
</main>
|
|
|
|
<div class="container-xxl search-results" id="search-results"></div>
|
|
|
|
<footer class="border-top text-secondary">
|
|
<div class="container-xxl">
|
|
<div class="flex-fill">
|
|
<span> Copyright © 2025 <a href='https://superhightech.com.tw'>Tech Coordinate</a>. All rights reserved. <a href='https://superhightech.com.tw'>超級高科技股份有限公司</a> © 2025 版權所有 </span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|