Archived
364 lines
19 KiB
HTML
364 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Class MessageCollector | HiAPI-C# 2025 </title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="title" content="Class MessageCollector | HiAPI-C# 2025 ">
|
|
|
|
<meta name="description" content="A minimal of that buffers every reported message into . Intended as a per-call / per-request sink: a caller injects it into a have-both function (one that takes an IProgress&lt;IMessage&gt; messageProgress), runs the operation, then reads the collected messages back — e.g. to return them in an HTTP response so a REST / AI caller sees progress, success, and error notifications inline. Unlike the session / step sinks (ShellProgress, StepDiagnosticProgress) it fires no events and holds no session or pipeline state; it is cheap to create and discard for the lifetime of a single call.">
|
|
<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="ManagedReference">
|
|
<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="Hi.Common.Messages.MessageCollector">
|
|
|
|
|
|
|
|
<h1 id="Hi_Common_Messages_MessageCollector" data-uid="Hi.Common.Messages.MessageCollector" class="text-break">
|
|
Class MessageCollector
|
|
</h1>
|
|
|
|
<div class="facts text-secondary">
|
|
<dl><dt>Namespace</dt><dd><a class="xref" href="Hi.html">Hi</a>.<a class="xref" href="Hi.Common.html">Common</a>.<a class="xref" href="Hi.Common.Messages.html">Messages</a></dd></dl>
|
|
<dl><dt>Assembly</dt><dd>HiGeom.dll</dd></dl>
|
|
</div>
|
|
|
|
<div class="markdown summary"><p>A minimal <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> of <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> that buffers every
|
|
reported message into <a class="xref" href="Hi.Common.Messages.MessageCollector.html#Hi_Common_Messages_MessageCollector_Messages">Messages</a>. Intended as a per-call / per-request
|
|
sink: a caller injects it into a have-both function (one that takes an
|
|
<code>IProgress<IMessage> messageProgress</code>), runs the operation, then reads the
|
|
collected messages back — e.g. to return them in an HTTP response so a REST / AI
|
|
caller sees progress, success, and error notifications inline.</p>
|
|
<p>Unlike the session / step sinks (<code>ShellProgress</code>, <code>StepDiagnosticProgress</code>) it
|
|
fires no events and holds no session or pipeline state; it is cheap to create and
|
|
discard for the lifetime of a single call.</p>
|
|
</div>
|
|
<div class="markdown conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class MessageCollector : IProgress<IMessage></code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<dl class="typelist inheritance">
|
|
<dt>Inheritance</dt>
|
|
<dd>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
|
<div><span class="xref">MessageCollector</span></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl class="typelist implements">
|
|
<dt>Implements</dt>
|
|
<dd>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress</a><<a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>></div>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<dl class="typelist inheritedMembers">
|
|
<dt>Inherited Members</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
<dl class="typelist extensionMethods">
|
|
<dt>Extension Methods</dt>
|
|
<dd>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.DuplicateUtil.html#Hi_Common_DuplicateUtil_TryDuplicate__1___0_System_Object___">DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__1___0_System_Action___0__">InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.InvokeUtil.html#Hi_Common_InvokeUtil_SelfInvoke__2___0_System_Func___0___1__">InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ConfigurationError_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.ConfigurationError(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ConfigurationErrorFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.ConfigurationErrorFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ConfigurationMessage_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.ConfigurationMessage(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ConfigurationMessageFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.ConfigurationMessageFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ConfigurationWarning_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.ConfigurationWarning(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ConfigurationWarningFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.ConfigurationWarningFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemError_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.SystemError(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemErrorFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.SystemErrorFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemMessage_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.SystemMessage(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemMessageFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.SystemMessageFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemProgress_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.SystemProgress(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemProgressFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.SystemProgressFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemSuccess_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.SystemSuccess(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemSuccessFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.SystemSuccessFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemWarning_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.SystemWarning(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_SystemWarningFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.SystemWarningFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_UnsupportedError_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.UnsupportedError(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_UnsupportedErrorFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.UnsupportedErrorFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_UnsupportedMessage_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.UnsupportedMessage(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_UnsupportedMessageFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.UnsupportedMessageFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_UnsupportedWarning_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.UnsupportedWarning(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_UnsupportedWarningFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.UnsupportedWarningFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ValidationError_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.ValidationError(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ValidationErrorFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.ValidationErrorFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ValidationWarning_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_String_System_Object_">MessageUtil.ValidationWarning(IProgress<IMessage>, string, string, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.Messages.MessageUtil.html#Hi_Common_Messages_MessageUtil_ValidationWarningFmt_System_IProgress_Hi_Common_Messages_IMessage__System_String_System_FormattableString_System_Object_">MessageUtil.ValidationWarningFmt(IProgress<IMessage>, string, FormattableString, object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Coloring.ColorUtil.html#Hi_Coloring_ColorUtil_GetGloomyColor_System_Object_System_Double_System_Double_">ColorUtil.GetGloomyColor(object, double, double)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.NameUtil.html#Hi_Common_NameUtil_GetSelectionName_System_Object_">NameUtil.GetSelectionName(object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Common.StringUtil.html#Hi_Common_StringUtil_GetPropertyStringIfToStringNotOverloaded_System_Object_System_Boolean_System_Boolean_">StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Hi.Parallels.LockUtil.html#Hi_Parallels_LockUtil_Lock_System_Object_">LockUtil.Lock(object)</a>
|
|
</div>
|
|
</dd></dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="properties">Properties
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Common_Messages_MessageCollector_Messages_" data-uid="Hi.Common.Messages.MessageCollector.Messages*"></a>
|
|
|
|
<h3 id="Hi_Common_Messages_MessageCollector_Messages" data-uid="Hi.Common.Messages.MessageCollector.Messages">
|
|
Messages
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>The messages reported so far, in arrival order.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public List<IMessage> Messages { get; }</code></pre>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<h4 class="section">Property Value</h4>
|
|
<dl class="parameters">
|
|
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a><<a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a>></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 class="section" id="methods">Methods
|
|
</h2>
|
|
|
|
|
|
<a id="Hi_Common_Messages_MessageCollector_Report_" data-uid="Hi.Common.Messages.MessageCollector.Report*"></a>
|
|
|
|
<h3 id="Hi_Common_Messages_MessageCollector_Report_Hi_Common_Messages_IMessage_" data-uid="Hi.Common.Messages.MessageCollector.Report(Hi.Common.Messages.IMessage)">
|
|
Report(IMessage)
|
|
|
|
</h3>
|
|
|
|
<div class="markdown level1 summary"><p>Reports a progress update.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Report(IMessage value)</code></pre>
|
|
</div>
|
|
|
|
<h4 class="section">Parameters</h4>
|
|
<dl class="parameters">
|
|
<dt><code>value</code> <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a></dt>
|
|
<dd><p>The value of the updated progress.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
<div class="contribution d-print-none">
|
|
</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>
|