ObservableConcurrentQueue 2.0.1

.NET 5.0 .NET Core 1.0 .NET Standard 1.1 .NET Framework 4.0
Install-Package ObservableConcurrentQueue -Version 2.0.1
dotnet add package ObservableConcurrentQueue --version 2.0.1
<PackageReference Include="ObservableConcurrentQueue" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ObservableConcurrentQueue --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ObservableConcurrentQueue, 2.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ObservableConcurrentQueue as a Cake Addin
#addin nuget:?package=ObservableConcurrentQueue&version=2.0.1

// Install ObservableConcurrentQueue as a Cake Tool
#tool nuget:?package=ObservableConcurrentQueue&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ObservableConcurrentQueue

ObservableConcurrentQueue

.NET NuGet Badge

Using System.Collections.Concurrent.ConcurrentQueue with notifications

Get the latest version of source code from Github

Or get it from NUGET:

PM> Install-Package ObservableConcurrentQueue

Documentation

if you are not familiar with ConcurrentQueue, Read more about it on MSDN

Usage

Syntax

Create new instance

var observableConcurrentQueue = new ObservableConcurrentQueue();
Note about Thread Safety:

According to Mircosoft Documentation All public and protected members of ConcurrentQueue<T> are thread-safe and may be used concurrently from multiple threads. This additional Thread Safe option is just for some customization stuff.

Subscribe the Handler to the event ContentChanged

observableConcurrentQueue.ContentChanged += OnObservableConcurrentQueueContentChanged;

Option 2: Subscribe to CollectionChanged Event

observableConcurrentQueue.CollectionChanged += OnObservableConcurrentQueueCollectionChanged;

Example of handling method:

Queue Content Changed

private static void OnObservableConcurrentQueueContentChanged(
 object sender,
 NotifyConcurrentQueueChangedEventArgs args)
 {
      // Item Added
      if (args.Action == NotifyConcurrentQueueChangedAction.Enqueue)
      {
          Console.WriteLine("New Item added: {0}", args.ChangedItem);
      }
 
      // Item deleted
      if (args.Action == NotifyConcurrentQueueChangedAction.Dequeue)
      {
          Console.WriteLine("New Item deleted: {0}", args.ChangedItem);
      }
 
      // Item peeked
      if (args.Action == NotifyConcurrentQueueChangedAction.Peek)
      {
           Console.WriteLine("Item peeked: {0}", args.ChangedItem);
      }
 
      // Queue Empty
      if (args.Action == NotifyConcurrentQueueChangedAction.Empty)
      {
           Console.WriteLine("Queue is empty");
      }
 } 

Collection Changed event

private static void OnObservableConcurrentQueueCollectionChanged(
     object sender,
     NotifyCollectionChangedEventArgs args)
{
     if (args.Action == NotifyCollectionChangedAction.Add)
     {
          Console.WriteLine($"[+] Collection Changed [Add]: New Item added: {args.NewItems[0]}");
     }

     if (args.Action == NotifyCollectionChangedAction.Remove)
     {
          Console.WriteLine($"[-] Collection Changed [Remove]: New Item deleted: {args.OldItems[0]}");
     }

     if (args.Action == NotifyCollectionChangedAction.Reset)
     {
          Console.WriteLine("[ ] Collection Changed [Reset]: Queue is empty");
     }
}

Once the handler is defined, we can start adding, deleting or getting elements from the concurrentQueue, and after each operation an event will be raised and handled by the method above.

Event Args

The EventArgs object sent by the event contains 2 properties:

NotifyConcurrentQueueChangedAction Action:

  • Enqueue: If a new item has been enqueued.
  • Dequeue: an item has been dequeued.
  • Peek: an item has been peeked.
  • Empty: The last element in the queue has been dequeued and the queue is empty.

T ChangedItem:

The item which the changes applied on. can be null if the notification action is NotifyConcurrentQueueChangedAction.Empty.

Supported Frameworks

.NET Standard

netstandard1.1 netstandard1.2 netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1

.NET

net5.0 net6.0

.NET Core

netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1

.NET Framework

net40 net45 net451 net452 net46 net461 net462 net47 net471 net472 net48

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard1.1 netstandard1.2 netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1
.NET Framework net40 net403 net45 net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen30 tizen40 tizen60
Universal Windows Platform uap uap10.0
Windows Phone wpa81
Windows Store netcore netcore45 netcore451
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETCoreApp 1.0

  • .NETCoreApp 1.1

  • .NETCoreApp 2.0

    • No dependencies.
  • .NETCoreApp 2.1

    • No dependencies.
  • .NETCoreApp 2.2

    • No dependencies.
  • .NETCoreApp 3.0

    • No dependencies.
  • .NETCoreApp 3.1

    • No dependencies.
  • .NETFramework 4.0

    • No dependencies.
  • .NETFramework 4.5

    • No dependencies.
  • .NETFramework 4.5.1

    • No dependencies.
  • .NETFramework 4.5.2

    • No dependencies.
  • .NETFramework 4.6

    • No dependencies.
  • .NETFramework 4.6.1

    • No dependencies.
  • .NETFramework 4.6.2

    • No dependencies.
  • .NETFramework 4.7

    • No dependencies.
  • .NETFramework 4.7.1

    • No dependencies.
  • .NETFramework 4.7.2

    • No dependencies.
  • .NETFramework 4.8

    • No dependencies.
  • .NETStandard 1.1

  • .NETStandard 1.2

  • .NETStandard 1.3

  • .NETStandard 1.4

  • .NETStandard 1.5

  • .NETStandard 1.6

  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.
  • net5.0

    • No dependencies.
  • net6.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on ObservableConcurrentQueue:

Package Downloads
MultiThreadsEngine

Well tested, using in production code supporting for Multi-Thread Tasks with time out and throttler.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 825 2/6/2022
2.0.0 54 2/6/2022
1.2.0 84 2/5/2022
1.1.0 3,304 9/20/2020
1.0.2 3,429 7/29/2018
1.0.1 796 7/29/2018
1.0.0 1,918 1/5/2015