Files
Marc Schier eb40a59566 More format and diagnostic fixes (#3780)
Drive the solution to zero warnings / zero errors with analyzers on,
promote the consistently-fixed rules to error, and lock in coverage
on the only line of new logic.
2026-05-26 06:06:09 +02:00

106 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/
* ======================================================================*/
using System;
using System.Collections.Generic;
namespace Opc.Ua.Lds.Server
{
/// <summary>
/// In-memory record of a server registered with the LDS via
/// <see cref="LdsServer.RegisterServerAsync"/> or
/// <see cref="LdsServer.RegisterServer2Async"/>.
/// </summary>
/// <remarks>
/// Registrations are keyed by <see cref="ServerUri"/>. Setting <see cref="IsOnline"/>
/// to <c>false</c> in a subsequent register call removes the entry from the store.
/// </remarks>
public sealed class RegistrationEntry
{
/// <summary>
/// The server's <c>ApplicationUri</c>. Acts as the unique key for the registration.
/// </summary>
public string ServerUri { get; set; }
/// <summary>
/// The server's product URI.
/// </summary>
public string ProductUri { get; set; }
/// <summary>
/// The server's localized application names.
/// </summary>
public IList<LocalizedText> ServerNames { get; set; } = [];
/// <summary>
/// The server's <see cref="ApplicationType"/>. LDS rejects
/// <see cref="ApplicationType.Client"/> registrations.
/// </summary>
public ApplicationType ServerType { get; set; } = ApplicationType.Server;
/// <summary>
/// Optional gateway server URI for non-OPC UA server registrations.
/// </summary>
public string GatewayServerUri { get; set; }
/// <summary>
/// One or more discovery endpoint URLs.
/// </summary>
public IList<string> DiscoveryUrls { get; set; } = [];
/// <summary>
/// Optional file path used to keep the registration alive while the file exists.
/// </summary>
public string SemaphoreFilePath { get; set; }
/// <summary>
/// Whether the server is currently online and accepting connections.
/// </summary>
public bool IsOnline { get; set; }
/// <summary>
/// Wall-clock timestamp of the most recent register call.
/// </summary>
public DateTime LastSeenUtc { get; set; }
/// <summary>
/// The capabilities advertised by the registered server, derived from the most
/// recent <c>MdnsDiscoveryConfiguration</c> if any. Empty for plain
/// <c>RegisterServer</c> calls.
/// </summary>
public IList<string> ServerCapabilities { get; set; } = [];
/// <summary>
/// The mDNS server name advertised by the most recent
/// <c>MdnsDiscoveryConfiguration</c>. Null for plain <c>RegisterServer</c> calls.
/// </summary>
public string MdnsServerName { get; set; }
}
}