mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-26 12:40:03 +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.
97 lines
4.1 KiB
C#
97 lines
4.1 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/
|
|
* ======================================================================*/
|
|
|
|
namespace Opc.Ua.Di.Server.Locking
|
|
{
|
|
/// <summary>
|
|
/// Application-facing facade over the OPC 10000-100 §10.5 locking
|
|
/// service. The service tracks ownership of every
|
|
/// <c>TopologyElementType.Lock</c> in the address space, enforces
|
|
/// timeouts, and propagates state changes to the
|
|
/// <see cref="LockingServicesState.Locked"/> /
|
|
/// <see cref="LockingServicesState.LockingClient"/> /
|
|
/// <see cref="LockingServicesState.LockingUser"/> /
|
|
/// <see cref="LockingServicesState.RemainingLockTime"/> properties.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// Implementations <em>must</em> be thread-safe — the four lock
|
|
/// methods are typically invoked from per-session worker threads
|
|
/// and the time-tick refresher runs from a background timer.
|
|
/// </para>
|
|
/// <para>
|
|
/// The default <see cref="DefaultLockService"/> implementation
|
|
/// keeps a per-element record (client tag, owning session, expiry
|
|
/// timestamp) and uses the session-close events emitted by the
|
|
/// hosting <c>ISessionManager</c> to release locks when their
|
|
/// owning session disappears.
|
|
/// </para>
|
|
/// </remarks>
|
|
public interface ILockService
|
|
{
|
|
/// <summary>
|
|
/// Returns a snapshot of the current lock state for the
|
|
/// topology element identified by <paramref name="elementId"/>.
|
|
/// Returns <see langword="false"/> for <c>Locked</c> if no
|
|
/// lock has ever been acquired (or the lock has expired).
|
|
/// </summary>
|
|
LockState GetState(NodeId elementId);
|
|
|
|
/// <summary>
|
|
/// Attempts to acquire the lock on the supplied element on
|
|
/// behalf of the calling session. Returns one of the
|
|
/// <see cref="LockStatus"/> codes; the lock is held for the
|
|
/// service's configured default timeout (see
|
|
/// <see cref="DefaultLockService"/>).
|
|
/// </summary>
|
|
int InitLock(
|
|
ISystemContext context,
|
|
NodeId elementId,
|
|
string clientContext);
|
|
|
|
/// <summary>
|
|
/// Renews an existing lock owned by the calling session.
|
|
/// Resets the timeout to the configured default.
|
|
/// </summary>
|
|
int RenewLock(ISystemContext context, NodeId elementId);
|
|
|
|
/// <summary>
|
|
/// Releases a lock owned by the calling session.
|
|
/// </summary>
|
|
int ExitLock(ISystemContext context, NodeId elementId);
|
|
|
|
/// <summary>
|
|
/// Forcibly releases a lock regardless of ownership. Intended
|
|
/// for administrative use after a client has crashed and
|
|
/// abandoned a lock.
|
|
/// </summary>
|
|
int BreakLock(ISystemContext context, NodeId elementId);
|
|
}
|
|
}
|