mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-22 01:26:20 +08:00
Marc Schier
4756e7c245
This PR implements the **OPC UA Device Integration (DI, OPC 10000-100)** companion-spec library trio (`Opc.Ua.Di` / `Opc.Ua.Di.Server` / `Opc.Ua.Di.Client`) plus a worked example (`Applications/MinimalPumpServer`) demonstrating the OPC 40223 Pumps companion specification end-to-end with full simulation. It also closes 11 fluent-API gaps in `Opc.Ua.Server.Fluent`, three source-generator bugs, integrates the DI layer into the unified `services.AddOpcUa()` Microsoft.Extensions DI hosting pattern, and adds 250+ new tests. **Worked example — `Applications/MinimalPumpServer/`** - AOT-compatible console host using `Host.CreateApplicationBuilder` + `AddOpcUa()`. - `PumpNodeManager` inherits from `DiNodeManager`; multi-namespace (DI + Machinery + Pumps) via runtime NodeSet2 loading and `ModelLoaderBuilder`. - Demonstrates declarative second-pump creation via `.ConfigureDevicesFor<PumpNodeManager>(...)` and software-package seeding from the same configurator. - Full simulation: pressure, temperatures, power, flow, efficiency, level, cavitation/overheat fault injection, alarm setup, NAMUR-style supervision. **Documentation** - `Docs/Opc.Ua.Di/` — README, DeviceBuilder, Hosting, LockService, SoftwareUpdate, ClientHelpers (6 new developer guides). - `Docs/Opc.Ua.Di/ComplianceMatrix.md` — every DI declaration mapped to In-v1 / Generated / Deferred / Excluded. - `Docs/CompanionSpecLibraries.md` — packaging guide for new companion-spec libraries. - `Docs/FluentApiGaps.md` — historical record of G1–G11. - `Docs/SourceGeneratedNodeManagers.md` updated for richer node managers. - `Docs/plans/StateMachineBuilder.md` — deferred state-machine builder design.
75 lines
3.3 KiB
C#
75 lines
3.3 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Opc.Ua.Di.Server.Hosting
|
|
{
|
|
/// <summary>
|
|
/// Orchestrator that resolves
|
|
/// <see cref="IDiPostSetupConfigurator"/> instances from the
|
|
/// service provider, filters them by manager type, and invokes
|
|
/// each in registration order with fail-fast exception semantics.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// Registered as a singleton by
|
|
/// <c>OpcUaServerBuilderExtensions.AddOpcUaDi</c>. DI-aware node
|
|
/// manager factories (<see cref="DiNodeManagerFactory"/>,
|
|
/// <c>Pumps.PumpNodeManagerFactory</c>) inject this service through
|
|
/// their constructor and pass it on to the manager they produce;
|
|
/// the manager then calls <c>RunAsync</c> at the end of its own
|
|
/// <c>CreateAddressSpaceAsync</c> override.
|
|
/// </para>
|
|
/// <para>
|
|
/// Plain DI servers can also resolve the runner manually for
|
|
/// testing, but the production path is always through the
|
|
/// factory + manager.
|
|
/// </para>
|
|
/// </remarks>
|
|
public interface IDiPostSetupRunner
|
|
{
|
|
/// <summary>
|
|
/// Runs every registered <see cref="IDiPostSetupConfigurator"/>
|
|
/// whose <see cref="IDiPostSetupConfigurator.TargetManagerType"/>
|
|
/// matches (via <see cref="System.Type.IsAssignableFrom"/>) the
|
|
/// runtime type of <paramref name="manager"/>. Configurators run
|
|
/// in registration order; the first exception aborts startup.
|
|
/// </summary>
|
|
/// <param name="manager">The active DI node manager.</param>
|
|
/// <param name="cancellationToken">Cancellation token from the
|
|
/// hosted service.</param>
|
|
/// <exception cref="System.Exception">
|
|
/// Re-thrown from any configurator that fails. Startup aborts.
|
|
/// </exception>
|
|
ValueTask RunAsync(DiNodeManager manager, CancellationToken cancellationToken);
|
|
}
|
|
}
|