mcs/class/Mono.Parallel/Documentation/en/Mono.Threading.Tasks/ThreadWorker.xml

   1 <Type Name="ThreadWorker" FullName="Mono.Threading.Tasks.ThreadWorker">
   2   <TypeSignature Language="C#" Value="public class ThreadWorker : IDisposable" />
   3   <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ThreadWorker extends System.Object implements class System.IDisposable" />
   4   <AssemblyInfo>
   5     <AssemblyName>Mono.Parallel</AssemblyName>
   6     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.Object</BaseTypeName>
  10   </Base>
  11   <Interfaces>
  12     <Interface>
  13       <InterfaceName>System.IDisposable</InterfaceName>
  14     </Interface>
  15   </Interfaces>
  16   <Docs>
  17     <summary>This class wraps a <see cref="T:System.Threading.Thread" /> to provide a suitable ParallelFx worker (i.e. something that process <see cref="T:System.Threading.Tasks.Task" />).</summary>
  18     <remarks>To be added.</remarks>
  19   </Docs>
  20   <Members>
  21     <Member MemberName=".ctor">
  22       <MemberSignature Language="C#" Value="public ThreadWorker (Mono.Threading.Tasks.ThreadWorker[] others, int workerPosition, System.Collections.Concurrent.IProducerConsumerCollection&lt;System.Threading.Tasks.Task&gt; sharedWorkQueue, Mono.Threading.Tasks.IConcurrentDeque&lt;System.Threading.Tasks.Task&gt; dDeque, System.Threading.ThreadPriority priority, System.Threading.ManualResetEvent handle);" />
  23       <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Mono.Threading.Tasks.ThreadWorker[] others, int32 workerPosition, class System.Collections.Concurrent.IProducerConsumerCollection`1&lt;class System.Threading.Tasks.Task&gt; sharedWorkQueue, class Mono.Threading.Tasks.IConcurrentDeque`1&lt;class System.Threading.Tasks.Task&gt; dDeque, valuetype System.Threading.ThreadPriority priority, class System.Threading.ManualResetEvent handle) cil managed" />
  24       <MemberType>Constructor</MemberType>
  25       <AssemblyInfo>
  26         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  27       </AssemblyInfo>
  28       <Parameters>
  29         <Parameter Name="others" Type="Mono.Threading.Tasks.ThreadWorker[]" />
  30         <Parameter Name="workerPosition" Type="System.Int32" />
  31         <Parameter Name="sharedWorkQueue" Type="System.Collections.Concurrent.IProducerConsumerCollection&lt;System.Threading.Tasks.Task&gt;" />
  32         <Parameter Name="dDeque" Type="Mono.Threading.Tasks.IConcurrentDeque&lt;System.Threading.Tasks.Task&gt;" />
  33         <Parameter Name="priority" Type="System.Threading.ThreadPriority" />
  34         <Parameter Name="handle" Type="System.Threading.ManualResetEvent" />
  35       </Parameters>
  36       <Docs>
  37         <param name="others">This is an array containing all other workers created. It's necessary if you want worker cooperating together for getting extra work.</param>
  38         <param name="workerPosition">The position in the previous array where this worker will be placed.</param>
  39         <param name="sharedWorkQueue">This is the global data structures that holds the Task when the system starts and is not yet bootstraped. It's also where tasks end up if they are executed with fairness enabled.</param>
  40         <param name="dDeque">The personnal instance of a deque type used by the worker when storing the tasks its responsible of and letting other workers retrieve them.</param>
  41         <param name="priority">The priority of the underlying thread.</param>
  42         <param name="handle">This is a handle shared (ideally) by all workers to synchronize and deep sleep when there is no more work to do. Setting the handle will wake them up.</param>
  43         <summary>Build a new worker instance.</summary>
  44         <remarks>To be added.</remarks>
  45       </Docs>
  46     </Member>
  47     <Member MemberName="AutoReference">
  48       <MemberSignature Language="C#" Value="public static Mono.Threading.Tasks.ThreadWorker AutoReference { get; set; }" />
  49       <MemberSignature Language="ILAsm" Value=".property class Mono.Threading.Tasks.ThreadWorker AutoReference" />
  50       <MemberType>Property</MemberType>
  51       <AssemblyInfo>
  52         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  53       </AssemblyInfo>
  54       <ReturnValue>
  55         <ReturnType>Mono.Threading.Tasks.ThreadWorker</ReturnType>
  56       </ReturnValue>
  57       <Docs>
  58         <summary>This [ThreadStatic] field is automatically updated when WorkerMethod method run so that you can check if you are making a re-entrant call on the same thread.</summary>
  59         <value>To be added.</value>
  60         <remarks>To be added.</remarks>
  61       </Docs>
  62     </Member>
  63     <Member MemberName="ChildWorkAdder">
  64       <MemberSignature Language="C#" Value="protected virtual void ChildWorkAdder (System.Threading.Tasks.Task t);" />
  65       <MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance void ChildWorkAdder(class System.Threading.Tasks.Task t) cil managed" />
  66       <MemberType>Method</MemberType>
  67       <AssemblyInfo>
  68         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  69       </AssemblyInfo>
  70       <ReturnValue>
  71         <ReturnType>System.Void</ReturnType>
  72       </ReturnValue>
  73       <Parameters>
  74         <Parameter Name="t" Type="System.Threading.Tasks.Task" />
  75       </Parameters>
  76       <Docs>
  77         <param name="t">Task being scheduled</param>
  78         <summary>This method is called when the currently executing Task tries to schedule another Task as part of its computation. This method allows to redirect the scheduling to a specific place.</summary>
  79         <remarks>By default the supplied task is added to the ThreadWorker deque via the PushBottom operation.</remarks>
  80       </Docs>
  81     </Member>
  82     <Member MemberName="Deque">
  83       <MemberSignature Language="C#" Value="protected Mono.Threading.Tasks.IConcurrentDeque&lt;System.Threading.Tasks.Task&gt; Deque { get; }" />
  84       <MemberSignature Language="ILAsm" Value=".property instance class Mono.Threading.Tasks.IConcurrentDeque`1&lt;class System.Threading.Tasks.Task&gt; Deque" />
  85       <MemberType>Property</MemberType>
  86       <AssemblyInfo>
  87         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  88       </AssemblyInfo>
  89       <ReturnValue>
  90         <ReturnType>Mono.Threading.Tasks.IConcurrentDeque&lt;System.Threading.Tasks.Task&gt;</ReturnType>
  91       </ReturnValue>
  92       <Docs>
  93         <summary>Allow access to the <see cref="T:Mono.Threading.Tasks.IConcurrentDeque&lt;T&gt;" /> used by the ThreadWorker.</summary>
  94         <value>To be added.</value>
  95         <remarks>To be added.</remarks>
  96       </Docs>
  97     </Member>
  98     <Member MemberName="Dispose">
  99       <MemberSignature Language="C#" Value="public virtual void Dispose ();" />
 100       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
 101       <MemberType>Method</MemberType>
 102       <AssemblyInfo>
 103         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 104       </AssemblyInfo>
 105       <ReturnValue>
 106         <ReturnType>System.Void</ReturnType>
 107       </ReturnValue>
 108       <Parameters />
 109       <Docs>
 110         <summary>To be added.</summary>
 111         <remarks>To be added.</remarks>
 112       </Docs>
 113     </Member>
 114     <Member MemberName="Equals">
 115       <MemberSignature Language="C#" Value="public virtual bool Equals (Mono.Threading.Tasks.ThreadWorker other);" />
 116       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Mono.Threading.Tasks.ThreadWorker other) cil managed" />
 117       <MemberType>Method</MemberType>
 118       <AssemblyInfo>
 119         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 120       </AssemblyInfo>
 121       <ReturnValue>
 122         <ReturnType>System.Boolean</ReturnType>
 123       </ReturnValue>
 124       <Parameters>
 125         <Parameter Name="other" Type="Mono.Threading.Tasks.ThreadWorker" />
 126       </Parameters>
 127       <Docs>
 128         <param name="other">To be added.</param>
 129         <summary>To be added.</summary>
 130         <returns>To be added.</returns>
 131         <remarks>To be added.</remarks>
 132       </Docs>
 133     </Member>
 134     <Member MemberName="Equals">
 135       <MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
 136       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
 137       <MemberType>Method</MemberType>
 138       <AssemblyInfo>
 139         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 140       </AssemblyInfo>
 141       <ReturnValue>
 142         <ReturnType>System.Boolean</ReturnType>
 143       </ReturnValue>
 144       <Parameters>
 145         <Parameter Name="obj" Type="System.Object" />
 146       </Parameters>
 147       <Docs>
 148         <param name="obj">To be added.</param>
 149         <summary>To be added.</summary>
 150         <returns>To be added.</returns>
 151         <remarks>To be added.</remarks>
 152       </Docs>
 153     </Member>
 154     <Member MemberName="Finished">
 155       <MemberSignature Language="C#" Value="public bool Finished { get; }" />
 156       <MemberSignature Language="ILAsm" Value=".property instance bool Finished" />
 157       <MemberType>Property</MemberType>
 158       <AssemblyInfo>
 159         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 160       </AssemblyInfo>
 161       <ReturnValue>
 162         <ReturnType>System.Boolean</ReturnType>
 163       </ReturnValue>
 164       <Docs>
 165         <summary>Tells if the underlying thread has exited or not.</summary>
 166         <value>To be added.</value>
 167         <remarks>To be added.</remarks>
 168       </Docs>
 169     </Member>
 170     <Member MemberName="GetHashCode">
 171       <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
 172       <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
 173       <MemberType>Method</MemberType>
 174       <AssemblyInfo>
 175         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 176       </AssemblyInfo>
 177       <ReturnValue>
 178         <ReturnType>System.Int32</ReturnType>
 179       </ReturnValue>
 180       <Parameters />
 181       <Docs>
 182         <summary>To be added.</summary>
 183         <returns>To be added.</returns>
 184         <remarks>To be added.</remarks>
 185       </Docs>
 186     </Member>
 187     <Member MemberName="Id">
 188       <MemberSignature Language="C#" Value="public int Id { get; }" />
 189       <MemberSignature Language="ILAsm" Value=".property instance int32 Id" />
 190       <MemberType>Property</MemberType>
 191       <AssemblyInfo>
 192         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 193       </AssemblyInfo>
 194       <ReturnValue>
 195         <ReturnType>System.Int32</ReturnType>
 196       </ReturnValue>
 197       <Docs>
 198         <summary>Return the Id of the underlying thread used by the ThreadWorker.</summary>
 199         <value>To be added.</value>
 200         <remarks>To be added.</remarks>
 201       </Docs>
 202     </Member>
 203     <Member MemberName="InitializeUnderlyingThread">
 204       <MemberSignature Language="C#" Value="protected virtual void InitializeUnderlyingThread ();" />
 205       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void InitializeUnderlyingThread() cil managed" />
 206       <MemberType>Method</MemberType>
 207       <AssemblyInfo>
 208         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 209       </AssemblyInfo>
 210       <ReturnValue>
 211         <ReturnType>System.Void</ReturnType>
 212       </ReturnValue>
 213       <Parameters />
 214       <Docs>
 215         <summary>To be added.</summary>
 216         <remarks>To be added.</remarks>
 217       </Docs>
 218     </Member>
 219     <Member MemberName="Others">
 220       <MemberSignature Language="C#" Value="protected Mono.Threading.Tasks.ThreadWorker[] Others { get; }" />
 221       <MemberSignature Language="ILAsm" Value=".property instance class Mono.Threading.Tasks.ThreadWorker[] Others" />
 222       <MemberType>Property</MemberType>
 223       <AssemblyInfo>
 224         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 225       </AssemblyInfo>
 226       <ReturnValue>
 227         <ReturnType>Mono.Threading.Tasks.ThreadWorker[]</ReturnType>
 228       </ReturnValue>
 229       <Docs>
 230         <summary>Returns the array of existing ThreadWorker that been initially supplied.</summary>
 231         <value>To be added.</value>
 232         <remarks>If you are iterating the array, make sure you skip the current instance of ThreadWorker with value of <see cref="P:Mono.Threading.Tasks.ThreadWorker.WorkerPosition" /></remarks>
 233       </Docs>
 234     </Member>
 235     <Member MemberName="Priority">
 236       <MemberSignature Language="C#" Value="protected System.Threading.ThreadPriority Priority { get; }" />
 237       <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Threading.ThreadPriority Priority" />
 238       <MemberType>Property</MemberType>
 239       <AssemblyInfo>
 240         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 241       </AssemblyInfo>
 242       <ReturnValue>
 243         <ReturnType>System.Threading.ThreadPriority</ReturnType>
 244       </ReturnValue>
 245       <Docs>
 246         <summary>The priority the underlying thread is running with.</summary>
 247         <value>To be added.</value>
 248         <remarks>To be added.</remarks>
 249       </Docs>
 250     </Member>
 251     <Member MemberName="Pulse">
 252       <MemberSignature Language="C#" Value="public virtual void Pulse ();" />
 253       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Pulse() cil managed" />
 254       <MemberType>Method</MemberType>
 255       <AssemblyInfo>
 256         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 257       </AssemblyInfo>
 258       <ReturnValue>
 259         <ReturnType>System.Void</ReturnType>
 260       </ReturnValue>
 261       <Parameters />
 262       <Docs>
 263         <summary>To be added.</summary>
 264         <remarks>To be added.</remarks>
 265       </Docs>
 266     </Member>
 267     <Member MemberName="Stop">
 268       <MemberSignature Language="C#" Value="public virtual void Stop ();" />
 269       <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Stop() cil managed" />
 270       <MemberType>Method</MemberType>
 271       <AssemblyInfo>
 272         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 273       </AssemblyInfo>
 274       <ReturnValue>
 275         <ReturnType>System.Void</ReturnType>
 276       </ReturnValue>
 277       <Parameters />
 278       <Docs>
 279         <summary>Stop the underlying thread of this ThreadWorker.</summary>
 280         <remarks>To be added.</remarks>
 281       </Docs>
 282     </Member>
 283     <Member MemberName="WaitHandle">
 284       <MemberSignature Language="C#" Value="protected System.Threading.ManualResetEvent WaitHandle { get; }" />
 285       <MemberSignature Language="ILAsm" Value=".property instance class System.Threading.ManualResetEvent WaitHandle" />
 286       <MemberType>Property</MemberType>
 287       <AssemblyInfo>
 288         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 289       </AssemblyInfo>
 290       <ReturnValue>
 291         <ReturnType>System.Threading.ManualResetEvent</ReturnType>
 292       </ReturnValue>
 293       <Docs>
 294         <summary>Acces the WaitHandle normally shared by all your ThreadWorker instances to deep sleep or otherwise synchronize on.</summary>
 295         <value>To be added.</value>
 296         <remarks>To be added.</remarks>
 297       </Docs>
 298     </Member>
 299     <Member MemberName="WorkerMethod">
 300       <MemberSignature Language="C#" Value="protected virtual bool WorkerMethod ();" />
 301       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool WorkerMethod() cil managed" />
 302       <MemberType>Method</MemberType>
 303       <AssemblyInfo>
 304         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 305       </AssemblyInfo>
 306       <ReturnValue>
 307         <ReturnType>System.Boolean</ReturnType>
 308       </ReturnValue>
 309       <Parameters />
 310       <Docs>
 311         <summary>This is the method executed by WorkerMethod to do the actual processing of tasks.</summary>
 312         <returns>
 313           <see langword="true" /> if the method processed a <see cref="T:System.Threading.Tasks.Task" /> while it ran, <see langword="false" /> otherwise.</returns>
 314         <remarks>By default this method applies the following algorithm:
 315 <list type="bullet"><item><term>Check if the global data structures contains task and fetch as much as possible into its own deque</term></item><item><term>Execute whatever its deque contains</term></item><item><term>Do a couple of pass over the other workers to try to steal some work to do</term></item></list></remarks>
 316       </Docs>
 317     </Member>
 318     <Member MemberName="WorkerMethodWrapper">
 319       <MemberSignature Language="C#" Value="protected virtual void WorkerMethodWrapper ();" />
 320       <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void WorkerMethodWrapper() cil managed" />
 321       <MemberType>Method</MemberType>
 322       <AssemblyInfo>
 323         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 324       </AssemblyInfo>
 325       <ReturnValue>
 326         <ReturnType>System.Void</ReturnType>
 327       </ReturnValue>
 328       <Parameters />
 329       <Docs>
 330         <summary>This is the method executed by the underlying thread.</summary>
 331         <remarks>By default this method consists of a while loop calling repeatedly <see cref="M:Mono.Threading.Tasks.ThreadWorker.WorkerMethodWrapper()" /> and sleeping accordingly when there is no more work to do.</remarks>
 332       </Docs>
 333     </Member>
 334     <Member MemberName="WorkerPosition">
 335       <MemberSignature Language="C#" Value="protected int WorkerPosition { get; }" />
 336       <MemberSignature Language="ILAsm" Value=".property instance int32 WorkerPosition" />
 337       <MemberType>Property</MemberType>
 338       <AssemblyInfo>
 339         <AssemblyVersion>4.0.0.0</AssemblyVersion>
 340       </AssemblyInfo>
 341       <ReturnValue>
 342         <ReturnType>System.Int32</ReturnType>
 343       </ReturnValue>
 344       <Docs>
 345         <summary>Position of the current instance in the <see cref="P:Mono.Threading.Tasks.ThreadWorker.Others" /> array.</summary>
 346         <value>To be added.</value>
 347         <remarks>To be added.</remarks>
 348       </Docs>
 349     </Member>
 350   </Members>
 351 </Type>