Files
UA-.NETStandard/samples/PubSub/ConsoleReferencePubSubClient
Copilot d525bc3f28 Bound reconnect cleanup and organize samples by domain (#4276)
# Description

This PR fixes bounded ManagedSession reconnect cleanup and reorganizes
the sample applications into domain-focused folders.

## Reconnect cleanup

- Bounds reconnect integration cleanup with independent 30-second close
and dispose limits.
- Sends `CloseSession` through the awaited transport request path during
`Session.DisposeAsync`.
- Preserves explicit `Session.CloseAsync` behavior that waits for or
cancels outstanding publish requests.
- Covers the disposal request path with a regression test.

## Sample organization

- `samples/OpenUsd`: `GeneratorServer`, `SiteCompositionServer`
- `samples/Redundancy`: `RedundantClient`, `RedundantServer`,
`RedundantPubSub`
- `samples/Isa95`: `MinimalIsa95Server`
- `samples/MinimalApi`: `MinimalBoilerServer`, `MinimalCalcServer`,
`MinimalClient`
- `samples/DI`: `PumpDeviceIntegrationServer`
- `samples/Lds`: `ConsoleLdsServer`
- `samples/Reference`: `ConsoleReferenceClient`,
`ConsoleReferenceServer`
- `samples/PubSub`: `ConsoleReferencePubSubClient`

`UA.slnx` now exposes the same requested domain groups. Project
references, tests, runtime sample probes, CI workflows, Dockerfiles,
Compose files, helper scripts, and documentation were updated to the new
paths. `samples/Robotics/MinimalRobotServer` remains under `Robotics`.

## Validation

- `dotnet build UA.slnx`
- 3 Redundancy short-haul sample tests
- 70 DI sample tests
- 914 OpenUSD tests
- 1 WotCon model-materialization test
- 137 AOT tests
- `docker compose config` for all 6 moved Redundancy Compose files

## Related Issues

- Fixes #4273

## Checklist

- [ ] 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.
- [x] I have added all necessary documentation.
- [x] I have verified that my changes do not introduce new build or
analyzer warnings.
- [x] I built the complete `UA.slnx` solution locally.
- [ ] I ran all tests locally against at least .NET Framework and .NET
10.
- [ ] I fixed all failing and flaky tests in the CI pipelines and all
CodeQL warnings.
- [x] I have addressed all PR feedback received.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: marcschier <11168470+marcschier@users.noreply.github.com>
Co-authored-by: Marc Schier <mschier@microsoft.com>
Co-authored-by: Marc Schier <marcschier@users.noreply.github.com>
Copilot-Session: a2c2838f-74ae-4997-a1d4-50574d9e0636
2026-08-21 04:35:47 +00:00
..

Console Reference PubSub

A single, self-contained OPC UA Part 14 PubSub reference application built on the fluent PubSubApplicationBuilder + dependency injection + .NET Generic Host surface. One executable exposes three command-line-selectable modes, and publishes as a NativeAOT-ready single-file executable.

Modes

ConsoleReferencePubSubClient <mode> [options]
Mode Purpose
publisher Publishes a built-in sample DataSet over UDP/UADP or MQTT (UADP/JSON).
subscriber Receives DataSets and logs each decoded message to the console.
external Bridges an external OPC UA server to PubSub via the Opc.Ua.PubSub.Adapter library (publisher / subscriber / responder direction).

publisher

ConsoleReferencePubSubClient publisher --profile udp-uadp --interval 1000
ConsoleReferencePubSubClient publisher --profile mqtt-json --endpoint mqtt://localhost:1883

Options: --profile udp-uadp|mqtt-uadp|mqtt-json, --config-file <xml>, --publisher-id, --writer-group-id, --data-set-writer-id, --endpoint, --interval.

subscriber

ConsoleReferencePubSubClient subscriber --profile udp-uadp

Options: --profile, --config-file <xml>, --publisher-id-filter, --writer-group-id-filter, --data-set-writer-id-filter, --endpoint.

external

Bridges an external OPC UA server (defaults to the repository's ConsoleReferenceServer at opc.tcp://localhost:62541/Quickstarts/ReferenceServer; override with --endpoint or the OPCUA_EXTERNAL_ENDPOINT environment variable).

# Read an external server and publish its values (cyclic Read each cycle)
ConsoleReferencePubSubClient external --mode publisher --read-mode cyclic

# Read via a client Subscription cache, one subscription per WriterGroup
ConsoleReferencePubSubClient external --mode publisher --read-mode subscription --affinity writergroup

# Write received PubSub values back to an external server
ConsoleReferencePubSubClient external --mode subscriber

# Map an inbound PubSub Action to an external server method call
ConsoleReferencePubSubClient external --mode responder

# Run a bidirectional bridge in one process
ConsoleReferencePubSubClient external --mode publisher,subscriber

Options: --mode publisher|subscriber|responder (comma-separated list accepted), --read-mode cyclic|subscription, --affinity writergroup|datasetwriter, --endpoint <external server>, --pubsub-endpoint <udp url>, --hot-reload.

Hot reload

Add --hot-reload to the external bridge to run the opt-in live reconfiguration demo:

ConsoleReferencePubSubClient external --mode publisher,subscriber --hot-reload

The bridge writes pubsub-config.xml next to the executable before starting and loads adapter options from the copied appsettings.json in the same directory. Edit and save either file while the bridge is running:

  • appsettings.json: change ExternalPublisher:ReadMode from Cyclic to Subscription, or change ExternalPublisher:Affinity to DataSetWriter, to rewire the external-server publisher options.
  • pubsub-config.xml: add or remove a DataSetWriter to change the PubSub topology. The watching XML store raises a configuration change and the adapter incrementally rewires the affected binding.

The samples connect to the external server unsecured (SecurityMode.None) for zero-config interop. A production bridge must use SignAndEncrypt with a provisioned application instance certificate. See docs/PubSub.md external-server adapter section.

Build / publish

dotnet build samples/PubSub/ConsoleReferencePubSubClient/ConsoleReferencePubSubClient.csproj
dotnet publish samples/PubSub/ConsoleReferencePubSubClient/ConsoleReferencePubSubClient.csproj -r win-x64

See docs/PubSub.md for the full PubSub guide.