| 1 | <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FixedClusterPool | 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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> |
| 2 | <div class="tsd-toolbar-contents container"> |
| 3 | <div class="table-cell" id="tsd-search" data-base=".."> |
| 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> |
| 7 | <ul class="results"> |
| 8 | <li class="state loading">Preparing search index...</li> |
| 9 | <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">poolifier</a></div> |
| 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> |
| 11 | <div class="container container-main"> |
| 12 | <div class="col-8 col-content"> |
| 13 | <div class="tsd-page-title"> |
| 14 | <ul class="tsd-breadcrumb"> |
| 15 | <li><a href="../index.html">poolifier</a></li> |
| 16 | <li><a href="FixedClusterPool.html">FixedClusterPool</a></li></ul> |
| 17 | <h1>Class FixedClusterPool<Data, Response></h1></div> |
| 18 | <section class="tsd-panel tsd-comment"> |
| 19 | <div class="tsd-comment tsd-typography"><p>A cluster pool with a fixed number of workers.</p> |
| 20 | <p>It is possible to perform tasks in sync or asynchronous mode as you prefer.</p> |
| 21 | <p>This pool selects the workers in a round robin fashion.</p> |
| 22 | |
| 23 | <h3>Author</h3><p><a href="https://github.com/Shinigami92">Christopher Quadflieg</a></p> |
| 24 | |
| 25 | <h3>Since</h3><p>2.0.0</p> |
| 26 | </div></section> |
| 27 | <section class="tsd-panel tsd-type-parameters"> |
| 28 | <h4>Type Parameters</h4> |
| 29 | <ul class="tsd-type-parameters"> |
| 30 | <li> |
| 31 | <h4>Data = <span class="tsd-signature-type">unknown</span></h4> |
| 32 | <div class="tsd-comment tsd-typography"><p>Type of data sent to the worker. This can only be serializable data.</p> |
| 33 | </div></li> |
| 34 | <li> |
| 35 | <h4>Response = <span class="tsd-signature-type">unknown</span></h4> |
| 36 | <div class="tsd-comment tsd-typography"><p>Type of response of execution. This can only be serializable data.</p> |
| 37 | </div></li></ul></section> |
| 38 | <section class="tsd-panel tsd-hierarchy"> |
| 39 | <h4>Hierarchy</h4> |
| 40 | <ul class="tsd-hierarchy"> |
| 41 | <li><span class="tsd-signature-type">AbstractPool</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" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">></span> |
| 42 | <ul class="tsd-hierarchy"> |
| 43 | <li><span class="target">FixedClusterPool</span> |
| 44 | <ul class="tsd-hierarchy"> |
| 45 | <li><a href="DynamicClusterPool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicClusterPool</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"> |
| 46 | <ul> |
| 47 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L39">src/pools/cluster/fixed.ts:39</a></li></ul></aside> |
| 48 | <section class="tsd-panel-group tsd-index-group"> |
| 49 | <section class="tsd-panel tsd-index-panel"> |
| 50 | <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> |
| 51 | <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> |
| 52 | <div class="tsd-accordion-details"> |
| 53 | <section class="tsd-index-section"> |
| 54 | <h3 class="tsd-index-heading">Constructors</h3> |
| 55 | <div class="tsd-index-list"><a href="FixedClusterPool.html#constructor" class="tsd-index-link tsd-kind-constructor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></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)" id="icon-512-text"></path></svg><span>constructor</span></a> |
| 56 | </div></section> |
| 57 | <section class="tsd-index-section"> |
| 58 | <h3 class="tsd-index-heading">Properties</h3> |
| 59 | <div class="tsd-index-list"><a href="FixedClusterPool.html#emitter" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></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)" id="icon-1024-text"></path></svg><span>emitter?</span></a> |
| 60 | <a href="FixedClusterPool.html#filePath" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>file<wbr/>Path</span></a> |
| 61 | <a href="FixedClusterPool.html#numberOfWorkers" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>number<wbr/>Of<wbr/>Workers</span></a> |
| 62 | <a href="FixedClusterPool.html#opts" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>opts</span></a> |
| 63 | <a href="FixedClusterPool.html#promiseResponseMap" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>promise<wbr/>Response<wbr/>Map</span></a> |
| 64 | <a href="FixedClusterPool.html#workerChoiceStrategyContext" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</span></a> |
| 65 | <a href="FixedClusterPool.html#workers" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>workers</span></a> |
| 66 | </div></section> |
| 67 | <section class="tsd-index-section"> |
| 68 | <h3 class="tsd-index-heading">Accessors</h3> |
| 69 | <div class="tsd-index-list"><a href="FixedClusterPool.html#busy" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-262144-path"></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)" id="icon-262144-text"></path></svg><span>busy</span></a> |
| 70 | <a href="FixedClusterPool.html#full" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>full</span></a> |
| 71 | <a href="FixedClusterPool.html#numberOfRunningTasks" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class tsd-is-private tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>number<wbr/>Of<wbr/>Running<wbr/>Tasks</span></a> |
| 72 | <a href="FixedClusterPool.html#type" class="tsd-index-link tsd-kind-accessor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg><span>type</span></a> |
| 73 | </div></section> |
| 74 | <section class="tsd-index-section"> |
| 75 | <h3 class="tsd-index-heading">Methods</h3> |
| 76 | <div class="tsd-index-list"><a href="FixedClusterPool.html#afterPromiseResponseHook" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></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)" id="icon-2048-text"></path></svg><span>after<wbr/>Promise<wbr/>Response<wbr/>Hook</span></a> |
| 77 | <a href="FixedClusterPool.html#afterWorkerSetup" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>after<wbr/>Worker<wbr/>Setup</span></a> |
| 78 | <a href="FixedClusterPool.html#beforePromiseResponseHook" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>before<wbr/>Promise<wbr/>Response<wbr/>Hook</span></a> |
| 79 | <a href="FixedClusterPool.html#chooseWorker" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>choose<wbr/>Worker</span></a> |
| 80 | <a href="FixedClusterPool.html#createAndSetupWorker" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>And<wbr/>Setup<wbr/>Worker</span></a> |
| 81 | <a href="FixedClusterPool.html#createWorker" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Worker</span></a> |
| 82 | <a href="FixedClusterPool.html#destroy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>destroy</span></a> |
| 83 | <a href="FixedClusterPool.html#destroyWorker" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>destroy<wbr/>Worker</span></a> |
| 84 | <a href="FixedClusterPool.html#execute" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>execute</span></a> |
| 85 | <a href="FixedClusterPool.html#findFreeWorkerKey" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>find<wbr/>Free<wbr/>Worker<wbr/>Key</span></a> |
| 86 | <a href="FixedClusterPool.html#internalBusy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>internal<wbr/>Busy</span></a> |
| 87 | <a href="FixedClusterPool.html#isMain" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Main</span></a> |
| 88 | <a href="FixedClusterPool.html#registerWorkerMessageListener" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span></a> |
| 89 | <a href="FixedClusterPool.html#removeWorker" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>Worker</span></a> |
| 90 | <a href="FixedClusterPool.html#sendToWorker" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>send<wbr/>To<wbr/>Worker</span></a> |
| 91 | <a href="FixedClusterPool.html#setWorkerChoiceStrategy" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</span></a> |
| 92 | <a href="FixedClusterPool.html#setupHook" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>setup<wbr/>Hook</span></a> |
| 93 | <a href="FixedClusterPool.html#workerListener" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>worker<wbr/>Listener</span></a> |
| 94 | </div></section></div></details></section></section> |
| 95 | <section class="tsd-panel-group tsd-member-group"> |
| 96 | <h2>Constructors</h2> |
| 97 | <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a> |
| 98 | <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3> |
| 99 | <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> |
| 100 | <li class="tsd-signature tsd-anchor-link" id="constructor.new_FixedClusterPool">new <wbr/>Fixed<wbr/>Cluster<wbr/>Pool<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>numberOfWorkers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, opts<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ClusterPoolOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FixedClusterPool.html" class="tsd-signature-type" data-tsd-kind="Class">FixedClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">></span><a href="#constructor.new_FixedClusterPool" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 101 | <li class="tsd-description"> |
| 102 | <div class="tsd-comment tsd-typography"><p>Constructs a new poolifier fixed cluster pool.</p> |
| 103 | </div> |
| 104 | <section class="tsd-panel tsd-type-parameters"> |
| 105 | <h4>Type Parameters</h4> |
| 106 | <ul class="tsd-type-parameters"> |
| 107 | <li> |
| 108 | <h4>Data = <span class="tsd-signature-type">unknown</span></h4></li> |
| 109 | <li> |
| 110 | <h4>Response = <span class="tsd-signature-type">unknown</span></h4></li></ul></section> |
| 111 | <div class="tsd-parameters"> |
| 112 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 113 | <ul class="tsd-parameter-list"> |
| 114 | <li> |
| 115 | <h5>numberOfWorkers: <span class="tsd-signature-type">number</span></h5> |
| 116 | <div class="tsd-comment tsd-typography"><p>Number of workers for this pool.</p> |
| 117 | </div></li> |
| 118 | <li> |
| 119 | <h5>filePath: <span class="tsd-signature-type">string</span></h5> |
| 120 | <div class="tsd-comment tsd-typography"><p>Path to an implementation of a <code>ClusterWorker</code> file, which can be relative or absolute.</p> |
| 121 | </div></li> |
| 122 | <li> |
| 123 | <h5>opts: <a href="../interfaces/ClusterPoolOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></h5> |
| 124 | <div class="tsd-comment tsd-typography"><p>Options for this fixed cluster pool.</p> |
| 125 | </div></li></ul></div> |
| 126 | <h4 class="tsd-returns-title">Returns <a href="FixedClusterPool.html" class="tsd-signature-type" data-tsd-kind="Class">FixedClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"> |
| 127 | <p>Overrides AbstractPool<Worker, Data, Response>.constructor</p> |
| 128 | <ul> |
| 129 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L50">src/pools/cluster/fixed.ts:50</a></li></ul></aside></li></ul></section></section> |
| 130 | <section class="tsd-panel-group tsd-member-group"> |
| 131 | <h2>Properties</h2> |
| 132 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="emitter" class="tsd-anchor"></a> |
| 133 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 134 | <div class="tsd-signature">emitter<span class="tsd-signature-symbol">?:</span> <a href="PoolEmitter.html" class="tsd-signature-type" data-tsd-kind="Class">PoolEmitter</a></div> |
| 135 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 136 | </div><aside class="tsd-sources"> |
| 137 | <p>Inherited from AbstractPool.emitter</p> |
| 138 | <ul> |
| 139 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L32">src/pools/abstract-pool.ts:32</a></li></ul></aside></section> |
| 140 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="filePath" class="tsd-anchor"></a> |
| 141 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>file<wbr/>Path</span><a href="#filePath" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 142 | <div class="tsd-signature">file<wbr/>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> |
| 143 | <div class="tsd-comment tsd-typography"><p>Path to the worker-file.</p> |
| 144 | </div><aside class="tsd-sources"> |
| 145 | <p>Inherited from AbstractPool.filePath</p> |
| 146 | <ul> |
| 147 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L67">src/pools/abstract-pool.ts:67</a></li></ul></aside></section> |
| 148 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="numberOfWorkers" class="tsd-anchor"></a> |
| 149 | <h3 class="tsd-anchor-link"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 150 | <div class="tsd-signature">number<wbr/>Of<wbr/>Workers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> |
| 151 | <div class="tsd-comment tsd-typography"><p>Number of workers that this pool should manage.</p> |
| 152 | </div><aside class="tsd-sources"> |
| 153 | <p>Inherited from AbstractPool.numberOfWorkers</p> |
| 154 | <ul> |
| 155 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L66">src/pools/abstract-pool.ts:66</a></li></ul></aside></section> |
| 156 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="opts" class="tsd-anchor"></a> |
| 157 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 158 | <div class="tsd-signature">opts<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ClusterPoolOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = {}</span></div> |
| 159 | <div class="tsd-comment tsd-typography"><p>Options for this fixed cluster pool.</p> |
| 160 | </div><aside class="tsd-sources"> |
| 161 | <p>Inherited from AbstractPool.opts</p> |
| 162 | <ul> |
| 163 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L53">src/pools/cluster/fixed.ts:53</a></li></ul></aside></section> |
| 164 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="promiseResponseMap" class="tsd-anchor"></a> |
| 165 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 166 | <div class="tsd-signature">promise<wbr/>Response<wbr/>Map<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><span class="tsd-signature-type">PromiseResponseWrapper</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" data-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> |
| 167 | <div class="tsd-comment tsd-typography"><p>The promise response map.</p> |
| 168 | <ul> |
| 169 | <li><code>key</code>: The message id of each submitted task.</li> |
| 170 | <li><code>value</code>: An object that contains the worker, the promise resolve and reject callbacks.</li> |
| 171 | </ul> |
| 172 | <p>When we receive a message from the worker we get a map entry with the promise resolve/reject bound to the message.</p> |
| 173 | </div><aside class="tsd-sources"> |
| 174 | <p>Inherited from AbstractPool.promiseResponseMap</p> |
| 175 | <ul> |
| 176 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L42">src/pools/abstract-pool.ts:42</a></li></ul></aside></section> |
| 177 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="workerChoiceStrategyContext" class="tsd-anchor"></a> |
| 178 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 179 | <div class="tsd-signature">worker<wbr/>Choice<wbr/>Strategy<wbr/>Context<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WorkerChoiceStrategyContext</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" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">></span></div> |
| 180 | <div class="tsd-comment tsd-typography"><p>Worker choice strategy instance implementing the worker choice algorithm.</p> |
| 181 | <p>Default to a strategy implementing a round robin algorithm.</p> |
| 182 | </div><aside class="tsd-sources"> |
| 183 | <p>Inherited from AbstractPool.workerChoiceStrategyContext</p> |
| 184 | <ul> |
| 185 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L52">src/pools/abstract-pool.ts:52</a></li></ul></aside></section> |
| 186 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="workers" class="tsd-anchor"></a> |
| 187 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>workers</span><a href="#workers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 188 | <div class="tsd-signature">workers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WorkerType</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div> |
| 189 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 190 | </div><aside class="tsd-sources"> |
| 191 | <p>Inherited from AbstractPool.workers</p> |
| 192 | <ul> |
| 193 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L29">src/pools/abstract-pool.ts:29</a></li></ul></aside></section></section> |
| 194 | <section class="tsd-panel-group tsd-member-group"> |
| 195 | <h2>Accessors</h2> |
| 196 | <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="busy" class="tsd-anchor"></a> |
| 197 | <h3 class="tsd-anchor-link"><span>busy</span><a href="#busy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 198 | <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> |
| 199 | <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> |
| 200 | <li class="tsd-description"> |
| 201 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 202 | </div> |
| 203 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> |
| 204 | <p>Overrides AbstractPool.busy</p> |
| 205 | <ul> |
| 206 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L109">src/pools/cluster/fixed.ts:109</a></li></ul></aside></li></ul></section> |
| 207 | <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="full" class="tsd-anchor"></a> |
| 208 | <h3 class="tsd-anchor-link"><span>full</span><a href="#full" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 209 | <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> |
| 210 | <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> |
| 211 | <li class="tsd-description"> |
| 212 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 213 | </div> |
| 214 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> |
| 215 | <p>Overrides AbstractPool.full</p> |
| 216 | <ul> |
| 217 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L104">src/pools/cluster/fixed.ts:104</a></li></ul></aside></li></ul></section> |
| 218 | <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-private tsd-is-inherited"><a id="numberOfRunningTasks" class="tsd-anchor"></a> |
| 219 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>number<wbr/>Of<wbr/>Running<wbr/>Tasks</span><a href="#numberOfRunningTasks" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 220 | <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-private tsd-is-inherited"> |
| 221 | <li class="tsd-signature" id="numberOfRunningTasks.numberOfRunningTasks-1"><span class="tsd-signature-symbol">get</span> numberOfRunningTasks<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> |
| 222 | <li class="tsd-description"> |
| 223 | <div class="tsd-comment tsd-typography"><p>Number of tasks concurrently running.</p> |
| 224 | </div> |
| 225 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"> |
| 226 | <p>Inherited from AbstractPool.numberOfRunningTasks</p> |
| 227 | <ul> |
| 228 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L149">src/pools/abstract-pool.ts:149</a></li></ul></aside></li></ul></section> |
| 229 | <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a> |
| 230 | <h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 231 | <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class"> |
| 232 | <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">PoolType</span></li> |
| 233 | <li class="tsd-description"> |
| 234 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 235 | </div> |
| 236 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PoolType</span></h4><aside class="tsd-sources"> |
| 237 | <p>Overrides AbstractPool.type</p> |
| 238 | <ul> |
| 239 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L99">src/pools/cluster/fixed.ts:99</a></li></ul></aside></li></ul></section></section> |
| 240 | <section class="tsd-panel-group tsd-member-group"> |
| 241 | <h2>Methods</h2> |
| 242 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="afterPromiseResponseHook" class="tsd-anchor"></a> |
| 243 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>after<wbr/>Promise<wbr/>Response<wbr/>Hook</span><a href="#afterPromiseResponseHook" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 244 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 245 | <li class="tsd-signature tsd-anchor-link" id="afterPromiseResponseHook.afterPromiseResponseHook-1">after<wbr/>Promise<wbr/>Response<wbr/>Hook<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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="#afterPromiseResponseHook.afterPromiseResponseHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 246 | <li class="tsd-description"> |
| 247 | <div class="tsd-comment tsd-typography"><p>Hook executed after the worker task promise resolution. |
| 248 | Can be overridden.</p> |
| 249 | </div> |
| 250 | <div class="tsd-parameters"> |
| 251 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 252 | <ul class="tsd-parameter-list"> |
| 253 | <li> |
| 254 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> |
| 255 | <div class="tsd-comment tsd-typography"><p>The worker.</p> |
| 256 | </div></li> |
| 257 | <li> |
| 258 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5> |
| 259 | <div class="tsd-comment tsd-typography"><p>The received message.</p> |
| 260 | </div></li></ul></div> |
| 261 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 262 | <p>Inherited from AbstractPool.afterPromiseResponseHook</p> |
| 263 | <ul> |
| 264 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L263">src/pools/abstract-pool.ts:263</a></li></ul></aside></li></ul></section> |
| 265 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="afterWorkerSetup" class="tsd-anchor"></a> |
| 266 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 267 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> |
| 268 | <li class="tsd-signature tsd-anchor-link" id="afterWorkerSetup.afterWorkerSetup-1">after<wbr/>Worker<wbr/>Setup<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 269 | <li class="tsd-description"> |
| 270 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 271 | </div> |
| 272 | <div class="tsd-parameters"> |
| 273 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 274 | <ul class="tsd-parameter-list"> |
| 275 | <li> |
| 276 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5></li></ul></div> |
| 277 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 278 | <p>Overrides AbstractPool.afterWorkerSetup</p> |
| 279 | <ul> |
| 280 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L93">src/pools/cluster/fixed.ts:93</a></li></ul></aside></li></ul></section> |
| 281 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="beforePromiseResponseHook" class="tsd-anchor"></a> |
| 282 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>before<wbr/>Promise<wbr/>Response<wbr/>Hook</span><a href="#beforePromiseResponseHook" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 283 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 284 | <li class="tsd-signature tsd-anchor-link" id="beforePromiseResponseHook.beforePromiseResponseHook-1">before<wbr/>Promise<wbr/>Response<wbr/>Hook<span class="tsd-signature-symbol">(</span>workerKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#beforePromiseResponseHook.beforePromiseResponseHook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 285 | <li class="tsd-description"> |
| 286 | <div class="tsd-comment tsd-typography"><p>Hook executed before the worker task promise resolution. |
| 287 | Can be overridden.</p> |
| 288 | </div> |
| 289 | <div class="tsd-parameters"> |
| 290 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 291 | <ul class="tsd-parameter-list"> |
| 292 | <li> |
| 293 | <h5>workerKey: <span class="tsd-signature-type">number</span></h5> |
| 294 | <div class="tsd-comment tsd-typography"><p>The worker key.</p> |
| 295 | </div></li></ul></div> |
| 296 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 297 | <p>Inherited from AbstractPool.beforePromiseResponseHook</p> |
| 298 | <ul> |
| 299 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L252">src/pools/abstract-pool.ts:252</a></li></ul></aside></li></ul></section> |
| 300 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="chooseWorker" class="tsd-anchor"></a> |
| 301 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>choose<wbr/>Worker</span><a href="#chooseWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 302 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 303 | <li class="tsd-signature tsd-anchor-link" id="chooseWorker.chooseWorker-1">choose<wbr/>Worker<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-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">]</span><a href="#chooseWorker.chooseWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 304 | <li class="tsd-description"> |
| 305 | <div class="tsd-comment tsd-typography"><p>Chooses a worker for the next task.</p> |
| 306 | <p>The default implementation uses a round robin algorithm to distribute the load.</p> |
| 307 | |
| 308 | <h3>Returns</h3><p>[worker key, worker].</p> |
| 309 | </div> |
| 310 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"> |
| 311 | <p>Inherited from AbstractPool.chooseWorker</p> |
| 312 | <ul> |
| 313 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L303">src/pools/abstract-pool.ts:303</a></li></ul></aside></li></ul></section> |
| 314 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="createAndSetupWorker" class="tsd-anchor"></a> |
| 315 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 316 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 317 | <li class="tsd-signature tsd-anchor-link" id="createAndSetupWorker.createAndSetupWorker-1">create<wbr/>And<wbr/>Setup<wbr/>Worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><a href="#createAndSetupWorker.createAndSetupWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 318 | <li class="tsd-description"> |
| 319 | <div class="tsd-comment tsd-typography"><p>Creates a new worker for this pool and sets it up completely.</p> |
| 320 | |
| 321 | <h3>Returns</h3><p>New, completely set up worker.</p> |
| 322 | </div> |
| 323 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4><aside class="tsd-sources"> |
| 324 | <p>Inherited from AbstractPool.createAndSetupWorker</p> |
| 325 | <ul> |
| 326 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L348">src/pools/abstract-pool.ts:348</a></li></ul></aside></li></ul></section> |
| 327 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="createWorker" class="tsd-anchor"></a> |
| 328 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 329 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> |
| 330 | <li class="tsd-signature tsd-anchor-link" id="createWorker.createWorker-1">create<wbr/>Worker<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><a href="#createWorker.createWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 331 | <li class="tsd-description"> |
| 332 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 333 | </div> |
| 334 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4><aside class="tsd-sources"> |
| 335 | <p>Overrides AbstractPool.createWorker</p> |
| 336 | <ul> |
| 337 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L88">src/pools/cluster/fixed.ts:88</a></li></ul></aside></li></ul></section> |
| 338 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="destroy" class="tsd-anchor"></a> |
| 339 | <h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 340 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> |
| 341 | <li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1">destroy<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 342 | <li class="tsd-description"> |
| 343 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 344 | </div> |
| 345 | <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><aside class="tsd-sources"> |
| 346 | <p>Inherited from AbstractPool.destroy</p> |
| 347 | <ul> |
| 348 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L218">src/pools/abstract-pool.ts:218</a></li></ul></aside></li></ul></section> |
| 349 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="destroyWorker" class="tsd-anchor"></a> |
| 350 | <h3 class="tsd-anchor-link"><span>destroy<wbr/>Worker</span><a href="#destroyWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 351 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| 352 | <li class="tsd-signature tsd-anchor-link" id="destroyWorker.destroyWorker-1">destroy<wbr/>Worker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#destroyWorker.destroyWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 353 | <li class="tsd-description"> |
| 354 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 355 | </div> |
| 356 | <div class="tsd-parameters"> |
| 357 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 358 | <ul class="tsd-parameter-list"> |
| 359 | <li> |
| 360 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5></li></ul></div> |
| 361 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 362 | <p>Overrides AbstractPool.destroyWorker</p> |
| 363 | <ul> |
| 364 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L69">src/pools/cluster/fixed.ts:69</a></li></ul></aside></li></ul></section> |
| 365 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="execute" class="tsd-anchor"></a> |
| 366 | <h3 class="tsd-anchor-link"><span>execute</span><a href="#execute" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 367 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> |
| 368 | <li class="tsd-signature tsd-anchor-link" id="execute.execute-1">execute<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</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" data-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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 369 | <li class="tsd-description"> |
| 370 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 371 | </div> |
| 372 | <div class="tsd-parameters"> |
| 373 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 374 | <ul class="tsd-parameter-list"> |
| 375 | <li> |
| 376 | <h5>data: <span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span></h5></li></ul></div> |
| 377 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"> |
| 378 | <p>Inherited from AbstractPool.execute</p> |
| 379 | <ul> |
| 380 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L203">src/pools/abstract-pool.ts:203</a></li></ul></aside></li></ul></section> |
| 381 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="findFreeWorkerKey" class="tsd-anchor"></a> |
| 382 | <h3 class="tsd-anchor-link"><span>find<wbr/>Free<wbr/>Worker<wbr/>Key</span><a href="#findFreeWorkerKey" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 383 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> |
| 384 | <li class="tsd-signature tsd-anchor-link" id="findFreeWorkerKey.findFreeWorkerKey-1">find<wbr/>Free<wbr/>Worker<wbr/>Key<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="#findFreeWorkerKey.findFreeWorkerKey-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 385 | <li class="tsd-description"> |
| 386 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 387 | </div> |
| 388 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"> |
| 389 | <p>Inherited from AbstractPool.findFreeWorkerKey</p> |
| 390 | <ul> |
| 391 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L196">src/pools/abstract-pool.ts:196</a></li></ul></aside></li></ul></section> |
| 392 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="internalBusy" class="tsd-anchor"></a> |
| 393 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 394 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 395 | <li class="tsd-signature tsd-anchor-link" id="internalBusy.internalBusy-1">internal<wbr/>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><a href="#internalBusy.internalBusy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 396 | <li class="tsd-description"> |
| 397 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> |
| 398 | <p>Inherited from AbstractPool.internalBusy</p> |
| 399 | <ul> |
| 400 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L188">src/pools/abstract-pool.ts:188</a></li></ul></aside></li></ul></section> |
| 401 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="isMain" class="tsd-anchor"></a> |
| 402 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 403 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> |
| 404 | <li class="tsd-signature tsd-anchor-link" id="isMain.isMain-1">is<wbr/>Main<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 405 | <li class="tsd-description"> |
| 406 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 407 | </div> |
| 408 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"> |
| 409 | <p>Overrides AbstractPool.isMain</p> |
| 410 | <ul> |
| 411 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L64">src/pools/cluster/fixed.ts:64</a></li></ul></aside></li></ul></section> |
| 412 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="registerWorkerMessageListener" class="tsd-anchor"></a> |
| 413 | <h3 class="tsd-anchor-link"><span>register<wbr/>Worker<wbr/>Message<wbr/>Listener</span><a href="#registerWorkerMessageListener" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 414 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| 415 | <li class="tsd-signature tsd-anchor-link" id="registerWorkerMessageListener.registerWorkerMessageListener-1">register<wbr/>Worker<wbr/>Message<wbr/>Listener<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Message</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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><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="#registerWorkerMessageListener.registerWorkerMessageListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 416 | <li class="tsd-description"> |
| 417 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 418 | </div> |
| 419 | <section class="tsd-panel tsd-type-parameters"> |
| 420 | <h4>Type Parameters</h4> |
| 421 | <ul class="tsd-type-parameters"> |
| 422 | <li> |
| 423 | <h4>Message</h4></li></ul></section> |
| 424 | <div class="tsd-parameters"> |
| 425 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 426 | <ul class="tsd-parameter-list"> |
| 427 | <li> |
| 428 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5></li> |
| 429 | <li> |
| 430 | <h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol">)</span></h5> |
| 431 | <ul class="tsd-parameters"> |
| 432 | <li class="tsd-parameter-signature"> |
| 433 | <ul class="tsd-signatures tsd-kind-type-literal"> |
| 434 | <li class="tsd-signature"><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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></li> |
| 435 | <li class="tsd-description"> |
| 436 | <div class="tsd-parameters"> |
| 437 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 438 | <ul class="tsd-parameter-list"> |
| 439 | <li> |
| 440 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div> |
| 441 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div> |
| 442 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 443 | <p>Overrides AbstractPool.registerWorkerMessageListener</p> |
| 444 | <ul> |
| 445 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L80">src/pools/cluster/fixed.ts:80</a></li></ul></aside></li></ul></section> |
| 446 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="removeWorker" class="tsd-anchor"></a> |
| 447 | <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>remove<wbr/>Worker</span><a href="#removeWorker" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 448 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 449 | <li class="tsd-signature tsd-anchor-link" id="removeWorker.removeWorker-1">remove<wbr/>Worker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeWorker.removeWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 450 | <li class="tsd-description"> |
| 451 | <div class="tsd-comment tsd-typography"><p>Removes the given worker from the pool.</p> |
| 452 | </div> |
| 453 | <div class="tsd-parameters"> |
| 454 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 455 | <ul class="tsd-parameter-list"> |
| 456 | <li> |
| 457 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> |
| 458 | <div class="tsd-comment tsd-typography"><p>The worker that will be removed.</p> |
| 459 | </div></li></ul></div> |
| 460 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 461 | <p>Inherited from AbstractPool.removeWorker</p> |
| 462 | <ul> |
| 463 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L290">src/pools/abstract-pool.ts:290</a></li></ul></aside></li></ul></section> |
| 464 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="sendToWorker" class="tsd-anchor"></a> |
| 465 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 466 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> |
| 467 | <li class="tsd-signature tsd-anchor-link" id="sendToWorker.sendToWorker-1">send<wbr/>To<wbr/>Worker<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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="#sendToWorker.sendToWorker-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 468 | <li class="tsd-description"> |
| 469 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 470 | </div> |
| 471 | <div class="tsd-parameters"> |
| 472 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 473 | <ul class="tsd-parameter-list"> |
| 474 | <li> |
| 475 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5></li> |
| 476 | <li> |
| 477 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div> |
| 478 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 479 | <p>Overrides AbstractPool.sendToWorker</p> |
| 480 | <ul> |
| 481 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L75">src/pools/cluster/fixed.ts:75</a></li></ul></aside></li></ul></section> |
| 482 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a id="setWorkerChoiceStrategy" class="tsd-anchor"></a> |
| 483 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 484 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> |
| 485 | <li class="tsd-signature tsd-anchor-link" id="setWorkerChoiceStrategy.setWorkerChoiceStrategy-1">set<wbr/>Worker<wbr/>Choice<wbr/>Strategy<span class="tsd-signature-symbol">(</span>workerChoiceStrategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_USED"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_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-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setWorkerChoiceStrategy.setWorkerChoiceStrategy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 486 | <li class="tsd-description"> |
| 487 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 488 | </div> |
| 489 | <div class="tsd-parameters"> |
| 490 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 491 | <ul class="tsd-parameter-list"> |
| 492 | <li> |
| 493 | <h5>workerChoiceStrategy: <span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_USED"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_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></h5></li></ul></div> |
| 494 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 495 | <p>Inherited from AbstractPool.setWorkerChoiceStrategy</p> |
| 496 | <ul> |
| 497 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L164">src/pools/abstract-pool.ts:164</a></li></ul></aside></li></ul></section> |
| 498 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="setupHook" class="tsd-anchor"></a> |
| 499 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 500 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> |
| 501 | <li class="tsd-signature tsd-anchor-link" id="setupHook.setupHook-1">setup<wbr/>Hook<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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 502 | <li class="tsd-description"> |
| 503 | <div class="tsd-comment tsd-typography"><p>{@inheritDoc}</p> |
| 504 | </div> |
| 505 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"> |
| 506 | <p>Overrides AbstractPool.setupHook</p> |
| 507 | <ul> |
| 508 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/cluster/fixed.ts#L59">src/pools/cluster/fixed.ts:59</a></li></ul></aside></li></ul></section> |
| 509 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a id="workerListener" class="tsd-anchor"></a> |
| 510 | <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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> |
| 511 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"> |
| 512 | <li class="tsd-signature tsd-anchor-link" id="workerListener.workerListener-1">worker<wbr/>Listener<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>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol">)</span><a href="#workerListener.workerListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li> |
| 513 | <li class="tsd-description"> |
| 514 | <div class="tsd-comment tsd-typography"><p>This function is the listener registered for each worker.</p> |
| 515 | |
| 516 | <h3>Returns</h3><p>The listener function to execute when a message is received from a worker.</p> |
| 517 | </div> |
| 518 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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><span class="tsd-signature-symbol">)</span></h4> |
| 519 | <ul class="tsd-parameters"> |
| 520 | <li class="tsd-parameter-signature"> |
| 521 | <ul class="tsd-signatures tsd-kind-type-literal"> |
| 522 | <li class="tsd-signature" id="workerListener.workerListener-1.__type.__type-1"><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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></li> |
| 523 | <li class="tsd-description"> |
| 524 | <div class="tsd-comment tsd-typography"><p>This function is the listener registered for each worker.</p> |
| 525 | |
| 526 | <h3>Returns</h3><p>The listener function to execute when a message is received from a worker.</p> |
| 527 | </div> |
| 528 | <div class="tsd-parameters"> |
| 529 | <h4 class="tsd-parameters-title">Parameters</h4> |
| 530 | <ul class="tsd-parameter-list"> |
| 531 | <li> |
| 532 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5></li></ul></div> |
| 533 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><aside class="tsd-sources"> |
| 534 | <p>Inherited from AbstractPool.workerListener</p> |
| 535 | <ul> |
| 536 | <li>Defined in <a href="https://github.com/poolifier/poolifier/blob/c2ade47/src/pools/abstract-pool.ts#L377">src/pools/abstract-pool.ts:377</a></li></ul></aside></li></ul></section></section></div> |
| 537 | <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> |
| 538 | <div class="tsd-navigation settings"> |
| 539 | <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> |
| 540 | <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)"></path></svg> Settings</h3></summary> |
| 541 | <div class="tsd-accordion-details"> |
| 542 | <div class="tsd-filter-visibility"> |
| 543 | <h4 class="uppercase">Member Visibility</h4><form> |
| 544 | <ul id="tsd-filter-options"> |
| 545 | <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> |
| 546 | <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> |
| 547 | <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> |
| 548 | <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> |
| 549 | <div class="tsd-theme-toggle"> |
| 550 | <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> |
| 551 | <nav class="tsd-navigation primary"> |
| 552 | <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> |
| 553 | <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)"></path></svg> Modules</h3></summary> |
| 554 | <div class="tsd-accordion-details"> |
| 555 | <ul> |
| 556 | <li><a href="../index.html">poolifier</a> |
| 557 | <ul></ul></li></ul></div></details></nav> |
| 558 | <nav class="tsd-navigation secondary menu-sticky"> |
| 559 | <ul> |
| 560 | <li class="current tsd-kind-class"><a href="FixedClusterPool.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><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" id="icon-128-path"></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)" id="icon-128-text"></path></svg><span>Fixed<wbr/>Cluster<wbr/>Pool</span></a> |
| 561 | <ul> |
| 562 | <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="FixedClusterPool.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li> |
| 563 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#emitter" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>emitter?</a></li> |
| 564 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#filePath" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>file<wbr/>Path</a></li> |
| 565 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#numberOfWorkers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>number<wbr/>Of<wbr/>Workers</a></li> |
| 566 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#opts" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>opts</a></li> |
| 567 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#promiseResponseMap" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>promise<wbr/>Response<wbr/>Map</a></li> |
| 568 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#workerChoiceStrategyContext" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>worker<wbr/>Choice<wbr/>Strategy<wbr/>Context</a></li> |
| 569 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#workers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>workers</a></li> |
| 570 | <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="FixedClusterPool.html#busy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>busy</a></li> |
| 571 | <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="FixedClusterPool.html#full" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>full</a></li> |
| 572 | <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private tsd-is-inherited"><a href="FixedClusterPool.html#numberOfRunningTasks" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>number<wbr/>Of<wbr/>Running<wbr/>Tasks</a></li> |
| 573 | <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="FixedClusterPool.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-262144-path"></use><use href="#icon-262144-text"></use></svg>type</a></li> |
| 574 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#afterPromiseResponseHook" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>after<wbr/>Promise<wbr/>Response<wbr/>Hook</a></li> |
| 575 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="FixedClusterPool.html#afterWorkerSetup" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>after<wbr/>Worker<wbr/>Setup</a></li> |
| 576 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#beforePromiseResponseHook" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>before<wbr/>Promise<wbr/>Response<wbr/>Hook</a></li> |
| 577 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#chooseWorker" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>choose<wbr/>Worker</a></li> |
| 578 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#createAndSetupWorker" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>And<wbr/>Setup<wbr/>Worker</a></li> |
| 579 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="FixedClusterPool.html#createWorker" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Worker</a></li> |
| 580 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>destroy</a></li> |
| 581 | <li class="tsd-kind-method tsd-parent-kind-class"><a href="FixedClusterPool.html#destroyWorker" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>destroy<wbr/>Worker</a></li> |
| 582 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#execute" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>execute</a></li> |
| 583 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#findFreeWorkerKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>find<wbr/>Free<wbr/>Worker<wbr/>Key</a></li> |
| 584 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#internalBusy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>internal<wbr/>Busy</a></li> |
| 585 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="FixedClusterPool.html#isMain" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Main</a></li> |
| 586 | <li class="tsd-kind-method tsd-parent-kind-class"><a href="FixedClusterPool.html#registerWorkerMessageListener" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>register<wbr/>Worker<wbr/>Message<wbr/>Listener</a></li> |
| 587 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#removeWorker" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>Worker</a></li> |
| 588 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="FixedClusterPool.html#sendToWorker" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>send<wbr/>To<wbr/>Worker</a></li> |
| 589 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="FixedClusterPool.html#setWorkerChoiceStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Worker<wbr/>Choice<wbr/>Strategy</a></li> |
| 590 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="FixedClusterPool.html#setupHook" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>setup<wbr/>Hook</a></li> |
| 591 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited"><a href="FixedClusterPool.html#workerListener" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>worker<wbr/>Listener</a></li></ul></li></ul></nav></div></div> |
| 592 | <div class="container tsd-generator"> |
| 593 | <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> |
| 594 | <div class="overlay"></div><script src="../assets/main.js"></script></body></html> |