UA-.NETStandard/Libraries/Opc.Ua.Client/Subscription/SubscriptionOptions.cs

/* ========================================================================
 * 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;

namespace Opc.Ua.Client.Subscriptions
{
    /// <summary>
    /// Subscription options
    /// </summary>
    public record class SubscriptionOptions
    {
        /// <summary>
        /// The subscription is disabled
        /// </summary>
        public bool Disabled { get; init; }

        /// <summary>
        /// Set keep alive count
        /// </summary>
        public uint KeepAliveCount { get; init; }

        /// <summary>
        /// The life time of the subscription in counts of
        /// publish interval.
        /// LifetimeCount shall be at least 3*KeepAliveCount.
        /// </summary>
        public uint LifetimeCount { get; init; }

        /// <summary>
        /// Set desired priority of the subscription
        /// </summary>
        public byte Priority { get; init; }

        /// <summary>
        /// Set desired publishing interval
        /// </summary>
        public TimeSpan PublishingInterval { get; init; }

        /// <summary>
        /// Set desired publishing enabled
        /// </summary>
        public bool PublishingEnabled { get; init; }

        /// <summary>
        /// Set max notifications per publish
        /// </summary>
        public uint MaxNotificationsPerPublish { get; init; }

        /// <summary>
        /// Set min lifetime interval
        /// </summary>
        public TimeSpan MinLifetimeInterval { get; init; }

        /// <summary>
        /// When the V2 manager restores this subscription via
        /// <see cref="ISubscriptionManager.LoadAsync"/> with
        /// <c>transferSubscriptions: true</c>, request the server to
        /// send the latest cached value of every monitored item as
        /// part of the take-over (OPC UA Part 4 §5.13.7
        /// <c>TransferSubscriptions</c>'s <c>sendInitialValues</c>
        /// argument). Defaults to <c>false</c>: the server only sends
        /// values that arrived after the subscription was suspended,
        /// matching the post-disconnect semantics that the V2 manager
        /// expects for failover-on-recreate.
        /// </summary>
        public bool SendInitialValuesOnTransfer { get; init; }

        /// <summary>
        /// Controls how the client reacts to an unsolicited
        /// <c>Good_SubscriptionTransferred</c> StatusChangeNotification
        /// from the server. Defaults to
        /// <see cref="SubscriptionRecoveryPolicy.ReportOnly"/> which
        /// matches the spec-strict behaviour (OPC UA Part 4 §5.14.7).
        /// Set to
        /// <see cref="SubscriptionRecoveryPolicy.RecreateOnUnsolicitedTransfer"/>
        /// to automatically recreate the subscription on the same
        /// session when the notification arrives without the client
        /// having initiated a TransferSubscriptions request — this
        /// addresses server quirks that leave subscriptions stuck.
        /// </summary>
        public SubscriptionRecoveryPolicy RecoveryPolicy { get; init; }
    }
}