repositories / poolifier.git / blame
| Commit | Line | Data |
|---|---|---|
| 3bd6a82e | 1 | <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DynamicThreadPool | poolifier</title><meta name="description" content="Documentation for poolifier"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> |
| a76fac14 JB |
2 | <div class="tsd-toolbar-contents container"> |
| 3 | <div class="table-cell" id="tsd-search" data-base=".."> | |
| 41015374 JB |
4 | <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> |
| 5 | <div class="field"> | |
| 6 | <div id="tsd-toolbar-links"></div></div> | |
| a76fac14 JB |
7 | <ul class="results"> |
| 8 | <li class="state loading">Preparing search index...</li> | |
| cfc6e8df | 9 | <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier</a></div> |
| 41015374 | 10 | <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> |
| a76fac14 | 11 | <div class="container container-main"> |
| ec06e4dd | 12 | <div class="col-content"> |
| a76fac14 JB |
13 | <div class="tsd-page-title"> |
| 14 | <ul class="tsd-breadcrumb"> | |
| 15 | <li><a href="../index.html">poolifier</a></li> | |
| 16 | <li><a href="DynamicThreadPool.html">DynamicThreadPool</a></li></ul> | |
| 17 | <h1>Class DynamicThreadPool<Data, Response></h1></div> | |
| 18 | <section class="tsd-panel tsd-comment"> | |
| 19 | <div class="tsd-comment tsd-typography"><p>A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.</p> | |
| 20 | <p>This thread pool creates new threads when the others are busy, up to the maximum number of threads. | |
| ba92b02f | 21 | When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's <code>emitter</code>.</p> |
| 15d6dfaf | 22 | </div> |
| 23 | <div class="tsd-comment tsd-typography"> | |
| 24 | <h4>Author</h4><p><a href="https://github.com/pioardi">Alessandro Pio Ardizio</a></p> | |
| a76fac14 | 25 | |
| 15d6dfaf | 26 | <h4>Since</h4><p>0.0.1</p> |
| a76fac14 | 27 | </div></section> |
| fab6d3b5 | 28 | <section class="tsd-panel"> |
| a76fac14 | 29 | <h4>Type Parameters</h4> |
| fab6d3b5 | 30 | <ul class="tsd-type-parameter-list"> |
| a76fac14 | 31 | <li> |
| 3bd6a82e | 32 | <h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4> |
| 41015374 | 33 | <div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be serializable data.</p> |
| 15d6dfaf | 34 | </div> |
| 35 | <div class="tsd-comment tsd-typography"></div></li> | |
| a76fac14 | 36 | <li> |
| 3bd6a82e | 37 | <h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4> |
| e39450c0 | 38 | <div class="tsd-comment tsd-typography"><p>Type of execution response. This can only be serializable data.</p> |
| 15d6dfaf | 39 | </div> |
| 40 | <div class="tsd-comment tsd-typography"></div></li></ul></section> | |
| a76fac14 JB |
41 | <section class="tsd-panel tsd-hierarchy"> |
| 42 | <h4>Hierarchy</h4> | |
| 43 | <ul class="tsd-hierarchy"> | |
| 8d1797ad | 44 | <li><a href="FixedThreadPool.html" class="tsd-signature-type tsd-kind-class">FixedThreadPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span> |
| a76fac14 JB |
45 | <ul class="tsd-hierarchy"> |
| 46 | <li><span class="target">DynamicThreadPool</span></li></ul></li></ul></section><aside class="tsd-sources"> | |
| 47 | <ul> | |
| 15d6dfaf | 48 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/dynamic.ts#L15">src/pools/thread/dynamic.ts:15</a></li></ul></aside> |
| a76fac14 JB |
49 | <section class="tsd-panel-group tsd-index-group"> |
| 50 | <section class="tsd-panel tsd-index-panel"> | |
| 51 | <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> | |
| 52 | <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> | |
| 53 | <div class="tsd-accordion-details"> | |
| 54 | <section class="tsd-index-section"> | |
| 55 | <h3 class="tsd-index-heading">Constructors</h3> | |
| 15d6dfaf | 56 | <div class="tsd-index-list"><a href="DynamicThreadPool.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>constructor</span></a> |
| a76fac14 JB |
57 | </div></section> |
| 58 | <section class="tsd-index-section"> | |
| 59 | <h3 class="tsd-index-heading">Properties</h3> | |
| 15d6dfaf | 60 | <div class="tsd-index-list"><a href="DynamicThreadPool.html#emitter" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>emitter?</span></a> |
| 61 | <a href="DynamicThreadPool.html#filePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>file<wbr/>Path</span></a> | |
| 62 | <a href="DynamicThreadPool.html#max" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a> | |
| 63 | <a href="DynamicThreadPool.html#numberOfWorkers" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Workers</span></a> | |
| 64 | <a href="DynamicThreadPool.html#opts" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a> | |
| 65 | <a href="DynamicThreadPool.html#promiseResponseMap" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>promise<wbr/>Response<wbr/>Map</span></a> | |
| 66 | <a href="DynamicThreadPool.html#workerChoiceStrategyContext" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a> | |
| 67 | <a href="DynamicThreadPool.html#workerNodes" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a> | |
| a76fac14 JB |
68 | </div></section> |
| 69 | <section class="tsd-index-section"> | |
| 70 | <h3 class="tsd-index-heading">Accessors</h3> | |
| 15d6dfaf | 71 | <div class="tsd-index-list"><a href="DynamicThreadPool.html#busy" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g></svg><span>busy</span></a> |
| 72 | <a href="DynamicThreadPool.html#full" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>full</span></a> | |
| 73 | <a href="DynamicThreadPool.html#info" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>info</span></a> | |
| 74 | <a href="DynamicThreadPool.html#maxSize" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a> | |
| 75 | <a href="DynamicThreadPool.html#minSize" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a> | |
| 76 | <a href="DynamicThreadPool.html#type" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>type</span></a> | |
| 77 | <a href="DynamicThreadPool.html#worker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>worker</span></a> | |
| a76fac14 JB |
78 | </div></section> |
| 79 | <section class="tsd-index-section"> | |
| 80 | <h3 class="tsd-index-heading">Methods</h3> | |
| 15d6dfaf | 81 | <div class="tsd-index-list"><a href="DynamicThreadPool.html#afterTaskExecutionHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a> |
| 82 | <a href="DynamicThreadPool.html#afterWorkerSetup" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Worker<wbr/>Setup</span></a> | |
| 83 | <a href="DynamicThreadPool.html#beforeTaskExecutionHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a> | |
| 84 | <a href="DynamicThreadPool.html#chooseWorkerNode" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>choose<wbr/>Worker<wbr/>Node</span></a> | |
| 85 | <a href="DynamicThreadPool.html#createAndSetupWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker</span></a> | |
| 86 | <a href="DynamicThreadPool.html#createWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Worker</span></a> | |
| 87 | <a href="DynamicThreadPool.html#destroy" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a> | |
| 88 | <a href="DynamicThreadPool.html#destroyWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy<wbr/>Worker</span></a> | |
| 89 | <a href="DynamicThreadPool.html#enableTasksQueue" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a> | |
| 90 | <a href="DynamicThreadPool.html#execute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a> | |
| 91 | <a href="DynamicThreadPool.html#internalBusy" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>internal<wbr/>Busy</span></a> | |
| 92 | <a href="DynamicThreadPool.html#isMain" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Main</span></a> | |
| 93 | <a href="DynamicThreadPool.html#registerWorkerMessageListener" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a> | |
| 94 | <a href="DynamicThreadPool.html#sendToWorker" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Worker</span></a> | |
| 95 | <a href="DynamicThreadPool.html#setTasksQueueOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a> | |
| 96 | <a href="DynamicThreadPool.html#setWorkerChoiceStrategy" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a> | |
| 97 | <a href="DynamicThreadPool.html#setWorkerChoiceStrategyOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a> | |
| 98 | <a href="DynamicThreadPool.html#setupHook" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setup<wbr/>Hook</span></a> | |
| 99 | <a href="DynamicThreadPool.html#workerListener" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Listener</span></a> | |
| a76fac14 JB |
100 | </div></section></div></details></section></section> |
| 101 | <section class="tsd-panel-group tsd-member-group"> | |
| 102 | <h2>Constructors</h2> | |
| 3bd6a82e | 103 | <section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a> |
| 15d6dfaf | 104 | <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3> |
| 3bd6a82e | 105 | <ul class="tsd-signatures"> |
| 15d6dfaf | 106 | <li class="tsd-signature tsd-anchor-link" id="constructor.new_DynamicThreadPool"><span class="tsd-kind-constructor-signature">new <wbr/>Dynamic<wbr/>Thread<wbr/>Pool</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">min</span>, <span class="tsd-kind-parameter">max</span>, <span class="tsd-kind-parameter">filePath</span>, <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DynamicThreadPool.html" class="tsd-signature-type tsd-kind-class">DynamicThreadPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_DynamicThreadPool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 JB |
107 | <li class="tsd-description"> |
| 108 | <div class="tsd-comment tsd-typography"><p>Constructs a new poolifier dynamic thread pool.</p> | |
| 109 | </div> | |
| fab6d3b5 | 110 | <section class="tsd-panel"> |
| a76fac14 | 111 | <h4>Type Parameters</h4> |
| fab6d3b5 | 112 | <ul class="tsd-type-parameter-list"> |
| a76fac14 | 113 | <li> |
| 3bd6a82e | 114 | <h4><span class="tsd-kind-type-parameter">Data</span> = <span class="tsd-signature-type">unknown</span></h4></li> |
| a76fac14 | 115 | <li> |
| 3bd6a82e | 116 | <h4><span class="tsd-kind-type-parameter">Response</span> = <span class="tsd-signature-type">unknown</span></h4></li></ul></section> |
| a76fac14 JB |
117 | <div class="tsd-parameters"> |
| 118 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 119 | <ul class="tsd-parameter-list"> | |
| 120 | <li> | |
| 3bd6a82e | 121 | <h5><span class="tsd-kind-parameter">min</span>: <span class="tsd-signature-type">number</span></h5> |
| a76fac14 | 122 | <div class="tsd-comment tsd-typography"><p>Minimum number of threads which are always active.</p> |
| 15d6dfaf | 123 | </div> |
| 124 | <div class="tsd-comment tsd-typography"></div></li> | |
| a76fac14 | 125 | <li> |
| 3bd6a82e | 126 | <h5><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></h5> |
| a76fac14 | 127 | <div class="tsd-comment tsd-typography"><p>Maximum number of threads that can be created by this pool.</p> |
| 15d6dfaf | 128 | </div> |
| 129 | <div class="tsd-comment tsd-typography"></div></li> | |
| a76fac14 | 130 | <li> |
| 3bd6a82e | 131 | <h5><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></h5> |
| a76fac14 | 132 | <div class="tsd-comment tsd-typography"><p>Path to an implementation of a <code>ThreadWorker</code> file, which can be relative or absolute.</p> |
| 15d6dfaf | 133 | </div> |
| 134 | <div class="tsd-comment tsd-typography"></div></li> | |
| a76fac14 | 135 | <li> |
| 8d1797ad | 136 | <h5><span class="tsd-kind-parameter">opts</span>: <a href="../interfaces/PoolOptions.html" class="tsd-signature-type tsd-kind-interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = {}</span></h5> |
| a76fac14 | 137 | <div class="tsd-comment tsd-typography"><p>Options for this dynamic thread pool.</p> |
| 15d6dfaf | 138 | </div> |
| 139 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 140 | <h4 class="tsd-returns-title">Returns <a href="DynamicThreadPool.html" class="tsd-signature-type tsd-kind-class">DynamicThreadPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h4> | |
| 141 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
142 | <p>Overrides <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#constructor">constructor</a></p> |
| 143 | <ul> | |
| 15d6dfaf | 144 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/dynamic.ts#L27">src/pools/thread/dynamic.ts:27</a></li></ul></aside></li></ul></section></section> |
| a76fac14 JB |
145 | <section class="tsd-panel-group tsd-member-group"> |
| 146 | <h2>Properties</h2> | |
| 3bd6a82e | 147 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="emitter" class="tsd-anchor"></a> |
| 15d6dfaf | 148 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>emitter</span><a href="#emitter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 149 | <div class="tsd-signature"><span class="tsd-kind-property">emitter</span><span class="tsd-signature-symbol">?:</span> <a href="PoolEmitter.html" class="tsd-signature-type tsd-kind-class">PoolEmitter</a></div> |
| 6c525543 | 150 | <div class="tsd-comment tsd-typography"><p>Emitter on which events can be listened to.</p> |
| 151 | <p>Events that can currently be listened to:</p> | |
| 152 | <ul> | |
| 153 | <li><code>'full'</code>: Emitted when the pool is dynamic and full.</li> | |
| 154 | <li><code>'busy'</code>: Emitted when the pool is busy.</li> | |
| ccb7d1a7 | 155 | <li><code>'error'</code>: Emitted when an uncaught error occurs.</li> |
| 156 | <li><code>'taskError'</code>: Emitted when an error occurs while executing a task.</li> | |
| 6c525543 | 157 | </ul> |
| 15d6dfaf | 158 | </div> |
| 159 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
160 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#emitter">emitter</a></p> |
| 161 | <ul> | |
| 15d6dfaf | 162 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L47">src/pools/abstract-pool.ts:47</a></li></ul></aside></section> |
| 184d530f | 163 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="filePath" class="tsd-anchor"></a> |
| 15d6dfaf | 164 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>file<wbr/>Path</span><a href="#filePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 165 | <div class="tsd-signature"><span class="tsd-kind-property">file<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> |
| f63918da | 166 | <div class="tsd-comment tsd-typography"><p>Path to the worker file.</p> |
| 15d6dfaf | 167 | </div> |
| 168 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
169 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#filePath">filePath</a></p> |
| 170 | <ul> | |
| 15d6dfaf | 171 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L82">src/pools/abstract-pool.ts:82</a></li></ul></aside></section> |
| 184d530f | 172 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="max" class="tsd-anchor"></a> |
| 15d6dfaf | 173 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>max</span><a href="#max" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 174 | <div class="tsd-signature"><span class="tsd-kind-property">max</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> |
| cfc6e8df | 175 | <div class="tsd-comment tsd-typography"><p>Maximum number of threads that can be created by this pool.</p> |
| 15d6dfaf | 176 | </div> |
| 177 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 | 178 | <ul> |
| 15d6dfaf | 179 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/dynamic.ts#L29">src/pools/thread/dynamic.ts:29</a></li></ul></aside></section> |
| 184d530f | 180 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="numberOfWorkers" class="tsd-anchor"></a> |
| 15d6dfaf | 181 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>number<wbr/>Of<wbr/>Workers</span><a href="#numberOfWorkers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 182 | <div class="tsd-signature"><span class="tsd-kind-property">number<wbr/>Of<wbr/>Workers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> |
| cfc6e8df | 183 | <div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p> |
| 15d6dfaf | 184 | </div> |
| 185 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
186 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#numberOfWorkers">numberOfWorkers</a></p> |
| 187 | <ul> | |
| 15d6dfaf | 188 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L81">src/pools/abstract-pool.ts:81</a></li></ul></aside></section> |
| 184d530f | 189 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="opts" class="tsd-anchor"></a> |
| 15d6dfaf | 190 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 191 | <div class="tsd-signature"><span class="tsd-kind-property">opts</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/PoolOptions.html" class="tsd-signature-type tsd-kind-interface">PoolOptions</a><span class="tsd-signature-symbol"><</span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">></span></div> |
| cfc6e8df | 192 | <div class="tsd-comment tsd-typography"><p>Options for the pool.</p> |
| 15d6dfaf | 193 | </div> |
| 194 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
195 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#opts">opts</a></p> |
| 196 | <ul> | |
| 15d6dfaf | 197 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L83">src/pools/abstract-pool.ts:83</a></li></ul></aside></section> |
| 3bd6a82e | 198 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="promiseResponseMap" class="tsd-anchor"></a> |
| 15d6dfaf | 199 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>promise<wbr/>Response<wbr/>Map</span><a href="#promiseResponseMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 200 | <div class="tsd-signature"><span class="tsd-kind-property">promise<wbr/>Response<wbr/>Map</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/PromiseResponseWrapper.html" class="tsd-signature-type tsd-kind-interface">PromiseResponseWrapper</a><span class="tsd-signature-symbol"><</span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div> |
| 21402562 | 201 | <div class="tsd-comment tsd-typography"><p>The execution response promise map.</p> |
| a76fac14 | 202 | <ul> |
| 79458fb6 | 203 | <li><code>key</code>: The message id of each submitted task.</li> |
| 21402562 | 204 | <li><code>value</code>: An object that contains the worker, the execution response promise resolve and reject callbacks.</li> |
| 24c3fcb4 | 205 | </ul> |
| 21402562 | 206 | <p>When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.</p> |
| 15d6dfaf | 207 | </div> |
| 208 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 79458fb6 | 209 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#promiseResponseMap">promiseResponseMap</a></p> |
| a76fac14 | 210 | <ul> |
| 15d6dfaf | 211 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L57">src/pools/abstract-pool.ts:57</a></li></ul></aside></section> |
| 3bd6a82e | 212 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a> |
| 15d6dfaf | 213 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span><a href="#workerChoiceStrategyContext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 214 | <div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span><span class="tsd-signature-symbol">:</span> <a href="WorkerChoiceStrategyContext.html" class="tsd-signature-type tsd-kind-class">WorkerChoiceStrategyContext</a><span class="tsd-signature-symbol"><</span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></div> |
| e604957d | 215 | <div class="tsd-comment tsd-typography"><p>Worker choice strategy context referencing a worker choice algorithm implementation.</p> |
| 216 | <p>Default to a round robin algorithm.</p> | |
| 15d6dfaf | 217 | </div> |
| 218 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
219 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#workerChoiceStrategyContext">workerChoiceStrategyContext</a></p> |
| 220 | <ul> | |
| 15d6dfaf | 221 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L67">src/pools/abstract-pool.ts:67</a></li></ul></aside></section> |
| 3bd6a82e | 222 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="workerNodes" class="tsd-anchor"></a> |
| 15d6dfaf | 223 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>worker<wbr/>Nodes</span><a href="#workerNodes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 8d1797ad | 224 | <div class="tsd-signature"><span class="tsd-kind-property">worker<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/WorkerNode.html" class="tsd-signature-type tsd-kind-interface">WorkerNode</a><span class="tsd-signature-symbol"><</span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div> |
| 6c525543 | 225 | <div class="tsd-comment tsd-typography"><p>Pool worker nodes.</p> |
| 15d6dfaf | 226 | </div> |
| 227 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| ffc8d144 | 228 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#workerNodes">workerNodes</a></p> |
| a76fac14 | 229 | <ul> |
| 15d6dfaf | 230 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L44">src/pools/abstract-pool.ts:44</a></li></ul></aside></section></section> |
| a76fac14 JB |
231 | <section class="tsd-panel-group tsd-member-group"> |
| 232 | <h2>Accessors</h2> | |
| 3bd6a82e | 233 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="busy" class="tsd-anchor"></a> |
| 15d6dfaf | 234 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>busy</span><a href="#busy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 235 | <ul class="tsd-signatures tsd-is-protected"> |
| a76fac14 JB |
236 | <li class="tsd-signature" id="busy.busy-1"><span class="tsd-signature-symbol">get</span> busy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> |
| 237 | <li class="tsd-description"> | |
| 6c525543 | 238 | <div class="tsd-comment tsd-typography"><p>Whether the pool is busy or not.</p> |
| 239 | <p>The pool busyness boolean status.</p> | |
| 240 | </div> | |
| 15d6dfaf | 241 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> |
| 242 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
243 | <p>Overrides FixedThreadPool.busy</p> |
| 244 | <ul> | |
| 15d6dfaf | 245 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/dynamic.ts#L47">src/pools/thread/dynamic.ts:47</a></li></ul></aside></li></ul></section> |
| 184d530f | 246 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="full" class="tsd-anchor"></a> |
| 15d6dfaf | 247 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>full</span><a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 184d530f | 248 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 0770fe62 | 249 | <li class="tsd-signature" id="full.full-1"><span class="tsd-signature-symbol">get</span> full<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> |
| a76fac14 | 250 | <li class="tsd-description"> |
| 6c525543 | 251 | <div class="tsd-comment tsd-typography"><p>Whether the pool is full or not.</p> |
| 252 | <p>The pool filling boolean status.</p> | |
| 253 | </div> | |
| 15d6dfaf | 254 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> |
| 255 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 184d530f | 256 | <p>Inherited from FixedThreadPool.full</p> |
| 0770fe62 | 257 | <ul> |
| 15d6dfaf | 258 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L360">src/pools/abstract-pool.ts:360</a></li></ul></aside></li></ul></section> |
| a2742ce7 | 259 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="info" class="tsd-anchor"></a> |
| 15d6dfaf | 260 | <h3 class="tsd-anchor-link"><span>info</span><a href="#info" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| a2742ce7 | 261 | <ul class="tsd-signatures tsd-is-inherited"> |
| 262 | <li class="tsd-signature" id="info.info-1"><span class="tsd-signature-symbol">get</span> info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></li> | |
| ffc8d144 | 263 | <li class="tsd-description"> |
| a2742ce7 | 264 | <div class="tsd-comment tsd-typography"><p>Pool information.</p> |
| ffc8d144 | 265 | </div> |
| 15d6dfaf | 266 | <h4 class="tsd-returns-title">Returns <a href="../interfaces/PoolInfo.html" class="tsd-signature-type tsd-kind-interface">PoolInfo</a></h4> |
| 267 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a2742ce7 | 268 | <p>Inherited from FixedThreadPool.info</p> |
| ffc8d144 | 269 | <ul> |
| 15d6dfaf | 270 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L215">src/pools/abstract-pool.ts:215</a></li></ul></aside></li></ul></section> |
| a2742ce7 | 271 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="maxSize" class="tsd-anchor"></a> |
| 15d6dfaf | 272 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>max<wbr/>Size</span><a href="#maxSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| a2742ce7 | 273 | <ul class="tsd-signatures tsd-is-protected"> |
| 274 | <li class="tsd-signature" id="maxSize.maxSize-1"><span class="tsd-signature-symbol">get</span> maxSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> | |
| 0770fe62 | 275 | <li class="tsd-description"> |
| a2742ce7 | 276 | <div class="tsd-comment tsd-typography"><p>Pool maximum size.</p> |
| 0770fe62 | 277 | </div> |
| 15d6dfaf | 278 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 279 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a2742ce7 | 280 | <p>Overrides FixedThreadPool.maxSize</p> |
| a76fac14 | 281 | <ul> |
| 15d6dfaf | 282 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/dynamic.ts#L42">src/pools/thread/dynamic.ts:42</a></li></ul></aside></li></ul></section> |
| a2742ce7 | 283 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="minSize" class="tsd-anchor"></a> |
| 15d6dfaf | 284 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>min<wbr/>Size</span><a href="#minSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| a2742ce7 | 285 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 286 | <li class="tsd-signature" id="minSize.minSize-1"><span class="tsd-signature-symbol">get</span> minSize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> | |
| 2c94c3a5 | 287 | <li class="tsd-description"> |
| a2742ce7 | 288 | <div class="tsd-comment tsd-typography"><p>Pool minimum size.</p> |
| 2c94c3a5 | 289 | </div> |
| 15d6dfaf | 290 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| 291 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a2742ce7 | 292 | <p>Inherited from FixedThreadPool.minSize</p> |
| 2c94c3a5 | 293 | <ul> |
| 15d6dfaf | 294 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L110">src/pools/thread/fixed.ts:110</a></li></ul></aside></li></ul></section> |
| 184d530f | 295 | <section class="tsd-panel tsd-member tsd-is-protected"><a id="type" class="tsd-anchor"></a> |
| 15d6dfaf | 296 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 184d530f | 297 | <ul class="tsd-signatures tsd-is-protected"> |
| a2742ce7 | 298 | <li class="tsd-signature" id="type.type-1"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"fixed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dynamic"</span></li> |
| a76fac14 | 299 | <li class="tsd-description"> |
| 6c525543 | 300 | <div class="tsd-comment tsd-typography"><p>Pool type.</p> |
| 301 | <p>If it is <code>'dynamic'</code>, it provides the <code>max</code> property.</p> | |
| 302 | </div> | |
| 15d6dfaf | 303 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">"fixed"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dynamic"</span></h4> |
| 304 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
305 | <p>Overrides FixedThreadPool.type</p> |
| 306 | <ul> | |
| 15d6dfaf | 307 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/dynamic.ts#L37">src/pools/thread/dynamic.ts:37</a></li></ul></aside></li></ul></section> |
| 184d530f | 308 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="worker" class="tsd-anchor"></a> |
| 15d6dfaf | 309 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker</span><a href="#worker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 184d530f | 310 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 311 | <li class="tsd-signature" id="worker.worker-1"><span class="tsd-signature-symbol">get</span> worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"cluster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thread"</span></li> | |
| 312 | <li class="tsd-description"> | |
| 313 | <div class="tsd-comment tsd-typography"><p>Gets the worker type.</p> | |
| 314 | </div> | |
| 15d6dfaf | 315 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">"cluster"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"thread"</span></h4> |
| 316 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 184d530f | 317 | <p>Inherited from FixedThreadPool.worker</p> |
| 318 | <ul> | |
| 15d6dfaf | 319 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L105">src/pools/thread/fixed.ts:105</a></li></ul></aside></li></ul></section></section> |
| a76fac14 JB |
320 | <section class="tsd-panel-group tsd-member-group"> |
| 321 | <h2>Methods</h2> | |
| 3bd6a82e | 322 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterTaskExecutionHook" class="tsd-anchor"></a> |
| 15d6dfaf | 323 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span><a href="#afterTaskExecutionHook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 324 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 325 | <li class="tsd-signature tsd-anchor-link" id="afterTaskExecutionHook.afterTaskExecutionHook-1"><span class="tsd-kind-call-signature">after<wbr/>Task<wbr/>Execution<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterTaskExecutionHook.afterTaskExecutionHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| ed1ecf09 | 326 | <li class="tsd-description"> |
| 18ba88e2 | 327 | <div class="tsd-comment tsd-typography"><p>Hook executed after the worker task execution. |
| ed1ecf09 JB |
328 | Can be overridden.</p> |
| 329 | </div> | |
| 330 | <div class="tsd-parameters"> | |
| 331 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 332 | <ul class="tsd-parameter-list"> | |
| 333 | <li> | |
| 8d1797ad | 334 | <h5><span class="tsd-kind-parameter">worker</span>: <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h5> |
| 79458fb6 | 335 | <div class="tsd-comment tsd-typography"><p>The worker.</p> |
| 15d6dfaf | 336 | </div> |
| 337 | <div class="tsd-comment tsd-typography"></div></li> | |
| ed1ecf09 | 338 | <li> |
| 2c94c3a5 | 339 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5> |
| 79458fb6 | 340 | <div class="tsd-comment tsd-typography"><p>The received message.</p> |
| 15d6dfaf | 341 | </div> |
| 342 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 343 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 344 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 18ba88e2 | 345 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#afterTaskExecutionHook">afterTaskExecutionHook</a></p> |
| ed1ecf09 | 346 | <ul> |
| 15d6dfaf | 347 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L464">src/pools/abstract-pool.ts:464</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 348 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="afterWorkerSetup" class="tsd-anchor"></a> |
| 15d6dfaf | 349 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Worker<wbr/>Setup</span><a href="#afterWorkerSetup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 350 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 351 | <li class="tsd-signature tsd-anchor-link" id="afterWorkerSetup.afterWorkerSetup-1"><span class="tsd-kind-call-signature">after<wbr/>Worker<wbr/>Setup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#afterWorkerSetup.afterWorkerSetup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 352 | <li class="tsd-description"> |
| 6c525543 | 353 | <div class="tsd-comment tsd-typography"><p>Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.</p> |
| 354 | <p>Can be used to update the <code>maxListeners</code> or binding the <code>main-worker</code><-><code>worker</code> connection if not bind by default.</p> | |
| 355 | </div> | |
| a76fac14 JB |
356 | <div class="tsd-parameters"> |
| 357 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 358 | <ul class="tsd-parameter-list"> | |
| 359 | <li> | |
| 8d1797ad | 360 | <h5><span class="tsd-kind-parameter">worker</span>: <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h5> |
| 6c525543 | 361 | <div class="tsd-comment tsd-typography"><p>The newly created worker.</p> |
| 15d6dfaf | 362 | </div> |
| 363 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 364 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 365 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
366 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#afterWorkerSetup">afterWorkerSetup</a></p> |
| 367 | <ul> | |
| 15d6dfaf | 368 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L90">src/pools/thread/fixed.ts:90</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 369 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="beforeTaskExecutionHook" class="tsd-anchor"></a> |
| 15d6dfaf | 370 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span><a href="#beforeTaskExecutionHook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 371 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 372 | <li class="tsd-signature tsd-anchor-link" id="beforeTaskExecutionHook.beforeTaskExecutionHook-1"><span class="tsd-kind-call-signature">before<wbr/>Task<wbr/>Execution<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerNodeKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#beforeTaskExecutionHook.beforeTaskExecutionHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| ed1ecf09 | 373 | <li class="tsd-description"> |
| 18ba88e2 | 374 | <div class="tsd-comment tsd-typography"><p>Hook executed before the worker task execution. |
| ed1ecf09 JB |
375 | Can be overridden.</p> |
| 376 | </div> | |
| 377 | <div class="tsd-parameters"> | |
| 378 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 379 | <ul class="tsd-parameter-list"> | |
| 380 | <li> | |
| 3bd6a82e | 381 | <h5><span class="tsd-kind-parameter">workerNodeKey</span>: <span class="tsd-signature-type">number</span></h5> |
| ffc8d144 | 382 | <div class="tsd-comment tsd-typography"><p>The worker node key.</p> |
| 15d6dfaf | 383 | </div> |
| 384 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 385 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 386 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 18ba88e2 | 387 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#beforeTaskExecutionHook">beforeTaskExecutionHook</a></p> |
| ed1ecf09 | 388 | <ul> |
| 15d6dfaf | 389 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L453">src/pools/abstract-pool.ts:453</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 390 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="chooseWorkerNode" class="tsd-anchor"></a> |
| 15d6dfaf | 391 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>choose<wbr/>Worker<wbr/>Node</span><a href="#chooseWorkerNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 392 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 393 | <li class="tsd-signature tsd-anchor-link" id="chooseWorkerNode.chooseWorkerNode-1"><span class="tsd-kind-call-signature">choose<wbr/>Worker<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#chooseWorkerNode.chooseWorkerNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 394 | <li class="tsd-description"> |
| ffc8d144 | 395 | <div class="tsd-comment tsd-typography"><p>Chooses a worker node for the next task.</p> |
| 811dc01f | 396 | <p>The default worker choice strategy uses a round robin algorithm to distribute the load.</p> |
| a76fac14 | 397 | </div> |
| 811dc01f | 398 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The worker node key</p> |
| 15d6dfaf | 399 | |
| 400 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| ffc8d144 | 401 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#chooseWorkerNode">chooseWorkerNode</a></p> |
| a76fac14 | 402 | <ul> |
| 15d6dfaf | 403 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L532">src/pools/abstract-pool.ts:532</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 404 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createAndSetupWorker" class="tsd-anchor"></a> |
| 15d6dfaf | 405 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>And<wbr/>Setup<wbr/>Worker</span><a href="#createAndSetupWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 406 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 407 | <li class="tsd-signature tsd-anchor-link" id="createAndSetupWorker.createAndSetupWorker-1"><span class="tsd-kind-call-signature">create<wbr/>And<wbr/>Setup<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><a href="#createAndSetupWorker.createAndSetupWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 408 | <li class="tsd-description"> |
| ffc8d144 | 409 | <div class="tsd-comment tsd-typography"><p>Creates a new worker and sets it up completely in the pool worker nodes.</p> |
| a76fac14 | 410 | </div> |
| fab6d3b5 | 411 | <h4 class="tsd-returns-title">Returns <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h4><p>New, completely set up worker.</p> |
| 15d6dfaf | 412 | |
| 413 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
414 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#createAndSetupWorker">createAndSetupWorker</a></p> |
| 415 | <ul> | |
| 15d6dfaf | 416 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L596">src/pools/abstract-pool.ts:596</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 417 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="createWorker" class="tsd-anchor"></a> |
| 15d6dfaf | 418 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>Worker</span><a href="#createWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 419 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 420 | <li class="tsd-signature tsd-anchor-link" id="createWorker.createWorker-1"><span class="tsd-kind-call-signature">create<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a><a href="#createWorker.createWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 421 | <li class="tsd-description"> |
| 6c525543 | 422 | <div class="tsd-comment tsd-typography"><p>Returns a newly created worker.</p> |
| 423 | </div> | |
| 15d6dfaf | 424 | <h4 class="tsd-returns-title">Returns <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h4> |
| 425 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
426 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#createWorker">createWorker</a></p> |
| 427 | <ul> | |
| 15d6dfaf | 428 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L83">src/pools/thread/fixed.ts:83</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 429 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a> |
| 15d6dfaf | 430 | <h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 431 | <ul class="tsd-signatures tsd-is-inherited"> |
| 15d6dfaf | 432 | <li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 433 | <li class="tsd-description"> |
| 6c525543 | 434 | <div class="tsd-comment tsd-typography"><p>Shutdowns every current worker in this pool.</p> |
| 435 | </div> | |
| 15d6dfaf | 436 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> |
| 437 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
438 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#destroy">destroy</a></p> |
| 439 | <ul> | |
| 15d6dfaf | 440 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L415">src/pools/abstract-pool.ts:415</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 441 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="destroyWorker" class="tsd-anchor"></a> |
| 15d6dfaf | 442 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>destroy<wbr/>Worker</span><a href="#destroyWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 443 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 444 | <li class="tsd-signature tsd-anchor-link" id="destroyWorker.destroyWorker-1"><span class="tsd-kind-call-signature">destroy<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#destroyWorker.destroyWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 445 | <li class="tsd-description"> |
| 6c525543 | 446 | <div class="tsd-comment tsd-typography"><p>Shutdowns the given worker.</p> |
| 447 | </div> | |
| a76fac14 JB |
448 | <div class="tsd-parameters"> |
| 449 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 450 | <ul class="tsd-parameter-list"> | |
| 451 | <li> | |
| 8d1797ad | 452 | <h5><span class="tsd-kind-parameter">worker</span>: <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h5> |
| 6c525543 | 453 | <div class="tsd-comment tsd-typography"><p>A worker within <code>workerNodes</code>.</p> |
| 15d6dfaf | 454 | </div> |
| 455 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 456 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> | |
| 457 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
458 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#destroyWorker">destroyWorker</a></p> |
| 459 | <ul> | |
| 15d6dfaf | 460 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L59">src/pools/thread/fixed.ts:59</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 461 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableTasksQueue" class="tsd-anchor"></a> |
| 15d6dfaf | 462 | <h3 class="tsd-anchor-link"><span>enable<wbr/>Tasks<wbr/>Queue</span><a href="#enableTasksQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 463 | <ul class="tsd-signatures tsd-is-inherited"> |
| 15d6dfaf | 464 | <li class="tsd-signature tsd-anchor-link" id="enableTasksQueue.enableTasksQueue-1"><span class="tsd-kind-call-signature">enable<wbr/>Tasks<wbr/>Queue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enable</span>, <span class="tsd-kind-parameter">tasksQueueOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#enableTasksQueue.enableTasksQueue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6047493a | 465 | <li class="tsd-description"> |
| 466 | <div class="tsd-comment tsd-typography"><p>Enables/disables the worker tasks queue in this pool.</p> | |
| 467 | </div> | |
| 468 | <div class="tsd-parameters"> | |
| 469 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 470 | <ul class="tsd-parameter-list"> | |
| 471 | <li> | |
| 3bd6a82e | 472 | <h5><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></h5> |
| 6047493a | 473 | <div class="tsd-comment tsd-typography"><p>Whether to enable or disable the worker tasks queue.</p> |
| 15d6dfaf | 474 | </div> |
| 475 | <div class="tsd-comment tsd-typography"></div></li> | |
| 6047493a | 476 | <li> |
| 8d1797ad | 477 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5> |
| d655c2c2 | 478 | <div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p> |
| 15d6dfaf | 479 | </div> |
| 480 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 481 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 482 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 6047493a | 483 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#enableTasksQueue">enableTasksQueue</a></p> |
| 484 | <ul> | |
| 15d6dfaf | 485 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L325">src/pools/abstract-pool.ts:325</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 486 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="execute" class="tsd-anchor"></a> |
| 15d6dfaf | 487 | <h3 class="tsd-anchor-link"><span>execute</span><a href="#execute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 488 | <ul class="tsd-signatures tsd-is-inherited"> |
| 15d6dfaf | 489 | <li class="tsd-signature tsd-anchor-link" id="execute.execute-1"><span class="tsd-kind-call-signature">execute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span><a href="#execute.execute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 490 | <li class="tsd-description"> |
| 1bb559f9 | 491 | <div class="tsd-comment tsd-typography"><p>Executes the specified function in the worker constructor with the task data input parameter.</p> |
| 6c525543 | 492 | </div> |
| a76fac14 JB |
493 | <div class="tsd-parameters"> |
| 494 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 495 | <ul class="tsd-parameter-list"> | |
| 496 | <li> | |
| 3bd6a82e | 497 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Data</span></h5> |
| 761b0c73 | 498 | <div class="tsd-comment tsd-typography"><p>The task input data for the specified worker function. This can only be serializable data.</p> |
| 15d6dfaf | 499 | </div> |
| 500 | <div class="tsd-comment tsd-typography"></div></li> | |
| 2c94c3a5 | 501 | <li> |
| 502 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5> | |
| 503 | <div class="tsd-comment tsd-typography"><p>The name of the worker function to execute. If not specified, the default worker function will be executed.</p> | |
| 15d6dfaf | 504 | </div> |
| 505 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| fab6d3b5 | 506 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">></span></h4><p>Promise that will be fulfilled when the task is completed.</p> |
| 15d6dfaf | 507 | |
| 508 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
509 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#execute">execute</a></p> |
| 510 | <ul> | |
| 15d6dfaf | 511 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L380">src/pools/abstract-pool.ts:380</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 512 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="internalBusy" class="tsd-anchor"></a> |
| 15d6dfaf | 513 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>internal<wbr/>Busy</span><a href="#internalBusy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 514 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 515 | <li class="tsd-signature tsd-anchor-link" id="internalBusy.internalBusy-1"><span class="tsd-kind-call-signature">internal<wbr/>Busy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#internalBusy.internalBusy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 JB |
516 | <li class="tsd-description"> |
| 517 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> | |
| 0770fe62 | 518 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#internalBusy">internalBusy</a></p> |
| a76fac14 | 519 | <ul> |
| 15d6dfaf | 520 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L371">src/pools/abstract-pool.ts:371</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 521 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="isMain" class="tsd-anchor"></a> |
| 15d6dfaf | 522 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>is<wbr/>Main</span><a href="#isMain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 523 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 524 | <li class="tsd-signature tsd-anchor-link" id="isMain.isMain-1"><span class="tsd-kind-call-signature">is<wbr/>Main</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isMain.isMain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 525 | <li class="tsd-description"> |
| 6c525543 | 526 | <div class="tsd-comment tsd-typography"><p>Should return whether the worker is the main worker or not.</p> |
| 527 | </div> | |
| 15d6dfaf | 528 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> |
| 529 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
530 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#isMain">isMain</a></p> |
| 531 | <ul> | |
| 15d6dfaf | 532 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L54">src/pools/thread/fixed.ts:54</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 533 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="registerWorkerMessageListener" class="tsd-anchor"></a> |
| 15d6dfaf | 534 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#registerWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 535 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 536 | <li class="tsd-signature tsd-anchor-link" id="registerWorkerMessageListener.registerWorkerMessageListener-1"><span class="tsd-kind-call-signature">register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Message</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#registerWorkerMessageListener.registerWorkerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 537 | <li class="tsd-description"> |
| 6c525543 | 538 | <div class="tsd-comment tsd-typography"><p>Registers a listener callback on the given worker.</p> |
| 539 | </div> | |
| fab6d3b5 | 540 | <section class="tsd-panel"> |
| a76fac14 | 541 | <h4>Type Parameters</h4> |
| fab6d3b5 | 542 | <ul class="tsd-type-parameter-list"> |
| a76fac14 | 543 | <li> |
| 3bd6a82e | 544 | <h4><span class="tsd-kind-type-parameter">Message</span></h4></li></ul></section> |
| a76fac14 JB |
545 | <div class="tsd-parameters"> |
| 546 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 547 | <ul class="tsd-parameter-list"> | |
| 548 | <li> | |
| 8d1797ad | 549 | <h5><span class="tsd-kind-parameter">worker</span>: <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h5> |
| 6c525543 | 550 | <div class="tsd-comment tsd-typography"><p>The worker which should register a listener.</p> |
| 15d6dfaf | 551 | </div> |
| 552 | <div class="tsd-comment tsd-typography"></div></li> | |
| a76fac14 | 553 | <li> |
| 3bd6a82e | 554 | <h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5> |
| 6c525543 | 555 | <div class="tsd-comment tsd-typography"><p>The message listener callback.</p> |
| 556 | </div> | |
| 15d6dfaf | 557 | <div class="tsd-comment tsd-typography"></div> |
| a76fac14 JB |
558 | <ul class="tsd-parameters"> |
| 559 | <li class="tsd-parameter-signature"> | |
| 3bd6a82e | 560 | <ul class="tsd-signatures"> |
| 561 | <li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> | |
| a76fac14 JB |
562 | <li class="tsd-description"> |
| 563 | <div class="tsd-parameters"> | |
| 564 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 565 | <ul class="tsd-parameter-list"> | |
| 566 | <li> | |
| 2c94c3a5 | 567 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5></li></ul></div> |
| a76fac14 | 568 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div> |
| 15d6dfaf | 569 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 570 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
571 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#registerWorkerMessageListener">registerWorkerMessageListener</a></p> |
| 572 | <ul> | |
| 15d6dfaf | 573 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L75">src/pools/thread/fixed.ts:75</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 574 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="sendToWorker" class="tsd-anchor"></a> |
| 15d6dfaf | 575 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>send<wbr/>To<wbr/>Worker</span><a href="#sendToWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 576 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 577 | <li class="tsd-signature tsd-anchor-link" id="sendToWorker.sendToWorker-1"><span class="tsd-kind-call-signature">send<wbr/>To<wbr/>Worker</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">worker</span>, <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendToWorker.sendToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 578 | <li class="tsd-description"> |
| 6c525543 | 579 | <div class="tsd-comment tsd-typography"><p>Sends a message to the given worker.</p> |
| 580 | </div> | |
| a76fac14 JB |
581 | <div class="tsd-parameters"> |
| 582 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 583 | <ul class="tsd-parameter-list"> | |
| 584 | <li> | |
| 8d1797ad | 585 | <h5><span class="tsd-kind-parameter">worker</span>: <a href="../types/ThreadWorkerWithMessageChannel.html" class="tsd-signature-type tsd-kind-type-alias">ThreadWorkerWithMessageChannel</a></h5> |
| 6c525543 | 586 | <div class="tsd-comment tsd-typography"><p>The worker which should receive the message.</p> |
| 15d6dfaf | 587 | </div> |
| 588 | <div class="tsd-comment tsd-typography"></div></li> | |
| a76fac14 | 589 | <li> |
| 2c94c3a5 | 590 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5> |
| 6c525543 | 591 | <div class="tsd-comment tsd-typography"><p>The message.</p> |
| 15d6dfaf | 592 | </div> |
| 593 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 594 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 595 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
596 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#sendToWorker">sendToWorker</a></p> |
| 597 | <ul> | |
| 15d6dfaf | 598 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/thread/fixed.ts#L67">src/pools/thread/fixed.ts:67</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 599 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="setTasksQueueOptions" class="tsd-anchor"></a> |
| 15d6dfaf | 600 | <h3 class="tsd-anchor-link"><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span><a href="#setTasksQueueOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 601 | <ul class="tsd-signatures tsd-is-inherited"> |
| 15d6dfaf | 602 | <li class="tsd-signature tsd-anchor-link" id="setTasksQueueOptions.setTasksQueueOptions-1"><span class="tsd-kind-call-signature">set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">tasksQueueOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setTasksQueueOptions.setTasksQueueOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6047493a | 603 | <li class="tsd-description"> |
| 604 | <div class="tsd-comment tsd-typography"><p>Sets the worker tasks queue options in this pool.</p> | |
| 605 | </div> | |
| 606 | <div class="tsd-parameters"> | |
| 607 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 608 | <ul class="tsd-parameter-list"> | |
| 609 | <li> | |
| 8d1797ad | 610 | <h5><span class="tsd-kind-parameter">tasksQueueOptions</span>: <a href="../interfaces/TasksQueueOptions.html" class="tsd-signature-type tsd-kind-interface">TasksQueueOptions</a></h5> |
| 6047493a | 611 | <div class="tsd-comment tsd-typography"><p>The worker tasks queue options.</p> |
| 15d6dfaf | 612 | </div> |
| 613 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 614 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 615 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 6047493a | 616 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setTasksQueueOptions">setTasksQueueOptions</a></p> |
| 617 | <ul> | |
| 15d6dfaf | 618 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L337">src/pools/abstract-pool.ts:337</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 619 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a> |
| 15d6dfaf | 620 | <h3 class="tsd-anchor-link"><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span><a href="#setWorkerChoiceStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 621 | <ul class="tsd-signatures tsd-is-inherited"> |
| 15d6dfaf | 622 | <li class="tsd-signature tsd-anchor-link" id="setWorkerChoiceStrategy.setWorkerChoiceStrategy-1"><span class="tsd-kind-call-signature">set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerChoiceStrategy</span>, <span class="tsd-kind-parameter">workerChoiceStrategyOptions</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setWorkerChoiceStrategy.setWorkerChoiceStrategy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 623 | <li class="tsd-description"> |
| 6c525543 | 624 | <div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy in this pool.</p> |
| 625 | </div> | |
| a76fac14 JB |
626 | <div class="tsd-parameters"> |
| 627 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 628 | <ul class="tsd-parameter-list"> | |
| 629 | <li> | |
| 811dc01f | 630 | <h5><span class="tsd-kind-parameter">workerChoiceStrategy</span>: <span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LEAST_USED"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LEAST_BUSY"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"FAIR_SHARE"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"WEIGHTED_ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"INTERLEAVED_WEIGHTED_ROUND_ROBIN"</span></h5> |
| 6c525543 | 631 | <div class="tsd-comment tsd-typography"><p>The worker choice strategy.</p> |
| 15d6dfaf | 632 | </div> |
| 633 | <div class="tsd-comment tsd-typography"></div></li> | |
| a8aeac44 | 634 | <li> |
| 8d1797ad | 635 | <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5> |
| a8aeac44 | 636 | <div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p> |
| 15d6dfaf | 637 | </div> |
| 638 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 639 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 640 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
641 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setWorkerChoiceStrategy">setWorkerChoiceStrategy</a></p> |
| 642 | <ul> | |
| 15d6dfaf | 643 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L284">src/pools/abstract-pool.ts:284</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 644 | <section class="tsd-panel tsd-member tsd-is-inherited"><a id="setWorkerChoiceStrategyOptions" class="tsd-anchor"></a> |
| 15d6dfaf | 645 | <h3 class="tsd-anchor-link"><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><a href="#setWorkerChoiceStrategyOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 646 | <ul class="tsd-signatures tsd-is-inherited"> |
| 15d6dfaf | 647 | <li class="tsd-signature tsd-anchor-link" id="setWorkerChoiceStrategyOptions.setWorkerChoiceStrategyOptions-1"><span class="tsd-kind-call-signature">set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setWorkerChoiceStrategyOptions.setWorkerChoiceStrategyOptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| 6047493a | 648 | <li class="tsd-description"> |
| 649 | <div class="tsd-comment tsd-typography"><p>Sets the worker choice strategy options in this pool.</p> | |
| 650 | </div> | |
| 651 | <div class="tsd-parameters"> | |
| 652 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 653 | <ul class="tsd-parameter-list"> | |
| 654 | <li> | |
| 8d1797ad | 655 | <h5><span class="tsd-kind-parameter">workerChoiceStrategyOptions</span>: <a href="../interfaces/WorkerChoiceStrategyOptions.html" class="tsd-signature-type tsd-kind-interface">WorkerChoiceStrategyOptions</a></h5> |
| 6047493a | 656 | <div class="tsd-comment tsd-typography"><p>The worker choice strategy options.</p> |
| 15d6dfaf | 657 | </div> |
| 658 | <div class="tsd-comment tsd-typography"></div></li></ul></div> | |
| 659 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
| 660 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| 6047493a | 661 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setWorkerChoiceStrategyOptions">setWorkerChoiceStrategyOptions</a></p> |
| 662 | <ul> | |
| 15d6dfaf | 663 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L314">src/pools/abstract-pool.ts:314</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 664 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="setupHook" class="tsd-anchor"></a> |
| 15d6dfaf | 665 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>setup<wbr/>Hook</span><a href="#setupHook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 666 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 667 | <li class="tsd-signature tsd-anchor-link" id="setupHook.setupHook-1"><span class="tsd-kind-call-signature">setup<wbr/>Hook</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setupHook.setupHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 668 | <li class="tsd-description"> |
| 18ba88e2 | 669 | <div class="tsd-comment tsd-typography"><p>Setup hook to execute code before worker node are created in the abstract constructor. |
| fa643634 | 670 | Can be overridden</p> |
| a76fac14 | 671 | </div> |
| 15d6dfaf | 672 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 673 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
674 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#setupHook">setupHook</a></p> |
| 675 | <ul> | |
| 15d6dfaf | 676 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L438">src/pools/abstract-pool.ts:438</a></li></ul></aside></li></ul></section> |
| 3bd6a82e | 677 | <section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="workerListener" class="tsd-anchor"></a> |
| 15d6dfaf | 678 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>worker<wbr/>Listener</span><a href="#workerListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3> |
| 3bd6a82e | 679 | <ul class="tsd-signatures tsd-is-protected tsd-is-inherited"> |
| 15d6dfaf | 680 | <li class="tsd-signature tsd-anchor-link" id="workerListener.workerListener-1"><span class="tsd-kind-call-signature">worker<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><a href="#workerListener.workerListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> |
| a76fac14 | 681 | <li class="tsd-description"> |
| ffc8d144 | 682 | <div class="tsd-comment tsd-typography"><p>This function is the listener registered for each worker message.</p> |
| a76fac14 | 683 | </div> |
| fab6d3b5 | 684 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4><p>The listener function to execute when a message is received from a worker.</p> |
| 685 | ||
| a76fac14 JB |
686 | <ul class="tsd-parameters"> |
| 687 | <li class="tsd-parameter-signature"> | |
| 3bd6a82e | 688 | <ul class="tsd-signatures"> |
| 689 | <li class="tsd-signature" id="workerListener.workerListener-1.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> | |
| a76fac14 | 690 | <li class="tsd-description"> |
| ffc8d144 | 691 | <div class="tsd-comment tsd-typography"><p>This function is the listener registered for each worker message.</p> |
| a76fac14 JB |
692 | </div> |
| 693 | <div class="tsd-parameters"> | |
| 694 | <h4 class="tsd-parameters-title">Parameters</h4> | |
| 695 | <ul class="tsd-parameter-list"> | |
| 696 | <li> | |
| 2c94c3a5 | 697 | <h5><span class="tsd-kind-parameter">message</span>: <a href="../interfaces/MessageValue.html" class="tsd-signature-type tsd-kind-interface">MessageValue</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type ">Worker</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MessagePort</span><span class="tsd-signature-symbol">></span></h5></li></ul></div> |
| fab6d3b5 | 698 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>The listener function to execute when a message is received from a worker.</p> |
| 15d6dfaf | 699 | |
| 700 | <div class="tsd-comment tsd-typography"></div></li></ul></li></ul> | |
| 701 | <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"> | |
| a76fac14 JB |
702 | <p>Inherited from <a href="FixedThreadPool.html">FixedThreadPool</a>.<a href="FixedThreadPool.html#workerListener">workerListener</a></p> |
| 703 | <ul> | |
| 15d6dfaf | 704 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/1659c4c/src/pools/abstract-pool.ts#L629">src/pools/abstract-pool.ts:629</a></li></ul></aside></li></ul></section></section></div> |
| ec06e4dd | 705 | <div class="col-sidebar"> |
| 706 | <div class="page-menu"> | |
| a76fac14 JB |
707 | <div class="tsd-navigation settings"> |
| 708 | <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> | |
| 15d6dfaf | 709 | <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary> |
| a76fac14 JB |
710 | <div class="tsd-accordion-details"> |
| 711 | <div class="tsd-filter-visibility"> | |
| 712 | <h4 class="uppercase">Member Visibility</h4><form> | |
| 713 | <ul id="tsd-filter-options"> | |
| 714 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> | |
| 715 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> | |
| 716 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> | |
| 717 | <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> | |
| 718 | <div class="tsd-theme-toggle"> | |
| 3bd6a82e | 719 | <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> |
| ec06e4dd | 720 | <details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"> |
| 15d6dfaf | 721 | <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary> |
| a76fac14 JB |
722 | <div class="tsd-accordion-details"> |
| 723 | <ul> | |
| 15d6dfaf | 724 | <li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li> |
| 725 | <li><a href="#emitter" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>emitter</span></a></li> | |
| 726 | <li><a href="#filePath" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>file<wbr/>Path</span></a></li> | |
| 727 | <li><a href="#max" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>max</span></a></li> | |
| 728 | <li><a href="#numberOfWorkers" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>number<wbr/>Of<wbr/>Workers</span></a></li> | |
| 729 | <li><a href="#opts" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>opts</span></a></li> | |
| 730 | <li><a href="#promiseResponseMap" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>promise<wbr/>Response<wbr/>Map</span></a></li> | |
| 731 | <li><a href="#workerChoiceStrategyContext" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li> | |
| 732 | <li><a href="#workerNodes" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>worker<wbr/>Nodes</span></a></li> | |
| 733 | <li><a href="#busy" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>busy</span></a></li> | |
| 734 | <li><a href="#full" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>full</span></a></li> | |
| 735 | <li><a href="#info" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>info</span></a></li> | |
| 736 | <li><a href="#maxSize" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>max<wbr/>Size</span></a></li> | |
| 737 | <li><a href="#minSize" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>min<wbr/>Size</span></a></li> | |
| 738 | <li><a href="#type" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>type</span></a></li> | |
| 739 | <li><a href="#worker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>worker</span></a></li> | |
| 740 | <li><a href="#afterTaskExecutionHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a></li> | |
| 741 | <li><a href="#afterWorkerSetup" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>after<wbr/>Worker<wbr/>Setup</span></a></li> | |
| 742 | <li><a href="#beforeTaskExecutionHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>before<wbr/>Task<wbr/>Execution<wbr/>Hook</span></a></li> | |
| 743 | <li><a href="#chooseWorkerNode" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>choose<wbr/>Worker<wbr/>Node</span></a></li> | |
| 744 | <li><a href="#createAndSetupWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker</span></a></li> | |
| 745 | <li><a href="#createWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Worker</span></a></li> | |
| 746 | <li><a href="#destroy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li> | |
| 747 | <li><a href="#destroyWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy<wbr/>Worker</span></a></li> | |
| 748 | <li><a href="#enableTasksQueue" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Tasks<wbr/>Queue</span></a></li> | |
| 749 | <li><a href="#execute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>execute</span></a></li> | |
| 750 | <li><a href="#internalBusy" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>internal<wbr/>Busy</span></a></li> | |
| 751 | <li><a href="#isMain" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Main</span></a></li> | |
| 752 | <li><a href="#registerWorkerMessageListener" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a></li> | |
| 753 | <li><a href="#sendToWorker" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>To<wbr/>Worker</span></a></li> | |
| 754 | <li><a href="#setTasksQueueOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Tasks<wbr/>Queue<wbr/>Options</span></a></li> | |
| 755 | <li><a href="#setWorkerChoiceStrategy" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a></li> | |
| 756 | <li><a href="#setWorkerChoiceStrategyOptions" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li> | |
| 757 | <li><a href="#setupHook" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>setup<wbr/>Hook</span></a></li> | |
| 758 | <li><a href="#workerListener" class="tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>worker<wbr/>Listener</span></a></li></ul></div></details></div> | |
| ec06e4dd | 759 | <div class="site-menu"> |
| 15d6dfaf | 760 | <nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>poolifier</span></a> |
| ec06e4dd | 761 | <ul class="tsd-small-nested-navigation"> |
| 15d6dfaf | 762 | <li><a href="AbstractPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Abstract<wbr/>Pool</span></a></li> |
| 763 | <li><a href="AbstractWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Abstract<wbr/>Worker</span></a></li> | |
| 764 | <li><a href="CircularArray.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Circular<wbr/>Array</span></a></li> | |
| 765 | <li><a href="ClusterWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cluster<wbr/>Worker</span></a></li> | |
| 766 | <li><a href="DynamicClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Cluster<wbr/>Pool</span></a></li> | |
| 767 | <li><a href="DynamicThreadPool.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Dynamic<wbr/>Thread<wbr/>Pool</span></a></li> | |
| 768 | <li><a href="FixedClusterPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a></li> | |
| 769 | <li><a href="FixedThreadPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Fixed<wbr/>Thread<wbr/>Pool</span></a></li> | |
| 770 | <li><a href="PoolEmitter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Pool<wbr/>Emitter</span></a></li> | |
| 771 | <li><a href="Queue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Queue</span></a></li> | |
| 772 | <li><a href="ThreadWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Thread<wbr/>Worker</span></a></li> | |
| 773 | <li><a href="WorkerChoiceStrategyContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a></li> | |
| 774 | <li><a href="../interfaces/ClusterPoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cluster<wbr/>Pool<wbr/>Options</span></a></li> | |
| 775 | <li><a href="../interfaces/IPool.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPool</span></a></li> | |
| 776 | <li><a href="../interfaces/IWorker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker</span></a></li> | |
| 777 | <li><a href="../interfaces/IWorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IWorker<wbr/>Choice<wbr/>Strategy</span></a></li> | |
| 778 | <li><a href="../interfaces/MessageValue.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Message<wbr/>Value</span></a></li> | |
| 779 | <li><a href="../interfaces/PoolInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Info</span></a></li> | |
| 780 | <li><a href="../interfaces/PoolOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Pool<wbr/>Options</span></a></li> | |
| 781 | <li><a href="../interfaces/PromiseResponseWrapper.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Promise<wbr/>Response<wbr/>Wrapper</span></a></li> | |
| 782 | <li><a href="../interfaces/RequiredStatistics.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Required<wbr/>Statistics</span></a></li> | |
| 783 | <li><a href="../interfaces/Task.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Task</span></a></li> | |
| 784 | <li><a href="../interfaces/TasksQueueOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Queue<wbr/>Options</span></a></li> | |
| 785 | <li><a href="../interfaces/TasksUsage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Tasks<wbr/>Usage</span></a></li> | |
| 786 | <li><a href="../interfaces/WorkerChoiceStrategyOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy<wbr/>Options</span></a></li> | |
| 787 | <li><a href="../interfaces/WorkerNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Node</span></a></li> | |
| 788 | <li><a href="../interfaces/WorkerOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worker<wbr/>Options</span></a></li> | |
| 789 | <li><a href="../types/Draft.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Draft</span></a></li> | |
| 790 | <li><a href="../types/ErrorHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Error<wbr/>Handler</span></a></li> | |
| 791 | <li><a href="../types/ExitHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Exit<wbr/>Handler</span></a></li> | |
| 792 | <li><a href="../types/KillBehavior.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Kill<wbr/>Behavior</span></a></li> | |
| 793 | <li><a href="../types/MessageHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Message<wbr/>Handler</span></a></li> | |
| 794 | <li><a href="../types/OnlineHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Online<wbr/>Handler</span></a></li> | |
| 795 | <li><a href="../types/PoolEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Event</span></a></li> | |
| 796 | <li><a href="../types/PoolType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Pool<wbr/>Type</span></a></li> | |
| 797 | <li><a href="../types/TaskFunctions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Task<wbr/>Functions</span></a></li> | |
| 798 | <li><a href="../types/ThreadWorkerWithMessageChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Thread<wbr/>Worker<wbr/>With<wbr/>Message<wbr/>Channel</span></a></li> | |
| 799 | <li><a href="../types/WorkerAsyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Async<wbr/>Function</span></a></li> | |
| 800 | <li><a href="../types/WorkerChoiceStrategy.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategy</span></a></li> | |
| 801 | <li><a href="../types/WorkerFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Function</span></a></li> | |
| 802 | <li><a href="../types/WorkerSyncFunction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Sync<wbr/>Function</span></a></li> | |
| 803 | <li><a href="../types/WorkerType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worker<wbr/>Type</span></a></li> | |
| 804 | <li><a href="../variables/KillBehaviors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g></svg><span>Kill<wbr/>Behaviors</span></a></li> | |
| 805 | <li><a href="../variables/PoolEvents.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Events</span></a></li> | |
| 806 | <li><a href="../variables/PoolTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Pool<wbr/>Types</span></a></li> | |
| 807 | <li><a href="../variables/WorkerChoiceStrategies.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Choice<wbr/>Strategies</span></a></li> | |
| 808 | <li><a href="../variables/WorkerTypes.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-32"></use></svg><span>Worker<wbr/>Types</span></a></li></ul></nav></div></div></div> | |
| ec06e4dd | 809 | <div class="tsd-generator"> |
| a76fac14 | 810 | <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> |
| ec06e4dd | 811 | <div class="overlay"></div></body></html> |