mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-23 10:23:13 +08:00
Marc Schier
2960388560
Update license headers to copy right year 2025, replace RCL/GPL headers with MIT, replace the nuget license with MIT (via license expression).
92 lines
4.1 KiB
C#
92 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;
|
|
|
|
namespace Opc.Ua.Server
|
|
{
|
|
/// <summary>
|
|
/// Provides an optionally durable queue for events used by <see cref="EventQueueHandler"/> and created by <see cref="IMonitoredItemQueueFactory"/>.
|
|
/// If long running operations are performed by the queue the operation should be performed in a separate thread to avoid blocking the main thread.
|
|
/// Min Enqueue performance: no long running operations, fast enqueue until max queue size is reached
|
|
/// Min Dequeue performance: MaxNotificationsPerPublish * 3 with no delay, in a cycle of 3 * MinPublishingInterval in the least favorable condition (single MI, continous publishing (MinPublishingInterval --, MaxNotificationsPerPublish ++), very large queue)
|
|
/// Set Queue size is allowed to be slow
|
|
/// </summary>
|
|
public interface IEventMonitoredItemQueue : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// The Id of the MonitoredItem associated with the queue
|
|
/// </summary>
|
|
uint MonitoredItemId { get; }
|
|
|
|
/// <summary>
|
|
/// True if the queue is in durable mode and persists the queue values / supports a large queue size
|
|
/// </summary>
|
|
bool IsDurable { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the current queue size.
|
|
/// </summary>
|
|
uint QueueSize { get; }
|
|
|
|
/// <summary>
|
|
/// Gets number of elements actually contained in value queue.
|
|
/// </summary>
|
|
int ItemsInQueue { get; }
|
|
|
|
/// <summary>
|
|
/// Sets the queue size. If the queue contained entries before strip the existing
|
|
/// </summary>
|
|
/// <param name="queueSize">The new queue size.</param>
|
|
/// <param name="discardOldest">if true remove oldest entries from the queue when the queue size decreases, else remove newest</param>
|
|
void SetQueueSize(uint queueSize, bool discardOldest);
|
|
|
|
/// <summary>
|
|
/// Checks the last 1k queue entries if the event is already in there
|
|
/// used to detect duplicate instances of the same event being reported via multiple paths.
|
|
/// </summary>
|
|
/// <param name="instance">the event to chack for duplicates</param>
|
|
/// <returns>true if event already in queue</returns>
|
|
bool IsEventContainedInQueue(IFilterTarget instance);
|
|
|
|
/// <summary>
|
|
/// Adds the value to the queue.
|
|
/// </summary>
|
|
/// <param name="value">The value to queue.</param>
|
|
void Enqueue(EventFieldList value);
|
|
|
|
/// <summary>
|
|
/// Dequeue the oldest value in the queue.
|
|
/// </summary>
|
|
/// <param name="value">The value.</param>
|
|
/// <returns>True if a value was found. False if the queue is empty.</returns>
|
|
bool Dequeue(out EventFieldList value);
|
|
}
|
|
}
|