unity-integration.md UnityIntegration ================= The**SpicyPixel.Threading.Unity.dll**assemblyprovidesfunctionalitytointegratethe[Fiber](@refSpicyPixel.Threading.Fiber)andTaskfeaturesoftheConcurrencyKitwiththeUnitycoroutinescheduler. MonoBehaviourExtensions ------------------------ ###UsingConcurrentBehaviour The[ConcurrentBehavior](@refSpicyPixel.Threading.ConcurrentBehaviour)classextendsMonoBehaviourwithadditionalpropertiestomakeiteasytoaccesstheschedulerassociatedwiththebehaviour. ```{.cs} publicclassMyBehaviour:ConcurrentBehaviour { //IfyourcoderequiresAwake(),alwaysoverridethebase //becausethisiswheretheschedulersaresetuptoensure //thecorrectthreadisselected. overridevoidAwake() { base.Awake(); //Docustomlogic } voidUpdate() { taskFactory.StartNew(()=>DoWorkOnUnityThread()). ContinueWith((t)=>DoMoreWorkOnUnityThread(),taskScheduler); } } ``` ###Managingschedulercreation Ifitisnotconvenienttoextendyourbehaviourfrom[ConcurrentBehavior](@refSpicyPixel.Threading.ConcurrentBehaviour),youcancreatefactoryandschedulerinstancesbyinvokingoneoftheextensionmethodsin[UnityTaskExtensions](@refSpicyPixel.Threading.Tasks.UnityTaskExtensions). ```{.cs} publicclassMyBehaviour:MonoBehaviour { privateTaskFactorycustomTaskFactory; voidAwake() { customTaskFactory=this.CreateTaskFactory(); } voidUpdate() { customTaskFactory.StartNew(()=>DoWorkOnUnityThread()). ContinueWith((t)=>DoMoreWorkOnUnityThread(),customTaskFactory.Scheduler); } } ``` ###Sharedfactory Youcanuse[UnityTaskFactory](@refSpicyPixel.Threading.Tasks.UnityTaskFactory)toaccessasharedfactoryinstancewhichultimatelyreliesontheshared[ConcurrentBehavior](@refSpicyPixel.Threading.ConcurrentBehaviour)instance. ```{.cs} publicclassMyBehaviour:MonoBehaviour { voidUpdate() { UnityTaskFactory.Default.StartNew(()=>DoWorkOnUnityThread()). ContinueWith((t)=>DoMoreWorkOnUnityThread(),UnityTaskScheduler.Default); } } ``` SynchronizationContext ----------------------- The[UnitySynchronizationContext](@refSpicyPixel.Threading.UnitySynchronizationContext)isaconvenientwaytointegratewithcodewhichreliesona[SynchronizationContext](https://msdn.microsoft.com/en-us/library/system.threading.synchronizationcontext(v=vs.110).aspx)ortopostoperationsbacktothecallingthreadinascheduleragnosticmanner. ```{.cs} publicclassMyBehaviour:MonoBehaviour { voidAwake() { //Installthisonceatstartupinasinglebehaviourto //initializethecontextforthemainthread. SynchronizationContext.SetSynchronizationContext( UnitySynchronizationContext.SharedInstance); } //ThisexamplemethodmightbeinvokedbysomethingfromtheUnitythread //butwhichneedstoprocessresultsonatimer. voidProcessResults() { //Savethecurrentthread'ssynccontextbeforeweenterthetimer //sowecanuseitforcallback. varsyncContext=SynchronizationContext.Current; //Startatimer newTimer(TimerCallback,syncContext,TimeSpan.FromSeconds(3),TimeSpan.Zero); } //Dosomethingonatimerthread voidTimerCallback(objectstate) { //Getthesynccontextforthethreadthatcreated //thetimer.Technicallywecouldhavereferenced //UnitySynchronizationContext.SharedInstancesince //weknowthatisthethreadwewanttosendbackto, //butthisisthetypicalpatternyouwouldusetowrite //scheduleragnosticcode. varsyncContext=stateasSynchronizationContext; //Wearerunninginatimerthreadhere. //Now,runsomethingbackonthethreadthatstartedthetimer syncContext.Send((moreState)=>{ Debug.Log("BackontheUnitythread"); },null); } } ```