WorkerPool.js 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. /**
  2. * A simple pool for managing Web Workers.
  3. *
  4. * @three_import import { WorkerPool } from 'three/addons/utils/WorkerPool.js';
  5. */
  6. export class WorkerPool {
  7. /**
  8. * Constructs a new Worker pool.
  9. *
  10. * @param {number} [pool=4] - The size of the pool.
  11. */
  12. constructor( pool = 4 ) {
  13. /**
  14. * The size of the pool.
  15. *
  16. * @type {number}
  17. * @default 4
  18. */
  19. this.pool = pool;
  20. /**
  21. * A message queue.
  22. *
  23. * @type {Array<Object>}
  24. */
  25. this.queue = [];
  26. /**
  27. * An array of Workers.
  28. *
  29. * @type {Array<Worker>}
  30. */
  31. this.workers = [];
  32. /**
  33. * An array with resolve functions for messages.
  34. *
  35. * @type {Array<Function>}
  36. */
  37. this.workersResolve = [];
  38. /**
  39. * The current worker status.
  40. *
  41. * @type {number}
  42. */
  43. this.workerStatus = 0;
  44. /**
  45. * A factory function for creating workers.
  46. *
  47. * @type {?Function}
  48. */
  49. this.workerCreator = null;
  50. }
  51. _initWorker( workerId ) {
  52. if ( ! this.workers[ workerId ] ) {
  53. const worker = this.workerCreator();
  54. worker.addEventListener( 'message', this._onMessage.bind( this, workerId ) );
  55. this.workers[ workerId ] = worker;
  56. }
  57. }
  58. _getIdleWorker() {
  59. for ( let i = 0; i < this.pool; i ++ )
  60. if ( ! ( this.workerStatus & ( 1 << i ) ) ) return i;
  61. return - 1;
  62. }
  63. _onMessage( workerId, msg ) {
  64. const resolve = this.workersResolve[ workerId ];
  65. resolve && resolve( msg );
  66. if ( this.queue.length ) {
  67. const { resolve, msg, transfer } = this.queue.shift();
  68. this.workersResolve[ workerId ] = resolve;
  69. this.workers[ workerId ].postMessage( msg, transfer );
  70. } else {
  71. this.workerStatus ^= 1 << workerId;
  72. }
  73. }
  74. /**
  75. * Sets a function that is responsible for creating Workers.
  76. *
  77. * @param {Function} workerCreator - The worker creator function.
  78. */
  79. setWorkerCreator( workerCreator ) {
  80. this.workerCreator = workerCreator;
  81. }
  82. /**
  83. * Sets the Worker limit
  84. *
  85. * @param {number} pool - The size of the pool.
  86. */
  87. setWorkerLimit( pool ) {
  88. this.pool = pool;
  89. }
  90. /**
  91. * Post a message to an idle Worker. If no Worker is available,
  92. * the message is pushed into a message queue for later processing.
  93. *
  94. * @param {Object} msg - The message.
  95. * @param {Array<ArrayBuffer>} transfer - An array with array buffers for data transfer.
  96. * @return {Promise} A Promise that resolves when the message has been processed.
  97. */
  98. postMessage( msg, transfer ) {
  99. return new Promise( ( resolve ) => {
  100. const workerId = this._getIdleWorker();
  101. if ( workerId !== - 1 ) {
  102. this._initWorker( workerId );
  103. this.workerStatus |= 1 << workerId;
  104. this.workersResolve[ workerId ] = resolve;
  105. this.workers[ workerId ].postMessage( msg, transfer );
  106. } else {
  107. this.queue.push( { resolve, msg, transfer } );
  108. }
  109. } );
  110. }
  111. /**
  112. * Terminates all Workers of this pool. Call this method whenever this
  113. * Worker pool is no longer used in your app.
  114. */
  115. dispose() {
  116. this.workers.forEach( ( worker ) => worker.terminate() );
  117. this.workersResolve.length = 0;
  118. this.workers.length = 0;
  119. this.queue.length = 0;
  120. this.workerStatus = 0;
  121. }
  122. }