romanettandClaude Opus 5.5 6a156dfa2e Client: fewer allocations per request (shared timeout timer, pooled state machines, fewer buffer collections) (#4849)
# Description

Reduces client allocations per request. A client GC investigation found
that a gen0 pause on the request path costs about 1.1 ms however much
survives. That makes the number of collections, and therefore the bytes
allocated per request, what matters. At the default gen0 budget, each KB
removed from a request removes about one collection in eight.

Read-1 client bytes/request (`perf/ServerLoadHarness run --scenario read
--nodes 1 --sessions 20`, builds run alternately, 3–4 rounds each,
medians). Bytes/op repeated within ±5 B between rounds, while req/s
varied 3x from other load on the machine, so throughput is not reported.

| Commit | Change | classic | managed |
|---|---|---|---|
| master 484596c2a | | 1983 | – |
| 77e2ca0b5 | One timeout timer per client channel instead of an
`ITimer` per request | 1871 | – |
| 730cec198 | `BinaryDecoder` returns `Array.Empty<T>()` for zero-length
arrays (empty StringTable/DiagnosticInfos in every response header); -1
still decodes as null | 1817 | 1913 |
| 2135f7d7f | `SealSymmetricMessage` secures the encoded chunks in place
instead of copying them into a second `BufferCollection` | 1750 | 1839 |
| 70655ffa0 | A response that is a single final chunk is decoded from
the chunk directly, without saving it into a `BufferCollection` | 1675 |
1767 |
| 8edf352b9 | `ChannelAsyncOperation` is its own `IValueTaskSource` (no
`CompletionWaiter`) and locks itself (no `Lock`) | 1599 | 1686 |
| 4528d0467 | ManagedSession releases its reader lock from a pooled
state machine (.NET 6+) instead of a second task continuation | 1598 |
1598 |
| 41859b64a | `UaSCUaBinaryClientChannel.SendRequestAsync` uses
`PoolingAsyncValueTaskMethodBuilder` (.NET 6+), like `TcpByteTransport`
| 1426 | 1425 |
| b3d09802d | Review: no request admitted after Dispose;
`ChannelAsyncOperation` keeps its private `Lock` again (DeveloperGuide:
never expose locks) | 1472 | – |
| 71ec7b396 | Review: `return [];` for empty arrays | – | – |

In total: **classic 1983 → 1472 B (−26 %)**. The managed client gets the
same ~49 B back from the restored `Lock`.

### What reviewers should look at
- **Timeouts:** each operation records a deadline. The channel keeps one
timer set for the earliest pending deadline. When it fires it times out
every request whose deadline has passed and re-arms for the next. The
operation is added to `m_requests` before it schedules its deadline, and
the scan resets the scheduled time under the same lock, so no new
request is missed. With equal timeouts a new request is never the
earliest, so it only reads the scheduled time. The public
`ChannelAsyncOperation` constructors still create a timer of their own.
- **Dispose of the client channel** now fails the pending requests with
BadSecureChannelClosed. Without a timer per request they would otherwise
never complete. Requests are registered under the timeout lock and
rejected once the channel is disposed, so a request racing Dispose is
either rejected or drained.
- **Pooled value tasks:** the value tasks from `SendRequestAsync` and
from ManagedSession service calls must now be awaited once. Awaiting one
twice used to happen to work because they were backed by a task.
`WaitForCompletionAsync` was already documented as one wait at a time.
- **Not done here** (needs generator or codec API work): reusing the
BinaryEncoder/BinaryDecoder objects (~200 B), pooling the generated
`SessionClient.ReadAsync` box (~195 B), and the second `ResponseHeader`
per response.

## Related Issues

- No issue. Follow-up of the client GC investigation.

## Checklist

- [x] I have signed the
[CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf)
and read the
[CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md)
doc.
- [x] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- `PendingOperationsTimeOutAtTheirOwnDeadlinesAsync` (two deadlines on
one FakeTimeProvider)
- `RequestAfterDisposeFailsInsteadOfWaitingAsync`,
`RequestsRacingDisposeAllCompleteAsync`
  - `ReadZeroLengthArraysReturnsEmptyWithoutAllocating`
- [x] I have added all necessary documentation.
- [x] I have verified that my changes do not introduce (new) build or
analyzer warnings.
- [ ] I ran **all** tests locally using the **UA.slnx** solution against
at least .net **framework** and .net **10**, and all passed.
- net10.0: Core 6450, Core.Encoders 2947, Types 13928, Client 3226
passed. One Client test (`SessionBindingLiveTests` "incarnation") timed
out once while the benchmarks were loading the machine and passed when
its fixture was rerun alone (96/0). net48: Opc.Ua.Client and its
dependencies build clean; net48 tests not run locally.
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [ ] I have addressed **all** PR feedback received.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-20 05:16:17 +02:00
2020-05-15 19:41:55 +02:00
2021-07-26 10:06:51 +03:00

OPC UA .NET Standard Stack

Release NuGet Downloads CI CodeQL Coverage Nightly Stress Tests Connection Stability Foreign Interop HA Long-Haul CTT Regression

🆕 This is version 2.0 of the OPC UA .NET Standard Stack (current master).

Looking for the supported 1.x release? It lives on the master378 branch (last release: 1.5.378). All new feature work happens here on master; master378 continues to receive security and critical-bug fixes for the 1.x line.

The official OPC Foundation reference implementation of OPC UA for .NET — a certified, cross-platform stack with client, server, PubSub, GDS, complex types, and source-generated tooling. Used in production across industrial control, manufacturing, energy, and IoT systems.

📦 What it is

  • A full-stack OPC UA implementation — Core / Client / Server / PubSub / GDS / LDS / Complex Types / Device Integration / Positioning libraries built on .NET, with UA-TCP and HTTPS transports.
  • Cross-platform — runs on .NET 10, .NET 9, .NET 8 (LTS), .NET Framework 4.8; ships Native-AOT-friendly assemblies.
  • Certified for compliance — the reference server has been certified through an OPC Foundation Certification Test Lab and is continuously verified against the latest Compliance Test Tool (CTT).
  • Companion-spec coverage — Part 9 (Alarms & Conditions), Part 10 (Programs), Part 11 (Historical Access), Part 13 (Aggregates), Part 16 (State Machines), Part 17 (Alias Names), Part 18 (Role Management), Part 20 (File Transfer), Part 100 (Device Integration), Part 110 (Asset Management Basics), Parts 210/211 (Relative Spatial Location and Global Positioning), OPC-10030 (ISA-95 Common Model) with OPC-10031-4 Job Control V1/V2, OPC 30270 / OPC UA for Asset Administration Shell V2 and V3, OPC 10100-1 (WoT Connectivity), Part 200 (Industrial Automation), OPC 40001-1/-2/-3/-4/-101 (Machinery with Process Values, Job Management, Energy and Result Transfer), OPC 34100 (Energy Consumption Management), OPC 30081 (PA-DIM), OPC 40010-1 (Robotics), OPC 40100-1/-2 (Machine Vision control and asset management), OPC 40501-1 and OPC 40505 (Machine Tools and independent wireless peripherals), OPC 40210 (Geometric Measurement Systems, with its documented upstream Production-facet exception), OPC 40020-1 (Cranes and Hoists), OPC 40223 (Pumps and Vacuum Pumps), OPC 30010 (AutoID Devices), OPC 40200 (Weighing Technology) with OPC 30050 (PackML).
  • Hosting and code generation — Microsoft.Extensions.DependencyInjection hosting (services.AddOpcUa()), fluent server + client builders, source-generated NodeManagers and DataTypes, and an MCP server so LLMs / Copilot can drive an OPC UA client.

For the full feature breakdown see OPC UA Profiles and Facets and the What's New in 2.0 tour.

🚀 Getting started

To run a first OPC UA client and server, from NuGet packages or from the samples in this repository, follow Getting started. The documentation index then leads from the core concepts to advanced and experimental features.

The recycling operator console demonstrates live browser monitoring, native companion-specification inspection, material genealogy, and authorized controls over the synthetic recycling line.

You need the .NET 10 SDK to build the repo. From the repository root:

dotnet restore UA.slnx
dotnet build UA.slnx

For the supported target frameworks and platform notes see the Developer Guide. The official NuGet packages are published to nuget.org under the OPCFoundation.NetStandard prefix — the meta package OPCFoundation.NetStandard.Opc.Ua pulls in everything, or reference individual packages directly, e.g. OPCFoundation.NetStandard.Opc.Ua.Client for clients or OPCFoundation.NetStandard.Opc.Ua.Server for servers. Preview builds from every successful master build are available from the GitHub Packages NuGet feed, which is the only feed they are published to. nuget.org receives a version only through a manually approved promotion from a release/<major>.<minor> branch — that is where the 2.0.0-preview.N packages already on nuget.org came from, via the earlier release/2.0.0 line. To use those, enable prerelease packages and float with 2.0.0-preview.* until 2.0.0 is released. The XRegistry, WoT Connectivity, Robotics, CranesHoists, Redundancy, Positioning, OpenUSD, and AI package families, the Vision.OpenUsd renderer, and the Robotics MCP extension remain preview packages when the root version is promoted to a stable version, and keep their own -preview.N versions on nuget.org. This includes all CranesHoists model/server/client/MCP packages and their Debug variants. The Vision, MachineVision, MachineTool (including WMTP), and GMS model/client/server packages and their MCP packages follow the root version without a preview-only override; development builds still inherit the root prerelease version. See docs/ReleaseProcess.md for how and when stable versions are released.

Samples

The platform-independent sample applications show how to use the stack's core services and companion models in client/server workflows. More applications, including platform-specific examples, are available in the companion OPC UA .NET Samples repository.

Developer tools

  • OPC UA MCP Server — installable .NET tool and container exposing OPC UA client operations to LLMs and Copilot. Embeddable libraries provide Part 4 services, PubSub, diagnostics, Robotics and Vision, plus industrial companion profiles for AMB, Machinery, Scales, Pumps, AutoID, Device Integration, ISA-95 and Positioning. The WoT and xRegistry profiles add asset/registry management and bounded document validation, planning and NodeSet conversion. Stack workflow profiles provide GDS/credential issuance, roles/users, files, alarms, history, schemas, and host-authorized PubSub and live WoT execution.

🔧 Migrating from 1.5.378 to 2.0

The 2.0 release introduces breaking API changes, and comes with a full prescriptive migration guide that links to per-area documentation for the migration sub-topics.

Most of the mechanical migration work is automated:

  • OPCFoundation.NetStandard.Opc.Ua.MigrationAnalyzer NuGet — install it in your project to get 26 analyzer rules through UA0030 (excluding UA0013, UA0016, UA0017, and the shim-only UA0029) plus one-click code fixes for the patterns in the guide. Setup steps are in the package's NugetREADME.md.
  • Migration agent skill — the opcua-v20-migration skill walks Copilot / Claude / any coding agent through installing the NuGet, running dotnet format analyzers to apply auto-fixes, and handling the remaining manual changes. It selects the migration sub-document for each symptom.

Copilot CLI discovers the skill automatically inside a clone. To install it for use in any repository:

copilot plugin marketplace add OPCFoundation/UA-.NETStandard
copilot plugin install opcua-v20-migration@opcua-dotnet

If you are still on 1.x and not ready to upgrade, stay on the master378 branch — it continues to receive security and critical-bug fixes.

🤝 Contributing and license

Community contributions are welcome. Fork the repository, make your changes on a branch, and open a pull request; see CONTRIBUTING.md for the contribution workflow.

Contributors must sign the OPC Foundation Contributor License Agreement (CLA). The CLA "I AGREE" gate is presented automatically on your first PR.

The project is licensed under the OPC Foundation MIT License. Report security vulnerabilities via the process documented in SECURITY.md.

📚 Further reading

S
Description
OPC Unified Architecture .NET Standard
Readme
296 MiB
Languages
C# 99.4%
PowerShell 0.2%