11namespace SpawnDev . BlazorJS . WebWorkers
22{
3- /// <summary>
4- /// Specifies the modes for transferring worker-related data, indicating whether required, all, or no transferable
5- /// values should be included in the operation.
6- /// </summary>
7- /// <remarks>Use this enumeration to control the scope of data transfer when performing worker-related
8- /// operations. Selecting the appropriate mode can help optimize performance and ensure that only necessary data is
9- /// transferred.</remarks>
10- public enum WorkerTransferMode
11- {
12- /// <summary>
13- /// Transfer required transferable values only.<br/>
14- /// </summary>
15- TransferRequired ,
16- /// <summary>
17- /// Transfer all transferable values, both required and optional.<br/>
18- /// </summary>
19- TransferAll ,
20- /// <summary>
21- /// Indicates that no data transfer operation is desired.
22- /// </summary>
23- TransferNone
24- }
253 /// <summary>
264 /// The WorkerTransferAttribute is used to mark values that should be added to the transferables list when sent to another context.<br/>
275 /// Ommitting this attribute will result in the default behavior, which is to transfer only required transferable values.<br/>
@@ -43,7 +21,7 @@ public class WorkerTransferAttribute : Attribute
4321 /// <summary>
4422 /// New instance
4523 /// </summary>
46- /// <param name="transfer"></param>
24+ /// <param name="transfer">transfer ? TransferAll : TransferNone </param>
4725 public WorkerTransferAttribute ( bool transfer )
4826 {
4927 Transfer = transfer ? WorkerTransferMode . TransferAll : WorkerTransferMode . TransferNone ;
@@ -71,15 +49,16 @@ public WorkerTransferAttribute(WorkerTransferMode transfer)
7149 /// <summary>
7250 /// New instance
7351 /// </summary>
74- /// <param name="transfer"></param>
75- /// <param name="depth"></param>
52+ /// <param name="transfer">Worekr transfer mode </param>
53+ /// <param name="depth">Max property depth </param>
7654 public WorkerTransferAttribute ( WorkerTransferMode transfer , int depth )
7755 {
7856 Transfer = transfer ;
7957 Depth = depth ;
8058 }
8159 /// <summary>
82- /// Default transfer mode when not specified
60+ /// Default transfer mode when not specified.<br/>
61+ /// WorkerTransferMode.TransferRequired, Depth = 3
8362 /// </summary>
8463 public static WorkerTransferAttribute TransferRequiredDefault { get ; } = new WorkerTransferAttribute ( WorkerTransferMode . TransferRequired , 3 ) ;
8564 }
0 commit comments