Commit | Line | Data |
---|---|---|
5ea22628 JB |
1 | <!doctype html> |
2 | <html class="default no-js"> | |
3 | <head> | |
4 | <meta charset="utf-8"> | |
5 | <meta http-equiv="X-UA-Compatible" content="IE=edge"> | |
6 | <title>DynamicClusterPool | poolifier</title> | |
7 | <meta name="description" content="Documentation for poolifier"> | |
8 | <meta name="viewport" content="width=device-width, initial-scale=1"> | |
9 | <link rel="stylesheet" href="../assets/css/main.css"> | |
10 | <script async src="../assets/js/search.js" id="search-script"></script> | |
11 | </head> | |
12 | <body> | |
13 | <header> | |
14 | <div class="tsd-page-toolbar"> | |
15 | <div class="container"> | |
16 | <div class="table-wrap"> | |
17 | <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> | |
18 | <div class="field"> | |
19 | <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> | |
20 | <input id="tsd-search-field" type="text" /> | |
21 | </div> | |
22 | <ul class="results"> | |
23 | <li class="state loading">Preparing search index...</li> | |
24 | <li class="state failure">The search index is not available</li> | |
25 | </ul> | |
26 | <a href="../index.html" class="title">poolifier</a> | |
27 | </div> | |
28 | <div class="table-cell" id="tsd-widgets"> | |
29 | <div id="tsd-filter"> | |
30 | <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> | |
31 | <div class="tsd-filter-group"> | |
32 | <div class="tsd-select" id="tsd-filter-visibility"> | |
33 | <span class="tsd-select-label">All</span> | |
34 | <ul class="tsd-select-list"> | |
35 | <li data-value="public">Public</li> | |
36 | <li data-value="protected">Public/Protected</li> | |
37 | <li data-value="private" class="selected">All</li> | |
38 | </ul> | |
39 | </div> | |
40 | <input type="checkbox" id="tsd-filter-inherited" checked /> | |
41 | <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> | |
42 | <input type="checkbox" id="tsd-filter-externals" checked /> | |
43 | <label class="tsd-widget" for="tsd-filter-externals">Externals</label> | |
44 | </div> | |
45 | </div> | |
46 | <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> | |
47 | </div> | |
48 | </div> | |
49 | </div> | |
50 | </div> | |
51 | <div class="tsd-page-title"> | |
52 | <div class="container"> | |
53 | <ul class="tsd-breadcrumb"> | |
54 | <li> | |
55 | <a href="../index.html">poolifier</a> | |
56 | </li> | |
57 | <li> | |
58 | <a href="dynamicclusterpool.html">DynamicClusterPool</a> | |
59 | </li> | |
60 | </ul> | |
61 | <h1>Class DynamicClusterPool<Data, Response></h1> | |
62 | </div> | |
63 | </div> | |
64 | </header> | |
65 | <div class="container container-main"> | |
66 | <div class="row"> | |
67 | <div class="col-8 col-content"> | |
68 | <section class="tsd-panel tsd-comment"> | |
69 | <div class="tsd-comment tsd-typography"> | |
70 | <div class="lead"> | |
71 | <p>A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.</p> | |
72 | </div> | |
73 | <p>This cluster pool creates new workers when the others are busy, up to the maximum number of workers. | |
74 | When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's <code>emitter</code>.</p> | |
75 | <dl class="tsd-comment-tags"> | |
76 | <dt>author</dt> | |
77 | <dd><p><a href="https://github.com/Shinigami92">Christopher Quadflieg</a></p> | |
78 | </dd> | |
79 | <dt>since</dt> | |
80 | <dd><p>2.0.0</p> | |
81 | </dd> | |
82 | </dl> | |
83 | </div> | |
84 | </section> | |
85 | <section class="tsd-panel tsd-type-parameters"> | |
86 | <h3>Type parameters</h3> | |
87 | <ul class="tsd-type-parameters"> | |
88 | <li> | |
89 | <h4>Data = <span class="tsd-signature-type">unknown</span></h4> | |
90 | <div class="tsd-comment tsd-typography"> | |
91 | <div class="lead"> | |
92 | <p>Type of data sent to the worker. This can only be serializable data.</p> | |
93 | </div> | |
94 | </div> | |
95 | </li> | |
96 | <li> | |
97 | <h4>Response = <span class="tsd-signature-type">unknown</span></h4> | |
98 | <div class="tsd-comment tsd-typography"> | |
99 | <div class="lead"> | |
100 | <p>Type of response of execution. This can only be serializable data.</p> | |
101 | </div> | |
102 | </div> | |
103 | </li> | |
104 | </ul> | |
105 | </section> | |
106 | <section class="tsd-panel tsd-hierarchy"> | |
107 | <h3>Hierarchy</h3> | |
108 | <ul class="tsd-hierarchy"> | |
109 | <li> | |
110 | <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</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span> | |
111 | <ul class="tsd-hierarchy"> | |
112 | <li> | |
113 | <span class="target">DynamicClusterPool</span> | |
114 | </li> | |
115 | </ul> | |
116 | </li> | |
117 | </ul> | |
118 | </section> | |
119 | <section class="tsd-panel-group tsd-index-group"> | |
120 | <h2>Index</h2> | |
121 | <section class="tsd-panel tsd-index-panel"> | |
122 | <div class="tsd-index-content"> | |
123 | <section class="tsd-index-section "> | |
124 | <h3>Constructors</h3> | |
125 | <ul class="tsd-index-list"> | |
126 | <li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="dynamicclusterpool.html#constructor" class="tsd-kind-icon">constructor</a></li> | |
127 | </ul> | |
128 | </section> | |
129 | <section class="tsd-index-section "> | |
130 | <h3>Properties</h3> | |
131 | <ul class="tsd-index-list"> | |
132 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#emitter" class="tsd-kind-icon">emitter</a></li> | |
133 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a></li> | |
134 | <li class="tsd-kind-property tsd-parent-kind-class"><a href="dynamicclusterpool.html#max" class="tsd-kind-icon">max</a></li> | |
135 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a></li> | |
136 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a></li> | |
137 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#opts" class="tsd-kind-icon">opts</a></li> | |
138 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a></li> | |
139 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#tasks" class="tsd-kind-icon">tasks</a></li> | |
140 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a></li> | |
141 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#workers" class="tsd-kind-icon">workers</a></li> | |
142 | </ul> | |
143 | </section> | |
144 | <section class="tsd-index-section "> | |
145 | <h3>Accessors</h3> | |
146 | <ul class="tsd-index-list"> | |
147 | <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#dynamic" class="tsd-kind-icon">dynamic</a></li> | |
148 | </ul> | |
149 | </section> | |
150 | <section class="tsd-index-section "> | |
151 | <h3>Methods</h3> | |
152 | <ul class="tsd-index-list"> | |
153 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a></li> | |
154 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a></li> | |
155 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#createandsetupworker" class="tsd-kind-icon">create<wbr>And<wbr>Setup<wbr>Worker</a></li> | |
156 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a></li> | |
157 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a></li> | |
158 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#destroy" class="tsd-kind-icon">destroy</a></li> | |
159 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a></li> | |
160 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#execute" class="tsd-kind-icon">execute</a></li> | |
161 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a></li> | |
162 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a></li> | |
163 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a></li> | |
164 | <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="dynamicclusterpool.html#registerworkermessagelistener" class="tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener</a></li> | |
165 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a></li> | |
166 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a></li> | |
167 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="dynamicclusterpool.html#setworkerchoicestrategy" class="tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy</a></li> | |
168 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a></li> | |
169 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="dynamicclusterpool.html#workerlistener" class="tsd-kind-icon">worker<wbr>Listener</a></li> | |
170 | </ul> | |
171 | </section> | |
172 | </div> | |
173 | </section> | |
174 | </section> | |
175 | <section class="tsd-panel-group tsd-member-group "> | |
176 | <h2>Constructors</h2> | |
177 | <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> | |
178 | <a name="constructor" class="tsd-anchor"></a> | |
179 | <h3>constructor</h3> | |
180 | <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> | |
181 | <li class="tsd-signature tsd-kind-icon">new <wbr>Dynamic<wbr>Cluster<wbr>Pool<Data, Response><span class="tsd-signature-symbol">(</span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, max<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="dynamicclusterpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li> | |
182 | </ul> | |
183 | <ul class="tsd-descriptions"> | |
184 | <li class="tsd-description"> | |
185 | <aside class="tsd-sources"> | |
186 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#constructor">constructor</a></p> | |
187 | <ul> | |
188 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/dynamic.ts#L19">src/pools/cluster/dynamic.ts:19</a></li> | |
189 | </ul> | |
190 | </aside> | |
191 | <div class="tsd-comment tsd-typography"> | |
192 | <div class="lead"> | |
193 | <p>Constructs a new poolifier dynamic cluster pool.</p> | |
194 | </div> | |
195 | </div> | |
196 | <h4 class="tsd-type-parameters-title">Type parameters</h4> | |
197 | <ul class="tsd-type-parameters"> | |
198 | <li> | |
199 | <h4>Data = <span class="tsd-signature-type">unknown</span></h4> | |
200 | </li> | |
201 | <li> | |
202 | <h4>Response = <span class="tsd-signature-type">unknown</span></h4> | |
203 | </li> | |
204 | </ul> | |
205 | <h4 class="tsd-parameters-title">Parameters</h4> | |
206 | <ul class="tsd-parameters"> | |
207 | <li> | |
208 | <h5>min: <span class="tsd-signature-type">number</span></h5> | |
209 | <div class="tsd-comment tsd-typography"> | |
210 | <p>Minimum number of workers which are always active.</p> | |
211 | </div> | |
212 | </li> | |
213 | <li> | |
214 | <h5>max: <span class="tsd-signature-type">number</span></h5> | |
215 | <div class="tsd-comment tsd-typography"> | |
216 | <p>Maximum number of workers that can be created by this pool.</p> | |
217 | </div> | |
218 | </li> | |
219 | <li> | |
220 | <h5>filePath: <span class="tsd-signature-type">string</span></h5> | |
221 | <div class="tsd-comment tsd-typography"> | |
222 | <p>Path to an implementation of a <code>ClusterWorker</code> file, which can be relative or absolute.</p> | |
223 | </div> | |
224 | </li> | |
225 | <li> | |
226 | <h5>opts: <a href="../interfaces/clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a><span class="tsd-signature-symbol"> = ...</span></h5> | |
227 | <div class="tsd-comment tsd-typography"> | |
228 | <p>Options for this dynamic cluster pool. Default: <code>{}</code></p> | |
229 | </div> | |
230 | </li> | |
231 | </ul> | |
232 | <h4 class="tsd-returns-title">Returns <a href="dynamicclusterpool.html" class="tsd-signature-type" data-tsd-kind="Class">DynamicClusterPool</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4> | |
233 | </li> | |
234 | </ul> | |
235 | </section> | |
236 | </section> | |
237 | <section class="tsd-panel-group tsd-member-group "> | |
238 | <h2>Properties</h2> | |
239 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
240 | <a name="emitter" class="tsd-anchor"></a> | |
241 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> emitter</h3> | |
242 | <div class="tsd-signature tsd-kind-icon">emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PoolEmitter</span></div> | |
243 | <aside class="tsd-sources"> | |
244 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#emitter">emitter</a></p> | |
245 | <ul> | |
246 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L111">src/pools/abstract-pool.ts:111</a></li> | |
247 | </ul> | |
248 | </aside> | |
249 | </section> | |
250 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
251 | <a name="filepath" class="tsd-anchor"></a> | |
252 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> file<wbr>Path</h3> | |
253 | <div class="tsd-signature tsd-kind-icon">file<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> | |
254 | <aside class="tsd-sources"> | |
255 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#filepath">filePath</a></p> | |
256 | </aside> | |
257 | </section> | |
258 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> | |
259 | <a name="max" class="tsd-anchor"></a> | |
260 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> max</h3> | |
261 | <div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> | |
262 | <aside class="tsd-sources"> | |
263 | </aside> | |
264 | </section> | |
265 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
266 | <a name="nextmessageid" class="tsd-anchor"></a> | |
267 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> next<wbr>Message<wbr>Id</h3> | |
268 | <div class="tsd-signature tsd-kind-icon">next<wbr>Message<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div> | |
269 | <aside class="tsd-sources"> | |
270 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#nextmessageid">nextMessageId</a></p> | |
271 | <ul> | |
272 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L129">src/pools/abstract-pool.ts:129</a></li> | |
273 | </ul> | |
274 | </aside> | |
275 | <div class="tsd-comment tsd-typography"> | |
276 | <div class="lead"> | |
277 | <p>ID of the next message.</p> | |
278 | </div> | |
279 | </div> | |
280 | </section> | |
281 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
282 | <a name="numberofworkers" class="tsd-anchor"></a> | |
283 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> number<wbr>OfWorkers</h3> | |
284 | <div class="tsd-signature tsd-kind-icon">number<wbr>OfWorkers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> | |
285 | <aside class="tsd-sources"> | |
286 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#numberofworkers">numberOfWorkers</a></p> | |
287 | </aside> | |
288 | </section> | |
289 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
290 | <a name="opts" class="tsd-anchor"></a> | |
291 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> opts</h3> | |
292 | <div class="tsd-signature tsd-kind-icon">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> | |
293 | <aside class="tsd-sources"> | |
294 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#opts">opts</a></p> | |
295 | </aside> | |
296 | </section> | |
297 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
298 | <a name="promisemap" class="tsd-anchor"></a> | |
299 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> promise<wbr>Map</h3> | |
300 | <div class="tsd-signature tsd-kind-icon">promise<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">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">PromiseWorkerResponseWrapper</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">Response</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div> | |
301 | <aside class="tsd-sources"> | |
302 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#promisemap">promiseMap</a></p> | |
303 | <ul> | |
304 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L121">src/pools/abstract-pool.ts:121</a></li> | |
305 | </ul> | |
306 | </aside> | |
307 | <div class="tsd-comment tsd-typography"> | |
308 | <div class="lead"> | |
309 | <p>The promise map.</p> | |
310 | </div> | |
311 | <ul> | |
312 | <li><code>key</code>: This is the message ID of each submitted task.</li> | |
313 | <li><code>value</code>: An object that contains the worker, the resolve function and the reject function.</li> | |
314 | </ul> | |
315 | <p>When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.</p> | |
316 | </div> | |
317 | </section> | |
318 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
319 | <a name="tasks" class="tsd-anchor"></a> | |
320 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> tasks</h3> | |
321 | <div class="tsd-signature tsd-kind-icon">tasks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</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">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div> | |
322 | <aside class="tsd-sources"> | |
323 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#tasks">tasks</a></p> | |
324 | <ul> | |
325 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L108">src/pools/abstract-pool.ts:108</a></li> | |
326 | </ul> | |
327 | </aside> | |
328 | </section> | |
329 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
330 | <a name="workerchoicestrategycontext" class="tsd-anchor"></a> | |
331 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> worker<wbr>Choice<wbr>Strategy<wbr>Context</h3> | |
332 | <div class="tsd-signature tsd-kind-icon">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</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></div> | |
333 | <aside class="tsd-sources"> | |
334 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#workerchoicestrategycontext">workerChoiceStrategyContext</a></p> | |
335 | <ul> | |
336 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L136">src/pools/abstract-pool.ts:136</a></li> | |
337 | </ul> | |
338 | </aside> | |
339 | <div class="tsd-comment tsd-typography"> | |
340 | <div class="lead"> | |
341 | <p>Worker choice strategy instance implementing the worker choice algorithm.</p> | |
342 | </div> | |
343 | <p>Default to a strategy implementing a round robin algorithm.</p> | |
344 | </div> | |
345 | </section> | |
346 | <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
347 | <a name="workers" class="tsd-anchor"></a> | |
348 | <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> workers</h3> | |
349 | <div class="tsd-signature tsd-kind-icon">workers<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></div> | |
350 | <aside class="tsd-sources"> | |
351 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#workers">workers</a></p> | |
352 | <ul> | |
353 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L105">src/pools/abstract-pool.ts:105</a></li> | |
354 | </ul> | |
355 | </aside> | |
356 | </section> | |
357 | </section> | |
358 | <section class="tsd-panel-group tsd-member-group "> | |
359 | <h2>Accessors</h2> | |
360 | <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> | |
361 | <a name="dynamic" class="tsd-anchor"></a> | |
362 | <h3>dynamic</h3> | |
363 | <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> | |
364 | <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dynamic<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> | |
365 | </ul> | |
366 | <ul class="tsd-descriptions"> | |
367 | <li class="tsd-description"> | |
368 | <aside class="tsd-sources"> | |
369 | <ul> | |
370 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/dynamic.ts#L38">src/pools/cluster/dynamic.ts:38</a></li> | |
371 | </ul> | |
372 | </aside> | |
373 | <div class="tsd-comment tsd-typography"> | |
374 | <dl class="tsd-comment-tags"> | |
375 | <dt>inheritdoc</dt> | |
376 | <dd></dd> | |
377 | </dl> | |
378 | </div> | |
379 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> | |
380 | </li> | |
381 | </ul> | |
382 | </section> | |
383 | </section> | |
384 | <section class="tsd-panel-group tsd-member-group "> | |
385 | <h2>Methods</h2> | |
386 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
387 | <a name="afterworkersetup" class="tsd-anchor"></a> | |
388 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> after<wbr>Worker<wbr>Setup</h3> | |
389 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
390 | <li class="tsd-signature tsd-kind-icon">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></li> | |
391 | </ul> | |
392 | <ul class="tsd-descriptions"> | |
393 | <li class="tsd-description"> | |
394 | <aside class="tsd-sources"> | |
395 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#afterworkersetup">afterWorkerSetup</a></p> | |
396 | <ul> | |
397 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L83">src/pools/cluster/fixed.ts:83</a></li> | |
398 | </ul> | |
399 | </aside> | |
400 | <h4 class="tsd-parameters-title">Parameters</h4> | |
401 | <ul class="tsd-parameters"> | |
402 | <li> | |
403 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
404 | </li> | |
405 | </ul> | |
406 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
407 | </li> | |
408 | </ul> | |
409 | </section> | |
410 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
411 | <a name="chooseworker" class="tsd-anchor"></a> | |
412 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> choose<wbr>Worker</h3> | |
413 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
414 | <li class="tsd-signature tsd-kind-icon">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-type">Worker</span></li> | |
415 | </ul> | |
416 | <ul class="tsd-descriptions"> | |
417 | <li class="tsd-description"> | |
418 | <aside class="tsd-sources"> | |
419 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#chooseworker">chooseWorker</a></p> | |
420 | <ul> | |
421 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L313">src/pools/abstract-pool.ts:313</a></li> | |
422 | </ul> | |
423 | </aside> | |
424 | <div class="tsd-comment tsd-typography"> | |
425 | <div class="lead"> | |
426 | <p>Choose a worker for the next task.</p> | |
427 | </div> | |
428 | <p>The default implementation uses a round robin algorithm to distribute the load.</p> | |
429 | </div> | |
430 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4> | |
431 | <p>Worker.</p> | |
432 | </li> | |
433 | </ul> | |
434 | </section> | |
435 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
436 | <a name="createandsetupworker" class="tsd-anchor"></a> | |
437 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>And<wbr>Setup<wbr>Worker</h3> | |
438 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
439 | <li class="tsd-signature tsd-kind-icon">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></li> | |
440 | </ul> | |
441 | <ul class="tsd-descriptions"> | |
442 | <li class="tsd-description"> | |
443 | <aside class="tsd-sources"> | |
444 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#createandsetupworker">createAndSetupWorker</a></p> | |
445 | <ul> | |
446 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L366">src/pools/abstract-pool.ts:366</a></li> | |
447 | </ul> | |
448 | </aside> | |
449 | <div class="tsd-comment tsd-typography"> | |
450 | <div class="lead"> | |
451 | <p>Creates a new worker for this pool and sets it up completely.</p> | |
452 | </div> | |
453 | </div> | |
454 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4> | |
455 | <p>New, completely set up worker.</p> | |
456 | </li> | |
457 | </ul> | |
458 | </section> | |
459 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
460 | <a name="createworker" class="tsd-anchor"></a> | |
461 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Worker</h3> | |
462 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
463 | <li class="tsd-signature tsd-kind-icon">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></li> | |
464 | </ul> | |
465 | <ul class="tsd-descriptions"> | |
466 | <li class="tsd-description"> | |
467 | <aside class="tsd-sources"> | |
468 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#createworker">createWorker</a></p> | |
469 | <ul> | |
470 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L79">src/pools/cluster/fixed.ts:79</a></li> | |
471 | </ul> | |
472 | </aside> | |
473 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Worker</span></h4> | |
474 | </li> | |
475 | </ul> | |
476 | </section> | |
477 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
478 | <a name="decreaseworkerstasks" class="tsd-anchor"></a> | |
479 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> decrease<wbr>Workers<wbr>Tasks</h3> | |
480 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
481 | <li class="tsd-signature tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks<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></li> | |
482 | </ul> | |
483 | <ul class="tsd-descriptions"> | |
484 | <li class="tsd-description"> | |
485 | <aside class="tsd-sources"> | |
486 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#decreaseworkerstasks">decreaseWorkersTasks</a></p> | |
487 | <ul> | |
488 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L275">src/pools/abstract-pool.ts:275</a></li> | |
489 | </ul> | |
490 | </aside> | |
491 | <div class="tsd-comment tsd-typography"> | |
492 | <div class="lead"> | |
493 | <p>Decrease the number of tasks that the given workers has done.</p> | |
494 | </div> | |
495 | </div> | |
496 | <h4 class="tsd-parameters-title">Parameters</h4> | |
497 | <ul class="tsd-parameters"> | |
498 | <li> | |
499 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
500 | <div class="tsd-comment tsd-typography"> | |
501 | <p>Worker whose tasks are decreased.</p> | |
502 | </div> | |
503 | </li> | |
504 | </ul> | |
505 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
506 | </li> | |
507 | </ul> | |
508 | </section> | |
509 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
510 | <a name="destroy" class="tsd-anchor"></a> | |
511 | <h3>destroy</h3> | |
512 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
513 | <li class="tsd-signature tsd-kind-icon">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></li> | |
514 | </ul> | |
515 | <ul class="tsd-descriptions"> | |
516 | <li class="tsd-description"> | |
517 | <aside class="tsd-sources"> | |
518 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#destroy">destroy</a></p> | |
519 | <ul> | |
520 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L237">src/pools/abstract-pool.ts:237</a></li> | |
521 | </ul> | |
522 | </aside> | |
523 | <div class="tsd-comment tsd-typography"> | |
524 | <dl class="tsd-comment-tags"> | |
525 | <dt>inheritdoc</dt> | |
526 | <dd></dd> | |
527 | </dl> | |
528 | </div> | |
529 | <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> | |
530 | </li> | |
531 | </ul> | |
532 | </section> | |
533 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
534 | <a name="destroyworker" class="tsd-anchor"></a> | |
535 | <h3>destroy<wbr>Worker</h3> | |
536 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
537 | <li class="tsd-signature tsd-kind-icon">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></li> | |
538 | </ul> | |
539 | <ul class="tsd-descriptions"> | |
540 | <li class="tsd-description"> | |
541 | <aside class="tsd-sources"> | |
542 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#destroyworker">destroyWorker</a></p> | |
543 | <ul> | |
544 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L62">src/pools/cluster/fixed.ts:62</a></li> | |
545 | </ul> | |
546 | </aside> | |
547 | <div class="tsd-comment tsd-typography"> | |
548 | <dl class="tsd-comment-tags"> | |
549 | <dt>inheritdoc</dt> | |
550 | <dd></dd> | |
551 | </dl> | |
552 | </div> | |
553 | <h4 class="tsd-parameters-title">Parameters</h4> | |
554 | <ul class="tsd-parameters"> | |
555 | <li> | |
556 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
557 | </li> | |
558 | </ul> | |
559 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
560 | </li> | |
561 | </ul> | |
562 | </section> | |
563 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
564 | <a name="execute" class="tsd-anchor"></a> | |
565 | <h3>execute</h3> | |
566 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
567 | <li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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">Response</span><span class="tsd-signature-symbol">></span></li> | |
568 | </ul> | |
569 | <ul class="tsd-descriptions"> | |
570 | <li class="tsd-description"> | |
571 | <aside class="tsd-sources"> | |
572 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#execute">execute</a></p> | |
573 | <ul> | |
574 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L226">src/pools/abstract-pool.ts:226</a></li> | |
575 | </ul> | |
576 | </aside> | |
577 | <div class="tsd-comment tsd-typography"> | |
578 | <dl class="tsd-comment-tags"> | |
579 | <dt>inheritdoc</dt> | |
580 | <dd></dd> | |
581 | </dl> | |
582 | </div> | |
583 | <h4 class="tsd-parameters-title">Parameters</h4> | |
584 | <ul class="tsd-parameters"> | |
585 | <li> | |
586 | <h5>data: <span class="tsd-signature-type">Data</span></h5> | |
587 | </li> | |
588 | </ul> | |
589 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4> | |
590 | </li> | |
591 | </ul> | |
592 | </section> | |
593 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
594 | <a name="increaseworkerstask" class="tsd-anchor"></a> | |
595 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> increase<wbr>Workers<wbr>Task</h3> | |
596 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
597 | <li class="tsd-signature tsd-kind-icon">increase<wbr>Workers<wbr>Task<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></li> | |
598 | </ul> | |
599 | <ul class="tsd-descriptions"> | |
600 | <li class="tsd-description"> | |
601 | <aside class="tsd-sources"> | |
602 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#increaseworkerstask">increaseWorkersTask</a></p> | |
603 | <ul> | |
604 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L266">src/pools/abstract-pool.ts:266</a></li> | |
605 | </ul> | |
606 | </aside> | |
607 | <div class="tsd-comment tsd-typography"> | |
608 | <div class="lead"> | |
609 | <p>Increase the number of tasks that the given workers has done.</p> | |
610 | </div> | |
611 | </div> | |
612 | <h4 class="tsd-parameters-title">Parameters</h4> | |
613 | <ul class="tsd-parameters"> | |
614 | <li> | |
615 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
616 | <div class="tsd-comment tsd-typography"> | |
617 | <p>Worker whose tasks are increased.</p> | |
618 | </div> | |
619 | </li> | |
620 | </ul> | |
621 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
622 | </li> | |
623 | </ul> | |
624 | </section> | |
625 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
626 | <a name="internalexecute" class="tsd-anchor"></a> | |
627 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> internal<wbr>Execute</h3> | |
628 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
629 | <li class="tsd-signature tsd-kind-icon">internal<wbr>Execute<span class="tsd-signature-symbol">(</span>worker<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Worker</span>, messageId<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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></li> | |
630 | </ul> | |
631 | <ul class="tsd-descriptions"> | |
632 | <li class="tsd-description"> | |
633 | <aside class="tsd-sources"> | |
634 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#internalexecute">internalExecute</a></p> | |
635 | <ul> | |
636 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L338">src/pools/abstract-pool.ts:338</a></li> | |
637 | </ul> | |
638 | </aside> | |
639 | <h4 class="tsd-parameters-title">Parameters</h4> | |
640 | <ul class="tsd-parameters"> | |
641 | <li> | |
642 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
643 | </li> | |
644 | <li> | |
645 | <h5>messageId: <span class="tsd-signature-type">number</span></h5> | |
646 | </li> | |
647 | </ul> | |
648 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4> | |
649 | </li> | |
650 | </ul> | |
651 | </section> | |
652 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
653 | <a name="ismain" class="tsd-anchor"></a> | |
654 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Main</h3> | |
655 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
656 | <li class="tsd-signature tsd-kind-icon">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></li> | |
657 | </ul> | |
658 | <ul class="tsd-descriptions"> | |
659 | <li class="tsd-description"> | |
660 | <aside class="tsd-sources"> | |
661 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#ismain">isMain</a></p> | |
662 | <ul> | |
663 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L57">src/pools/cluster/fixed.ts:57</a></li> | |
664 | </ul> | |
665 | </aside> | |
666 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> | |
667 | </li> | |
668 | </ul> | |
669 | </section> | |
670 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> | |
671 | <a name="registerworkermessagelistener" class="tsd-anchor"></a> | |
672 | <h3>register<wbr>Worker<wbr>Message<wbr>Listener</h3> | |
673 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> | |
674 | <li class="tsd-signature tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener<Message><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>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">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-type">void</span></li> | |
675 | </ul> | |
676 | <ul class="tsd-descriptions"> | |
677 | <li class="tsd-description"> | |
678 | <aside class="tsd-sources"> | |
679 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#registerworkermessagelistener">registerWorkerMessageListener</a></p> | |
680 | <ul> | |
681 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L72">src/pools/cluster/fixed.ts:72</a></li> | |
682 | </ul> | |
683 | </aside> | |
684 | <div class="tsd-comment tsd-typography"> | |
685 | <dl class="tsd-comment-tags"> | |
686 | <dt>inheritdoc</dt> | |
687 | <dd></dd> | |
688 | </dl> | |
689 | </div> | |
690 | <h4 class="tsd-type-parameters-title">Type parameters</h4> | |
691 | <ul class="tsd-type-parameters"> | |
692 | <li> | |
693 | <h4>Message</h4> | |
694 | </li> | |
695 | </ul> | |
696 | <h4 class="tsd-parameters-title">Parameters</h4> | |
697 | <ul class="tsd-parameters"> | |
698 | <li> | |
699 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
700 | </li> | |
701 | <li> | |
702 | <h5>listener: <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">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></h5> | |
703 | <ul class="tsd-parameters"> | |
704 | <li class="tsd-parameter-signature"> | |
705 | <ul class="tsd-signatures tsd-kind-type-literal"> | |
706 | <li class="tsd-signature tsd-kind-icon"><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">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> | |
707 | </ul> | |
708 | <ul class="tsd-descriptions"> | |
709 | <li class="tsd-description"> | |
710 | <h4 class="tsd-parameters-title">Parameters</h4> | |
711 | <ul class="tsd-parameters"> | |
712 | <li> | |
713 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5> | |
714 | </li> | |
715 | </ul> | |
716 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
717 | </li> | |
718 | </ul> | |
719 | </li> | |
720 | </ul> | |
721 | </li> | |
722 | </ul> | |
723 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
724 | </li> | |
725 | </ul> | |
726 | </section> | |
727 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
728 | <a name="removeworker" class="tsd-anchor"></a> | |
729 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> remove<wbr>Worker</h3> | |
730 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
731 | <li class="tsd-signature tsd-kind-icon">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></li> | |
732 | </ul> | |
733 | <ul class="tsd-descriptions"> | |
734 | <li class="tsd-description"> | |
735 | <aside class="tsd-sources"> | |
736 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#removeworker">removeWorker</a></p> | |
737 | <ul> | |
738 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L299">src/pools/abstract-pool.ts:299</a></li> | |
739 | </ul> | |
740 | </aside> | |
741 | <div class="tsd-comment tsd-typography"> | |
742 | <div class="lead"> | |
743 | <p>Removes the given worker from the pool.</p> | |
744 | </div> | |
745 | </div> | |
746 | <h4 class="tsd-parameters-title">Parameters</h4> | |
747 | <ul class="tsd-parameters"> | |
748 | <li> | |
749 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
750 | <div class="tsd-comment tsd-typography"> | |
751 | <p>Worker that will be removed.</p> | |
752 | </div> | |
753 | </li> | |
754 | </ul> | |
755 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
756 | </li> | |
757 | </ul> | |
758 | </section> | |
759 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
760 | <a name="sendtoworker" class="tsd-anchor"></a> | |
761 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> send<wbr>ToWorker</h3> | |
762 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
763 | <li class="tsd-signature tsd-kind-icon">send<wbr>ToWorker<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</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> | |
764 | </ul> | |
765 | <ul class="tsd-descriptions"> | |
766 | <li class="tsd-description"> | |
767 | <aside class="tsd-sources"> | |
768 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#sendtoworker">sendToWorker</a></p> | |
769 | <ul> | |
770 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L67">src/pools/cluster/fixed.ts:67</a></li> | |
771 | </ul> | |
772 | </aside> | |
773 | <h4 class="tsd-parameters-title">Parameters</h4> | |
774 | <ul class="tsd-parameters"> | |
775 | <li> | |
776 | <h5>worker: <span class="tsd-signature-type">Worker</span></h5> | |
777 | </li> | |
778 | <li> | |
779 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Data</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5> | |
780 | </li> | |
781 | </ul> | |
782 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
783 | </li> | |
784 | </ul> | |
785 | </section> | |
786 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
787 | <a name="setworkerchoicestrategy" class="tsd-anchor"></a> | |
788 | <h3>set<wbr>Worker<wbr>Choice<wbr>Strategy</h3> | |
789 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
790 | <li class="tsd-signature tsd-kind-icon">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_RECENTLY_USED"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> | |
791 | </ul> | |
792 | <ul class="tsd-descriptions"> | |
793 | <li class="tsd-description"> | |
794 | <aside class="tsd-sources"> | |
795 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#setworkerchoicestrategy">setWorkerChoiceStrategy</a></p> | |
796 | <ul> | |
797 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L216">src/pools/abstract-pool.ts:216</a></li> | |
798 | </ul> | |
799 | </aside> | |
800 | <div class="tsd-comment tsd-typography"> | |
801 | <dl class="tsd-comment-tags"> | |
802 | <dt>inheritdoc</dt> | |
803 | <dd></dd> | |
804 | </dl> | |
805 | </div> | |
806 | <h4 class="tsd-parameters-title">Parameters</h4> | |
807 | <ul class="tsd-parameters"> | |
808 | <li> | |
809 | <h5>workerChoiceStrategy: <span class="tsd-signature-type">"ROUND_ROBIN"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"LESS_RECENTLY_USED"</span></h5> | |
810 | </li> | |
811 | </ul> | |
812 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
813 | </li> | |
814 | </ul> | |
815 | </section> | |
816 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
817 | <a name="setuphook" class="tsd-anchor"></a> | |
818 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> setup<wbr>Hook</h3> | |
819 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
820 | <li class="tsd-signature tsd-kind-icon">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></li> | |
821 | </ul> | |
822 | <ul class="tsd-descriptions"> | |
823 | <li class="tsd-description"> | |
824 | <aside class="tsd-sources"> | |
825 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#setuphook">setupHook</a></p> | |
826 | <ul> | |
827 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/cluster/fixed.ts#L51">src/pools/cluster/fixed.ts:51</a></li> | |
828 | </ul> | |
829 | </aside> | |
830 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
831 | </li> | |
832 | </ul> | |
833 | </section> | |
834 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
835 | <a name="workerlistener" class="tsd-anchor"></a> | |
836 | <h3><span class="tsd-flag ts-flagProtected">Protected</span> worker<wbr>Listener</h3> | |
837 | <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
838 | <li class="tsd-signature tsd-kind-icon">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>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">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> | |
839 | </ul> | |
840 | <ul class="tsd-descriptions"> | |
841 | <li class="tsd-description"> | |
842 | <aside class="tsd-sources"> | |
843 | <p>Inherited from <a href="fixedclusterpool.html">FixedClusterPool</a>.<a href="fixedclusterpool.html#workerlistener">workerListener</a></p> | |
844 | <ul> | |
845 | <li>Defined in <a href="https://github.com/jerome-benoit/poolifier/blob/5d4101b/src/pools/abstract-pool.ts#L389">src/pools/abstract-pool.ts:389</a></li> | |
846 | </ul> | |
847 | </aside> | |
848 | <div class="tsd-comment tsd-typography"> | |
849 | <div class="lead"> | |
850 | <p>This function is the listener registered for each worker.</p> | |
851 | </div> | |
852 | </div> | |
853 | <h4 class="tsd-returns-title">Returns <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">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></h4> | |
854 | <p>The listener function to execute when a message is sent from a worker.</p> | |
855 | <ul class="tsd-parameters"> | |
856 | <li class="tsd-parameter-signature"> | |
857 | <ul class="tsd-signatures tsd-kind-type-literal"> | |
858 | <li class="tsd-signature tsd-kind-icon"><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">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> | |
859 | </ul> | |
860 | <ul class="tsd-descriptions"> | |
861 | <li class="tsd-description"> | |
862 | <h4 class="tsd-parameters-title">Parameters</h4> | |
863 | <ul class="tsd-parameters"> | |
864 | <li> | |
865 | <h5>message: <span class="tsd-signature-type">MessageValue</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></h5> | |
866 | </li> | |
867 | </ul> | |
868 | <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> | |
869 | </li> | |
870 | </ul> | |
871 | </li> | |
872 | </ul> | |
873 | </li> | |
874 | </ul> | |
875 | </section> | |
876 | </section> | |
877 | </div> | |
878 | <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> | |
879 | <nav class="tsd-navigation primary"> | |
880 | <ul> | |
881 | <li class=" "> | |
882 | <a href="../index.html">Exports</a> | |
883 | </li> | |
884 | </ul> | |
885 | </nav> | |
886 | <nav class="tsd-navigation secondary menu-sticky"> | |
887 | <ul class="before-current"> | |
888 | <li class=" tsd-kind-class tsd-has-type-parameter"> | |
889 | <a href="abstractworker.html" class="tsd-kind-icon">Abstract<wbr>Worker</a> | |
890 | </li> | |
891 | <li class=" tsd-kind-class tsd-has-type-parameter"> | |
892 | <a href="clusterworker.html" class="tsd-kind-icon">Cluster<wbr>Worker</a> | |
893 | </li> | |
894 | </ul> | |
895 | <ul class="current"> | |
896 | <li class="current tsd-kind-class tsd-has-type-parameter"> | |
897 | <a href="dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a> | |
898 | <ul> | |
899 | <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> | |
900 | <a href="dynamicclusterpool.html#constructor" class="tsd-kind-icon">constructor</a> | |
901 | </li> | |
902 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
903 | <a href="dynamicclusterpool.html#emitter" class="tsd-kind-icon">emitter</a> | |
904 | </li> | |
905 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
906 | <a href="dynamicclusterpool.html#filepath" class="tsd-kind-icon">file<wbr>Path</a> | |
907 | </li> | |
908 | <li class=" tsd-kind-property tsd-parent-kind-class"> | |
909 | <a href="dynamicclusterpool.html#max" class="tsd-kind-icon">max</a> | |
910 | </li> | |
911 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
912 | <a href="dynamicclusterpool.html#nextmessageid" class="tsd-kind-icon">next<wbr>Message<wbr>Id</a> | |
913 | </li> | |
914 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
915 | <a href="dynamicclusterpool.html#numberofworkers" class="tsd-kind-icon">number<wbr>OfWorkers</a> | |
916 | </li> | |
917 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
918 | <a href="dynamicclusterpool.html#opts" class="tsd-kind-icon">opts</a> | |
919 | </li> | |
920 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
921 | <a href="dynamicclusterpool.html#promisemap" class="tsd-kind-icon">promise<wbr>Map</a> | |
922 | </li> | |
923 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
924 | <a href="dynamicclusterpool.html#tasks" class="tsd-kind-icon">tasks</a> | |
925 | </li> | |
926 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
927 | <a href="dynamicclusterpool.html#workerchoicestrategycontext" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<wbr>Context</a> | |
928 | </li> | |
929 | <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> | |
930 | <a href="dynamicclusterpool.html#workers" class="tsd-kind-icon">workers</a> | |
931 | </li> | |
932 | <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"> | |
933 | <a href="dynamicclusterpool.html#dynamic" class="tsd-kind-icon">dynamic</a> | |
934 | </li> | |
935 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
936 | <a href="dynamicclusterpool.html#afterworkersetup" class="tsd-kind-icon">after<wbr>Worker<wbr>Setup</a> | |
937 | </li> | |
938 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
939 | <a href="dynamicclusterpool.html#chooseworker" class="tsd-kind-icon">choose<wbr>Worker</a> | |
940 | </li> | |
941 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
942 | <a href="dynamicclusterpool.html#createandsetupworker" class="tsd-kind-icon">create<wbr>And<wbr>Setup<wbr>Worker</a> | |
943 | </li> | |
944 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
945 | <a href="dynamicclusterpool.html#createworker" class="tsd-kind-icon">create<wbr>Worker</a> | |
946 | </li> | |
947 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
948 | <a href="dynamicclusterpool.html#decreaseworkerstasks" class="tsd-kind-icon">decrease<wbr>Workers<wbr>Tasks</a> | |
949 | </li> | |
950 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
951 | <a href="dynamicclusterpool.html#destroy" class="tsd-kind-icon">destroy</a> | |
952 | </li> | |
953 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
954 | <a href="dynamicclusterpool.html#destroyworker" class="tsd-kind-icon">destroy<wbr>Worker</a> | |
955 | </li> | |
956 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
957 | <a href="dynamicclusterpool.html#execute" class="tsd-kind-icon">execute</a> | |
958 | </li> | |
959 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
960 | <a href="dynamicclusterpool.html#increaseworkerstask" class="tsd-kind-icon">increase<wbr>Workers<wbr>Task</a> | |
961 | </li> | |
962 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
963 | <a href="dynamicclusterpool.html#internalexecute" class="tsd-kind-icon">internal<wbr>Execute</a> | |
964 | </li> | |
965 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
966 | <a href="dynamicclusterpool.html#ismain" class="tsd-kind-icon">is<wbr>Main</a> | |
967 | </li> | |
968 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"> | |
969 | <a href="dynamicclusterpool.html#registerworkermessagelistener" class="tsd-kind-icon">register<wbr>Worker<wbr>Message<wbr>Listener</a> | |
970 | </li> | |
971 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
972 | <a href="dynamicclusterpool.html#removeworker" class="tsd-kind-icon">remove<wbr>Worker</a> | |
973 | </li> | |
974 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
975 | <a href="dynamicclusterpool.html#sendtoworker" class="tsd-kind-icon">send<wbr>ToWorker</a> | |
976 | </li> | |
977 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> | |
978 | <a href="dynamicclusterpool.html#setworkerchoicestrategy" class="tsd-kind-icon">set<wbr>Worker<wbr>Choice<wbr>Strategy</a> | |
979 | </li> | |
980 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
981 | <a href="dynamicclusterpool.html#setuphook" class="tsd-kind-icon">setup<wbr>Hook</a> | |
982 | </li> | |
983 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> | |
984 | <a href="dynamicclusterpool.html#workerlistener" class="tsd-kind-icon">worker<wbr>Listener</a> | |
985 | </li> | |
986 | </ul> | |
987 | </li> | |
988 | </ul> | |
989 | <ul class="after-current"> | |
990 | <li class=" tsd-kind-class tsd-has-type-parameter"> | |
991 | <a href="dynamicthreadpool.html" class="tsd-kind-icon">Dynamic<wbr>Thread<wbr>Pool</a> | |
992 | </li> | |
993 | <li class=" tsd-kind-class tsd-has-type-parameter"> | |
994 | <a href="fixedclusterpool.html" class="tsd-kind-icon">Fixed<wbr>Cluster<wbr>Pool</a> | |
995 | </li> | |
996 | <li class=" tsd-kind-class tsd-has-type-parameter"> | |
997 | <a href="fixedthreadpool.html" class="tsd-kind-icon">Fixed<wbr>Thread<wbr>Pool</a> | |
998 | </li> | |
999 | <li class=" tsd-kind-class tsd-has-type-parameter"> | |
1000 | <a href="threadworker.html" class="tsd-kind-icon">Thread<wbr>Worker</a> | |
1001 | </li> | |
1002 | <li class=" tsd-kind-interface"> | |
1003 | <a href="../interfaces/clusterpooloptions.html" class="tsd-kind-icon">Cluster<wbr>Pool<wbr>Options</a> | |
1004 | </li> | |
1005 | <li class=" tsd-kind-interface tsd-has-type-parameter"> | |
1006 | <a href="../interfaces/ipool.html" class="tsd-kind-icon">IPool</a> | |
1007 | </li> | |
1008 | <li class=" tsd-kind-interface"> | |
1009 | <a href="../interfaces/iworker.html" class="tsd-kind-icon">IWorker</a> | |
1010 | </li> | |
1011 | <li class=" tsd-kind-interface tsd-has-type-parameter"> | |
1012 | <a href="../interfaces/pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a> | |
1013 | </li> | |
1014 | <li class=" tsd-kind-interface"> | |
1015 | <a href="../interfaces/workeroptions.html" class="tsd-kind-icon">Worker<wbr>Options</a> | |
1016 | </li> | |
1017 | <li class=" tsd-kind-type-alias tsd-has-type-parameter"> | |
1018 | <a href="../index.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a> | |
1019 | </li> | |
1020 | <li class=" tsd-kind-type-alias tsd-has-type-parameter"> | |
1021 | <a href="../index.html#exithandler" class="tsd-kind-icon">Exit<wbr>Handler</a> | |
1022 | </li> | |
1023 | <li class=" tsd-kind-type-alias"> | |
1024 | <a href="../index.html#killbehavior" class="tsd-kind-icon">Kill<wbr>Behavior</a> | |
1025 | </li> | |
1026 | <li class=" tsd-kind-type-alias tsd-has-type-parameter"> | |
1027 | <a href="../index.html#onlinehandler" class="tsd-kind-icon">Online<wbr>Handler</a> | |
1028 | </li> | |
1029 | <li class=" tsd-kind-type-alias"> | |
1030 | <a href="../index.html#threadworkerwithmessagechannel" class="tsd-kind-icon">Thread<wbr>Worker<wbr>With<wbr>Message<wbr>Channel</a> | |
1031 | </li> | |
1032 | <li class=" tsd-kind-type-alias"> | |
1033 | <a href="../index.html#workerchoicestrategy" class="tsd-kind-icon">Worker<wbr>Choice<wbr>Strategy</a> | |
1034 | </li> | |
1035 | <li class=" tsd-kind-variable"> | |
1036 | <a href="../index.html#killbehaviors" class="tsd-kind-icon">Kill<wbr>Behaviors</a> | |
1037 | </li> | |
1038 | <li class=" tsd-kind-variable"> | |
1039 | <a href="../index.html#workerchoicestrategies" class="tsd-kind-icon">Worker<wbr>Choice<wbr>Strategies</a> | |
1040 | </li> | |
1041 | </ul> | |
1042 | </nav> | |
1043 | </div> | |
1044 | </div> | |
1045 | </div> | |
1046 | <footer class="with-border-bottom"> | |
1047 | <div class="container"> | |
1048 | <h2>Legend</h2> | |
1049 | <div class="tsd-legend-group"> | |
1050 | <ul class="tsd-legend"> | |
1051 | <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> | |
1052 | <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> | |
1053 | </ul> | |
1054 | <ul class="tsd-legend"> | |
1055 | <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> | |
1056 | <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> | |
1057 | </ul> | |
1058 | <ul class="tsd-legend"> | |
1059 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> | |
1060 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> | |
1061 | </ul> | |
1062 | <ul class="tsd-legend"> | |
1063 | <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> | |
1064 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> | |
1065 | </ul> | |
1066 | <ul class="tsd-legend"> | |
1067 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> | |
1068 | </ul> | |
1069 | </div> | |
1070 | </div> | |
1071 | </footer> | |
1072 | <div class="container tsd-generator"> | |
1073 | <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> | |
1074 | </div> | |
1075 | <div class="overlay"></div> | |
1076 | <script src="../assets/js/main.js"></script> | |
1077 | </body> | |
1078 | </html> |