BackgroundThreadQueue(T) Class

BackgroundThreadQueueT Class

A class that wraps a queue of objects that one thread pushes onto while a background thread pops and processes them.

Inheritance Hierarchy

SystemObject
VirtualRadar.InterfaceBackgroundThreadQueueT

Namespace: VirtualRadar.Interface
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class BackgroundThreadQueue<T> : IQueue, 
	IDisposable
where T : class

Public Class BackgroundThreadQueue(Of T As Class)
	Implements IQueue, IDisposable

generic<typename T>
where T : ref class
public ref class BackgroundThreadQueue : IQueue, 
	IDisposable

type BackgroundThreadQueue<'T when 'T : not struct> =  
    class
        interface IQueue
        interface IDisposable
    end

The BackgroundThreadQueueT type exposes the following members.

Constructors

	Name	Description
	BackgroundThreadQueueT(String, Int32)	Creates a new object.
	BackgroundThreadQueueT(String, BackgroundThreadQueueMechanism, Int32)	Creates a new object.

Properties

	Name	Description
	CountDroppedItems	See interface docs.
	CountQueuedItems	See interface docs.
	MaximumParallelThreads	Gets or sets the maximum number of parallel threads used when the mechanism is ThreadPool. Has no effect with other mechanisms, or if the queue has already been started.
	MaxQueuedItems	The maximum number of items allowed in the queue.
	Name	See interface docs.
	PeakQueuedItems	See interface docs.

Methods

	Name	Description
	Clear	Removes all entries from the queue in a single operation.
	Dispose	See interface docs.
	Dispose(Boolean)	Disposes of or finalises the object.
	Enqueue	Adds a new item to the queue and signals the background thread that there is something to process.
	EnqueueRange	Adds many items to the queue simultaneously.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Finalises the object. (Overrides ObjectFinalize.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	StartBackgroundThread	Creates and starts the background thread that will pop objects from the queue and process them.
	Stop	Stops processing items. Once the queue has stopped it cannot be restarted.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Remarks

This can be told to force everything onto a single thread by unit tests via the IRuntimeEnvironment interface.