Class BaseOrderedBlockingQueue<TSort, TValue, TCollection>

Namespace

Ecng.Collections

Assembly

Ecng.Collections.dll

Represents a base class for an ordered blocking queue that sorts elements based on a specified key.

public abstract class BaseOrderedBlockingQueue<TSort, TValue, TCollection> : BaseBlockingQueue<(TSort sort, TValue elem), TCollection>, ISynchronizedCollection<(TSort sort, TValue elem)>, ISynchronizedCollection, ICollection<(TSort sort, TValue elem)>, IEnumerable<(TSort sort, TValue elem)>, IEnumerable, IBlockingQueue<(TSort sort, TValue elem)> where TCollection : ICollection<(TSort, TValue)>, IQueue<(TSort, TValue)>

Type Parameters

TSort

The type used to determine the sort order of elements.

TValue

The type of the values stored in the queue.

TCollection

The type of the inner collection, which must implement ICollection<T> and IQueue<T> for tuples of TSort and TValue.

Inheritance

object

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>

BaseOrderedBlockingQueue<TSort, TValue, TCollection>

Implements

ISynchronizedCollection<(TSort sort, TValue elem)>

ISynchronizedCollection

ICollection<(TSort sort, TValue elem)>

IEnumerable<(TSort sort, TValue elem)>

IEnumerable

IBlockingQueue<(TSort sort, TValue elem)>

Derived

BaseMessageQueue

Inherited Members

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Close()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Open()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.WaitUntilEmpty()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Enqueue((TSort sort, TValue elem), bool)

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.OnEnqueue((TSort sort, TValue elem), bool)

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.OnDequeue()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.OnPeek()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Dequeue()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.TryDequeue(out (TSort sort, TValue elem), bool, bool)

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Peek()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.TryPeek(out (TSort sort, TValue elem), bool, bool)

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Clear()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.GetEnumerator()

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.InnerCollection

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.MaxSize

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.SyncRoot

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.Count

BaseBlockingQueue<(TSort sort, TValue elem), TCollection>.IsClosed

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CollectionHelper.SyncDo<TCollection>(TCollection, Action<TCollection>)

CollectionHelper.SyncGet<TCollection, TResult>(TCollection, Func<TCollection, TResult>)

AsyncHelper.FromResult<TValue>(TValue)

AsyncHelper.ToCompleteSource<TValue>(TValue)

CompareHelper.IsDefault<T>(T)

CompareHelper.IsRuntimeDefault<T>(T)

Converter.TypedTo<TFrom, TTo>(TFrom)

DelegateHelper.AddDelegate<TDelegate>(TDelegate, TDelegate)

DelegateHelper.GetInvocationList<TDelegate>(TDelegate)

DelegateHelper.RemoveAllDelegates<TDelegate>(TDelegate)

DelegateHelper.RemoveDelegate<TDelegate>(TDelegate, TDelegate)

DisposableHelper.MakeDisposable<T>(T, Action<T>)

Enumerator.IsDefined<T>(T)

Enumerator.SplitMask<T>(T)

NullableHelper.Convert<T, TResult>(T, Func<T, TResult>, Func<TResult>)

NullableHelper.IsNull<T>(T)

NullableHelper.IsNull<T>(T, bool)

TupleHelper.ToValues<T>(T)

TypeHelper.CheckOnNull<T>(T, string)

TypeHelper.DoDispose<TSource>(TSource)

TypeHelper.ToScope<T>(T, bool)

NetworkHelper.Format<T>(T, bool)

PersistableHelper.TrySerialize<T>(T, out SettingsStorage)

XamlHelper.CopyToClipboard<T>(T)

Paths.SerializeToString<T>(T, bool)

Paths.Serialize<T>(T, bool)

Paths.Serialize<T>(T, string, bool)

CollectionHelper.AddRange<T>(ICollection<T>, IEnumerable<T>)

CollectionHelper.CopyAndClear<T>(ICollection<T>)

CollectionHelper.IsEmpty<T>(ICollection<T>)

CollectionHelper.RemoveRange<T>(ICollection<T>, IEnumerable<T>)

CollectionHelper.RemoveWhere<T>(ICollection<T>, Func<T, bool>)

CollectionHelper.TryAdd<T>(ICollection<T>, IEnumerable<T>)

CollectionHelper.TryAdd<T>(ICollection<T>, T)

CollectionHelper.Append2<T>(IEnumerable<T>, T)

CollectionHelper.Batch<T>(IEnumerable<T>, int)

CollectionHelper.Batch<TSource, TResult>(IEnumerable<TSource>, int, Func<IEnumerable<TSource>, TResult>, Func<bool>)

CollectionHelper.ElementAtFromEndOrDefault<T>(IEnumerable<T>, int)

CollectionHelper.ElementAtFromEnd<T>(IEnumerable<T>, int)

CollectionHelper.ElementAtOr<T>(IEnumerable<T>, int)

CollectionHelper.FirstOr<T>(IEnumerable<T>)

CollectionHelper.FirstOr<T>(IEnumerable<T>, T)

CollectionHelper.ForEach<T>(IEnumerable<T>, Action<T>)

CollectionHelper.GetHashCodeEx<T>(IEnumerable<T>)

CollectionHelper.IndexOf<T>(IEnumerable<T>, Func<T, bool>)

CollectionHelper.IsEmpty<T>(IEnumerable<T>)

CollectionHelper.IsEmpty<T>(IEnumerable<T>, Func<T, bool>)

CollectionHelper.LastOr<T>(IEnumerable<T>)

CollectionHelper.OrderByDescending<T>(IEnumerable<T>)

CollectionHelper.OrderBy<T>(IEnumerable<T>)

CollectionHelper.OrderBy<T>(IEnumerable<T>, Comparison<T>)

CollectionHelper.Permutations<TKey, TValue>(IEnumerable<TKey>, Func<TKey, IEnumerable<TValue>>)

CollectionHelper.SelectManyAsync<T, T1>(IEnumerable<T>, Func<T, Task<IEnumerable<T1>>>)

CollectionHelper.SequenceEqual<T>(IEnumerable<T>, IEnumerable<T>, Func<T, T, bool>)

CollectionHelper.SingleWhenOnly<T>(IEnumerable<T>)

CollectionHelper.ToDictionary<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, int, TKey>, Func<TSource, int, TValue>)

CollectionHelper.ToEx<T>(IEnumerable<T>)

CollectionHelper.ToEx<T>(IEnumerable<T>, int)

CollectionHelper.ToPairSet<TSource, TKey, TValue>(IEnumerable<TSource>, Func<TSource, int, TKey>, Func<TSource, int, TValue>)

CollectionHelper.ToSet<T>(IEnumerable<T>)

CollectionHelper.WhereWithPrevious<TSource>(IEnumerable<TSource>, Func<TSource, TSource, bool>)

CollectionHelper.Count2(IEnumerable)

CompareHelper.Compare(object, object)

Converter.To(object, Type)

Converter.To<T>(object)

Enumerator.GetAttributeOfType<TAttribute>(object)

Enumerator.IsEnumBrowsable(object)

Enumerator.SplitMask2(object)

TypeHelper.HasProperty(object, string)

EntityPropertyHelper.GetPropValue(object, string, Func<object, string, object>, IDictionary<string, object>)

Extensions.GetBasicProperties(object, int)

Extensions.GetDisplayName(object)

Extensions.GetFieldDescription(object)

Extensions.GetFieldDisplayName(object)

Extensions.GetFieldIcon(object)

JsonHelper.ToJson(object, bool)

JsonHelper.ToJson(object, bool, JsonSerializerSettings)

PersistableHelper.ToStorage(object, bool)

EditorExtensions.ToItemsSource(object, Type, bool?, ListSortDirection?, Func<IItemsSourceItem, bool>, Func<object, string>, Func<object, string>)

XamlHelper.EnsureUIThread(object)

XamlHelper.ShowModel<TWindow>(object, DependencyObject)

XamlHelper.WpfCast<T>(object)

VirtualPropertyRegistry.TryGetVirtualValue(object, string, out object)

Constructors

BaseOrderedBlockingQueue(TCollection)

Represents a base class for an ordered blocking queue that sorts elements based on a specified key.

protected BaseOrderedBlockingQueue(TCollection collection)

Parameters

collection TCollection

Methods

Enqueue(TSort, TValue)

Adds a new value to the queue with the specified sort order.

protected void Enqueue(TSort sort, TValue value)

Parameters

sort TSort

The sort key determining the order of the value in the queue.

value TValue

The value to add to the queue.

OnDequeue()

Removes and returns the next item from the inner collection.

protected override (TSort, TValue) OnDequeue()

Returns

(TSort, TValue)

The tuple containing the sort key and value of the dequeued item.

OnEnqueue((TSort, TValue), bool)

Adds an item to the inner collection when enqueuing.

protected override void OnEnqueue((TSort, TValue) item, bool force)

Parameters

item (TSort, TValue)

The tuple containing the sort key and value to enqueue.

force bool

If true, forces the item to be enqueued even if the queue is full; otherwise, respects the maximum size limit.

OnPeek()

Retrieves, but does not remove, the next item from the inner collection.

protected override (TSort, TValue) OnPeek()

Returns

(TSort, TValue)

The tuple containing the sort key and value of the item at the head of the queue.

TryDequeue(out TValue, bool, bool)

Attempts to remove and return the next value from the queue.

public bool TryDequeue(out TValue value, bool exitOnClose = true, bool block = true)

Parameters

value TValue

When this method returns, contains the dequeued value if successful; otherwise, the default value of TValue.

exitOnClose bool

If true, exits immediately if the queue is closed; otherwise, waits for an item.

block bool

If true, blocks until an item is available; otherwise, returns immediately.

Returns

bool

True if a value was successfully dequeued; otherwise, false.