/* ========================================================================
* 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/
* ======================================================================*/
#nullable enable
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
namespace Opc.Ua.Client.Subscriptions.Fakes
{
///
/// Hand-rolled fake for . Records every
/// invocation and lets tests override return behaviour via callback
/// fields. Replaces Mock<IMessageAckQueue>.
///
internal sealed class FakeMessageAckQueue : IMessageAckQueue
{
public List QueuedAcks { get; } = [];
public List CompletedSubscriptions { get; } = [];
public int UpdateCalls { get; private set; }
///
/// Optional override for . If null, returns
/// completed.
///
public Func? OnQueueAsync { get; set; }
///
/// Optional override for . If null,
/// returns completed.
///
public Func? OnCompleteAsync { get; set; }
public ValueTask QueueAsync(SubscriptionAcknowledgement ack,
CancellationToken ct = default)
{
QueuedAcks.Add(ack);
return OnQueueAsync?.Invoke(ack, ct) ?? default;
}
public ValueTask CompleteAsync(uint subscriptionId,
CancellationToken ct = default)
{
CompletedSubscriptions.Add(subscriptionId);
return OnCompleteAsync?.Invoke(subscriptionId, ct) ?? default;
}
///
/// Records the subscription ids dropped via
/// so tests can assert
/// stale-ack pruning happened during recovery.
///
public List DroppedSubscriptions { get; } = [];
public int DropPendingForSubscription(uint subscriptionId)
{
DroppedSubscriptions.Add(subscriptionId);
return QueuedAcks.RemoveAll(
ack => ack.SubscriptionId == subscriptionId);
}
public void Update()
{
UpdateCalls++;
}
///
/// Test-controlled value for the
/// setter the
/// subscription dispatcher reads to decide whether to perform the
/// pooled-notification reuse walk.
///
public bool PoolNotifications { get; set; }
}
}