BlockingCollection.cs System::Collections::Concurrent::BlockingCollection System System::Collections System::Collections::Concurrent System::Diagnostics System::Runtime::InteropServices // //BlockingCollection.cs // //Copyright(c)2008Jérémie"Garuma"Laval // //Permissionisherebygranted,freeofcharge,toanypersonobtainingacopy //ofthissoftwareandassociateddocumentationfiles(the"Software"),todeal //intheSoftwarewithoutrestriction,includingwithoutlimitationtherights //touse,copy,modify,merge,publish,distribute,sublicense,and/orsell //copiesoftheSoftware,andtopermitpersonstowhomtheSoftwareis //furnishedtodoso,subjecttothefollowingconditions: // //Theabovecopyrightnoticeandthispermissionnoticeshallbeincludedin //allcopiesorsubstantialportionsoftheSoftware. // //THESOFTWAREISPROVIDED"ASIS",WITHOUTWARRANTYOFANYKIND,EXPRESSOR //IMPLIED,INCLUDINGBUTNOTLIMITEDTOTHEWARRANTIESOFMERCHANTABILITY, //FITNESSFORAPARTICULARPURPOSEANDNONINFRINGEMENT.INNOEVENTSHALLTHE //AUTHORSORCOPYRIGHTHOLDERSBELIABLEFORANYCLAIM,DAMAGESOROTHER //LIABILITY,WHETHERINANACTIONOFCONTRACT,TORTOROTHERWISE,ARISINGFROM, //OUTOFORINCONNECTIONWITHTHESOFTWAREORTHEUSEOROTHERDEALINGSIN //THESOFTWARE. // // #ifNET_4_0||UNITY_5_3_OR_NEWER usingSystem; usingSystem.Threading; usingSystem.Collections; usingSystem.Collections.Generic; usingSystem.Diagnostics; usingSystem.Runtime.InteropServices; namespaceSystem.Collections.Concurrent { [ComVisible(false)] [DebuggerDisplay("Count={Count}")] [DebuggerTypeProxy(typeof(CollectionDebuggerView<>))] publicclassBlockingCollection<T>:IEnumerable<T>,ICollection,IEnumerable,IDisposable { constintspinCount=5; readonlyIProducerConsumerCollection<T>underlyingColl; readonlyintupperBound; AtomicBooleanisComplete; longcompleteId; /*Thewholeideaofthecollectionistousethesetwolongvaluesinatransactional *waytotrackandmanagetheactualdatainsidetheunderlyinglock-freecollection *insteadofdirectlyworkingwithitorusingexternallocking. * *TheyaremanipulatedwithCASandareguaranteedtoincreaseovertimeanduse *oftheinstancethuspreventingABAproblems. */ longaddId=long.MinValue; longremoveId=long.MinValue; /*Theseeventsareusedsolelyforthepurposeofhavinganoptimizedsleepcyclewhen *theBlockingCollectionhavetowaitonanexternalevent(AddorRemoveforinstance) */ ManualResetEventSlimmreAdd=newManualResetEventSlim(true); ManualResetEventSlimmreRemove=newManualResetEventSlim(true); /*Fortimebasedoperations,wesharethisinstanceofStopwatchandbasecalculation onatimeoffsetateachofthesemethodcall*/ staticStopwatchwatch=Stopwatch.StartNew(); #regionctors publicBlockingCollection() :this(newConcurrentQueue<T>(),-1) { } publicBlockingCollection(intboundedCapacity) :this(newConcurrentQueue<T>(),boundedCapacity) { } publicBlockingCollection(IProducerConsumerCollection<T>collection) :this(collection,-1) { } publicBlockingCollection(IProducerConsumerCollection<T>collection,intboundedCapacity) { this.underlyingColl=collection; this.upperBound=boundedCapacity; this.isComplete=newAtomicBoolean(); } #endregion #regionAdd&Remove(+Try) publicvoidAdd(Titem) { Add(item,CancellationToken.None); } publicvoidAdd(Titem,CancellationTokencancellationToken) { TryAdd(item,-1,cancellationToken); } publicboolTryAdd(Titem) { returnTryAdd(item,0,CancellationToken.None); } publicboolTryAdd(Titem,intmillisecondsTimeout,CancellationTokencancellationToken) { if(millisecondsTimeout<-1) thrownewArgumentOutOfRangeException("millisecondsTimeout"); longstart=millisecondsTimeout==-1?0:watch.ElapsedMilliseconds; SpinWaitsw=newSpinWait(); do{ cancellationToken.ThrowIfCancellationRequested(); longcachedAddId=addId; longcachedRemoveId=removeId; //Ifneeded,wecheckandwaitthatthecollectionisn'tfull if(upperBound!=-1&&cachedAddId-cachedRemoveId>upperBound){ if(millisecondsTimeout==0) returnfalse; if(sw.Count<=spinCount){ sw.SpinOnce(); }else{ mreRemove.Reset(); if(cachedRemoveId!=removeId||cachedAddId!=addId){ mreRemove.Set(); continue; } mreRemove.Wait(ComputeTimeout(millisecondsTimeout,start),cancellationToken); } continue; } //Checkourtransactionidagainstcompletedstoredone if(isComplete.Value&&cachedAddId>=completeId) ThrowCompleteException(); //Validatethestepswehavebeendoinguntilnow if(Interlocked.CompareExchange(refaddId,cachedAddId+1,cachedAddId)!=cachedAddId) continue; //Wehaveaslotreservedintheunderlyingcollection,trytotakeit if(!underlyingColl.TryAdd(item)) thrownewInvalidOperationException("Theunderlyingcollectiondidn'taccepttheitem."); //Wakeupprocessthatmayhavebeensleeping mreAdd.Set(); returntrue; }while(millisecondsTimeout==-1||(watch.ElapsedMilliseconds-start)<millisecondsTimeout); returnfalse; } publicboolTryAdd(Titem,TimeSpantimeout) { returnTryAdd(item,(int)timeout.TotalMilliseconds); } publicboolTryAdd(Titem,intmillisecondsTimeout) { returnTryAdd(item,millisecondsTimeout,CancellationToken.None); } publicTTake() { returnTake(CancellationToken.None); } publicTTake(CancellationTokencancellationToken) { Titem; TryTake(outitem,-1,cancellationToken,true); returnitem; } publicboolTryTake(outTitem) { returnTryTake(outitem,0,CancellationToken.None); } publicboolTryTake(outTitem,intmillisecondsTimeout,CancellationTokencancellationToken) { returnTryTake(outitem,millisecondsTimeout,cancellationToken,false); } boolTryTake(outTitem,intmilliseconds,CancellationTokencancellationToken,boolthrowComplete) { if(milliseconds<-1) thrownewArgumentOutOfRangeException("milliseconds"); item=default(T); SpinWaitsw=newSpinWait(); longstart=milliseconds==-1?0:watch.ElapsedMilliseconds; do{ cancellationToken.ThrowIfCancellationRequested(); longcachedRemoveId=removeId; longcachedAddId=addId; //Emptycase if(cachedRemoveId==cachedAddId){ if(milliseconds==0) returnfalse; if(IsCompleted){ if(throwComplete) ThrowCompleteException(); else returnfalse; } if(sw.Count<=spinCount){ sw.SpinOnce(); }else{ mreAdd.Reset(); if(cachedRemoveId!=removeId||cachedAddId!=addId){ mreAdd.Set(); continue; } mreAdd.Wait(ComputeTimeout(milliseconds,start),cancellationToken); } continue; } if(Interlocked.CompareExchange(refremoveId,cachedRemoveId+1,cachedRemoveId)!=cachedRemoveId) continue; while(!underlyingColl.TryTake(outitem)); mreRemove.Set(); returntrue; }while(milliseconds==-1||(watch.ElapsedMilliseconds-start)<milliseconds); returnfalse; } publicboolTryTake(outTitem,TimeSpantimeout) { returnTryTake(outitem,(int)timeout.TotalMilliseconds); } publicboolTryTake(outTitem,intmillisecondsTimeout) { item=default(T); returnTryTake(outitem,millisecondsTimeout,CancellationToken.None,false); } staticintComputeTimeout(intmillisecondsTimeout,longstart) { returnmillisecondsTimeout==-1?500:(int)Math.Max(watch.ElapsedMilliseconds-start-millisecondsTimeout,1); } #endregion #regionstaticmethods staticvoidCheckArray(BlockingCollection<T>[]collections) { if(collections==null) thrownewArgumentNullException("collections"); if(collections.Length==0||IsThereANullElement(collections)) thrownewArgumentException("Thecollectionsargumentisa0-lengtharrayorcontainsanullelement.","collections"); } staticboolIsThereANullElement(BlockingCollection<T>[]collections) { foreach(BlockingCollection<T>eincollections) if(e==null) returntrue; returnfalse; } publicstaticintAddToAny(BlockingCollection<T>[]collections,Titem) { CheckArray(collections); intindex=0; foreach(varcollincollections){ try{ coll.Add(item); returnindex; }catch{} index++; } return-1; } publicstaticintAddToAny(BlockingCollection<T>[]collections,Titem,CancellationTokencancellationToken) { CheckArray(collections); intindex=0; foreach(varcollincollections){ try{ coll.Add(item,cancellationToken); returnindex; }catch{} index++; } return-1; } publicstaticintTryAddToAny(BlockingCollection<T>[]collections,Titem) { CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryAdd(item)) returnindex; index++; } return-1; } publicstaticintTryAddToAny(BlockingCollection<T>[]collections,Titem,TimeSpantimeout) { CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryAdd(item,timeout)) returnindex; index++; } return-1; } publicstaticintTryAddToAny(BlockingCollection<T>[]collections,Titem,intmillisecondsTimeout) { CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryAdd(item,millisecondsTimeout)) returnindex; index++; } return-1; } publicstaticintTryAddToAny(BlockingCollection<T>[]collections,Titem,intmillisecondsTimeout, CancellationTokencancellationToken) { CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryAdd(item,millisecondsTimeout,cancellationToken)) returnindex; index++; } return-1; } publicstaticintTakeFromAny(BlockingCollection<T>[]collections,outTitem) { item=default(T); CheckArray(collections); intindex=0; foreach(varcollincollections){ try{ item=coll.Take(); returnindex; }catch{} index++; } return-1; } publicstaticintTakeFromAny(BlockingCollection<T>[]collections,outTitem,CancellationTokencancellationToken) { item=default(T); CheckArray(collections); intindex=0; foreach(varcollincollections){ try{ item=coll.Take(cancellationToken); returnindex; }catch{} index++; } return-1; } publicstaticintTryTakeFromAny(BlockingCollection<T>[]collections,outTitem) { item=default(T); CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryTake(outitem)) returnindex; index++; } return-1; } publicstaticintTryTakeFromAny(BlockingCollection<T>[]collections,outTitem,TimeSpantimeout) { item=default(T); CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryTake(outitem,timeout)) returnindex; index++; } return-1; } publicstaticintTryTakeFromAny(BlockingCollection<T>[]collections,outTitem,intmillisecondsTimeout) { item=default(T); CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryTake(outitem,millisecondsTimeout)) returnindex; index++; } return-1; } publicstaticintTryTakeFromAny(BlockingCollection<T>[]collections,outTitem,intmillisecondsTimeout, CancellationTokencancellationToken) { item=default(T); CheckArray(collections); intindex=0; foreach(varcollincollections){ if(coll.TryTake(outitem,millisecondsTimeout,cancellationToken)) returnindex; index++; } return-1; } #endregion publicvoidCompleteAdding() { //Nofurtheraddbesidethatpoint completeId=addId; isComplete.Value=true; //Wakeupsomeoperationincasethishasanimpact mreAdd.Set(); mreRemove.Set(); } voidThrowCompleteException() { thrownewInvalidOperationException("TheBlockingCollection<T>has" +"beenmarkedascompletewithregardstoadditions."); } voidICollection.CopyTo(Arrayarray,intindex) { underlyingColl.CopyTo(array,index); } publicvoidCopyTo(T[]array,intindex) { underlyingColl.CopyTo(array,index); } publicIEnumerable<T>GetConsumingEnumerable() { returnGetConsumingEnumerable(CancellationToken.None); } publicIEnumerable<T>GetConsumingEnumerable(CancellationTokencancellationToken) { while(true){ Titem=default(T); try{ item=Take(cancellationToken); }catch{ //Thentheexceptionisperfectlynormal if(IsCompleted) break; //otherwiserethrow throw; } yieldreturnitem; } } IEnumeratorIEnumerable.GetEnumerator() { return((IEnumerable)underlyingColl).GetEnumerator(); } IEnumerator<T>IEnumerable<T>.GetEnumerator() { return((IEnumerable<T>)underlyingColl).GetEnumerator(); } publicvoidDispose() { } protectedvirtualvoidDispose(booldisposing) { } publicT[]ToArray() { returnunderlyingColl.ToArray(); } publicintBoundedCapacity{ get{ returnupperBound; } } publicintCount{ get{ returnunderlyingColl.Count; } } publicboolIsAddingCompleted{ get{ returnisComplete.Value; } } publicboolIsCompleted{ get{ returnisComplete.Value&&addId==removeId; } } objectICollection.SyncRoot{ get{ returnunderlyingColl.SyncRoot; } } boolICollection.IsSynchronized{ get{ returnunderlyingColl.IsSynchronized; } } } } #endif