Files
Marc Schier 87012a147f Machinery: add bounded inspection and result transfers (#4804)
# Description

- Add opt-in bounded browsing and strict reads with original source,
status, timestamp, and structured-value evidence. Preserve the existing
tolerant constructors and convenience projections, and wire options
through session extensions, factories, and hosting registration.
- Add selected-result streaming downloads with byte/request limits and
independent cleanup, using `TemporaryFileTransferClient.CopyToAsync`
from the client/server predecessor. Retain the detailed transfer
regressions in the Machinery test layer.
- Expose genuinely null unpublished result slots, carry the two
Machinery sample updates, and include the complete Machinery guide and
package README changes.

## Related Issues

- Related tracking issue: #4461; this extraction does not close it.
- Frozen source PR: #4462; this extraction does not close or modify it.
- Immediate predecessor: #4803 (`marcschier-extract-amb-changes`). The
earlier dependencies are client/server #4802 and core/types #4801.

## Checklist

_Put an `x` in the boxes that apply. You can complete these step by step
after opening the PR._

- [ ] 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.
- [ ] I have added tests that prove my fix is effective or that my
feature works and increased code coverage.
- [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.
- [ ] I fixed **all** failing and flaky tests in the CI pipelines and
**all** CodeQL warnings.
- [ ] I have addressed **all** PR feedback received.
2026-10-16 12:24:35 +02:00

120 lines
5.1 KiB
C#

/* ========================================================================
* Copyright (c) 2005-2026 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;
using System.Globalization;
using System.IO;
using System.Threading;
using MachinerySample;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Opc.Ua.Machinery.Server;
HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
builder.Logging.ClearProviders();
builder.Logging.AddConsole();
int port = 62546;
if (builder.Configuration["port"] is { } portOption &&
(!int.TryParse(portOption, NumberStyles.None, CultureInfo.InvariantCulture, out port) || port is < 1 or > 65535))
{
await Console.Error.WriteLineAsync("--port must be an integer from 1 through 65535.").ConfigureAwait(false);
return 2;
}
string hostName = builder.Configuration["host"] is { Length: > 0 } configuredHost ? configuredHost : "localhost";
if (Uri.CheckHostName(hostName) == UriHostNameType.Unknown)
{
await Console.Error.WriteLineAsync("--host must be a host name or IP address.").ConfigureAwait(false);
return 2;
}
string? pkiRoot = builder.Configuration["pki-root"];
if (pkiRoot is not null && !Path.IsPathFullyQualified(pkiRoot))
{
await Console.Error.WriteLineAsync("--pki-root must be an absolute path.").ConfigureAwait(false);
return 2;
}
bool autoAccept = true;
if (builder.Configuration["autoaccept"] is { } trustOption && !bool.TryParse(trustOption, out autoAccept))
{
await Console.Error.WriteLineAsync("--autoaccept must be true or false.").ConfigureAwait(false);
return 2;
}
int runSeconds = 0;
if (builder.Configuration["run-seconds"] is { } runOption &&
(!int.TryParse(runOption, NumberStyles.None, CultureInfo.InvariantCulture, out runSeconds) ||
runSeconds is < 1 or > 3600))
{
await Console.Error.WriteLineAsync("--run-seconds must be an integer from 1 through 3600.").ConfigureAwait(false);
return 2;
}
// The simulation owns the running machine: it drives both OPC 40001-1 state
// machines and publishes the OPC 40001-101 results, and it supplies the ISA-95
// Job Control V2 provider the OPC 40001-3 verbs bind to.
builder.Services.AddSingleton<PressSimulation>();
builder.Services.AddHostedService(sp => sp.GetRequiredService<PressSimulation>());
builder.Services.AddSingleton(
sp => new PressConfigurator(sp.GetRequiredService<PressSimulation>()));
builder.Services
.AddOpcUa()
.AddServer(options =>
{
options.ApplicationName = "MachineryServer";
options.ApplicationUri = "urn:localhost:OPCFoundation:MachineryServer";
options.ProductUri = "uri:opcfoundation.org:MachineryServer";
options.AutoAcceptUntrustedCertificates = autoAccept;
if (pkiRoot is not null)
{
options.PkiRoot = pkiRoot;
}
options.EndpointUrls.Add(new UriBuilder("opc.tcp", hostName, port, "/MachineryServer").Uri.AbsoluteUri);
})
// AddMachinery claims the Device Integration address space, and - because
// the Jobs part is selected - the ISA-95 namespaces too. A server that
// already owns either loads the models into its own manager with
// nodes.AddMachineryTypeSystem(context, parts) and drives them through
// ConfigureMachineryFor<TNodeManager>() instead.
.AddMachinery(options => options.Parts = MachineryParts.All)
.ConfigureMachinery(async (context, ct) =>
{
PressConfigurator configurator = context.GetRequiredService<PressConfigurator>();
await configurator.ConfigureAsync(context, ct).ConfigureAwait(false);
});
using IHost host = builder.Build();
using var runLifetime = new CancellationTokenSource();
if (runSeconds > 0)
{
runLifetime.CancelAfter(TimeSpan.FromSeconds(runSeconds));
}
await host.RunAsync(runLifetime.Token).ConfigureAwait(false);
return 0;