repositories / poolifier.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Apply dependencies update (#482)
[poolifier.git] / docs / interfaces / pooloptions.html
CommitLineData
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>PoolOptions | 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="pooloptions.html">PoolOptions</a>
59 </li>
60 </ul>
61 <h1>Interface PoolOptions&lt;Worker&gt;</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>Options for a poolifier pool.</p>
72 </div>
73 </div>
74 </section>
75 <section class="tsd-panel tsd-type-parameters">
76 <h3>Type parameters</h3>
77 <ul class="tsd-type-parameters">
78 <li>
79 <h4>Worker</h4>
80 </li>
81 </ul>
82 </section>
83 <section class="tsd-panel tsd-hierarchy">
84 <h3>Hierarchy</h3>
85 <ul class="tsd-hierarchy">
86 <li>
87 <span class="target">PoolOptions</span>
88 <ul class="tsd-hierarchy">
89 <li>
90 <a href="clusterpooloptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterPoolOptions</a>
91 </li>
92 </ul>
93 </li>
94 </ul>
95 </section>
96 <section class="tsd-panel-group tsd-index-group">
97 <h2>Index</h2>
98 <section class="tsd-panel tsd-index-panel">
99 <div class="tsd-index-content">
100 <section class="tsd-index-section ">
101 <h3>Properties</h3>
102 <ul class="tsd-index-list">
7c0ba920 103 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#enableevents" class="tsd-kind-icon">enable<wbr>Events</a></li>
5ea22628
JB		 104 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a></li>
105 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#exithandler" class="tsd-kind-icon">exit<wbr>Handler</a></li>
106 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#onlinehandler" class="tsd-kind-icon">online<wbr>Handler</a></li>
107 <li class="tsd-kind-property tsd-parent-kind-interface"><a href="pooloptions.html#workerchoicestrategy" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy</a></li>
108 </ul>
109 </section>
110 </div>
111 </section>
112 </section>
113 <section class="tsd-panel-group tsd-member-group ">
114 <h2>Properties</h2>
7c0ba920
JB		 115 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116 <a name="enableevents" class="tsd-anchor"></a>
117 <h3><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr>Events</h3>
118 <div class="tsd-signature tsd-kind-icon">enable<wbr>Events<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
119 <aside class="tsd-sources">
120 <ul>
849e0547 121 <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L95">src/pools/abstract-pool.ts:95</a></li>
7c0ba920
JB		 122 </ul>
123 </aside>
124 <div class="tsd-comment tsd-typography">
125 <div class="lead">
126 <p>Pool events emission.</p>
127 </div>
128 <p>Default to true.</p>
129 </div>
130 </section>
5ea22628
JB		 131 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
132 <a name="errorhandler" class="tsd-anchor"></a>
133 <h3><span class="tsd-flag ts-flagOptional">Optional</span> error<wbr>Handler</h3>
134 <div class="tsd-signature tsd-kind-icon">error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#errorhandler" class="tsd-signature-type" data-tsd-kind="Type alias">ErrorHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
135 <aside class="tsd-sources">
136 <ul>
849e0547 137 <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L77">src/pools/abstract-pool.ts:77</a></li>
5ea22628
JB		 138 </ul>
139 </aside>
140 <div class="tsd-comment tsd-typography">
141 <div class="lead">
142 <p>A function that will listen for error event on each worker.</p>
143 </div>
144 </div>
145 </section>
146 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
147 <a name="exithandler" class="tsd-anchor"></a>
148 <h3><span class="tsd-flag ts-flagOptional">Optional</span> exit<wbr>Handler</h3>
149 <div class="tsd-signature tsd-kind-icon">exit<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#exithandler" class="tsd-signature-type" data-tsd-kind="Type alias">ExitHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
150 <aside class="tsd-sources">
151 <ul>
849e0547 152 <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L85">src/pools/abstract-pool.ts:85</a></li>
5ea22628
JB		 153 </ul>
154 </aside>
155 <div class="tsd-comment tsd-typography">
156 <div class="lead">
157 <p>A function that will listen for exit event on each worker.</p>
158 </div>
159 </div>
160 </section>
161 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
162 <a name="onlinehandler" class="tsd-anchor"></a>
163 <h3><span class="tsd-flag ts-flagOptional">Optional</span> online<wbr>Handler</h3>
164 <div class="tsd-signature tsd-kind-icon">online<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#onlinehandler" class="tsd-signature-type" data-tsd-kind="Type alias">OnlineHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Worker</span><span class="tsd-signature-symbol">&gt;</span></div>
165 <aside class="tsd-sources">
166 <ul>
849e0547 167 <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L81">src/pools/abstract-pool.ts:81</a></li>
5ea22628
JB		 168 </ul>
169 </aside>
170 <div class="tsd-comment tsd-typography">
171 <div class="lead">
172 <p>A function that will listen for online event on each worker.</p>
173 </div>
174 </div>
175 </section>
176 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
177 <a name="workerchoicestrategy" class="tsd-anchor"></a>
178 <h3><span class="tsd-flag ts-flagOptional">Optional</span> worker<wbr>Choice<wbr>Strategy</h3>
179 <div class="tsd-signature tsd-kind-icon">worker<wbr>Choice<wbr>Strategy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;ROUND_ROBIN&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;LESS_RECENTLY_USED&quot;</span></div>
180 <aside class="tsd-sources">
181 <ul>
849e0547 182 <li>Defined in <a href="https://github.com/pioardi/poolifier/blob/36b71cf/src/pools/abstract-pool.ts#L89">src/pools/abstract-pool.ts:89</a></li>
5ea22628
JB		 183 </ul>
184 </aside>
185 <div class="tsd-comment tsd-typography">
186 <div class="lead">
187 <p>The work choice strategy to use in this pool.</p>
188 </div>
189 </div>
190 </section>
191 </section>
192 </div>
193 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
194 <nav class="tsd-navigation primary">
195 <ul>
196 <li class=" ">
197 <a href="../index.html">Exports</a>
198 </li>
199 </ul>
200 </nav>
201 <nav class="tsd-navigation secondary menu-sticky">
202 <ul class="before-current">
203 <li class=" tsd-kind-class tsd-has-type-parameter">
204 <a href="../classes/abstractworker.html" class="tsd-kind-icon">Abstract<wbr>Worker</a>
205 </li>
206 <li class=" tsd-kind-class tsd-has-type-parameter">
207 <a href="../classes/clusterworker.html" class="tsd-kind-icon">Cluster<wbr>Worker</a>
208 </li>
209 <li class=" tsd-kind-class tsd-has-type-parameter">
210 <a href="../classes/dynamicclusterpool.html" class="tsd-kind-icon">Dynamic<wbr>Cluster<wbr>Pool</a>
211 </li>
212 <li class=" tsd-kind-class tsd-has-type-parameter">
213 <a href="../classes/dynamicthreadpool.html" class="tsd-kind-icon">Dynamic<wbr>Thread<wbr>Pool</a>
214 </li>
215 <li class=" tsd-kind-class tsd-has-type-parameter">
216 <a href="../classes/fixedclusterpool.html" class="tsd-kind-icon">Fixed<wbr>Cluster<wbr>Pool</a>
217 </li>
218 <li class=" tsd-kind-class tsd-has-type-parameter">
219 <a href="../classes/fixedthreadpool.html" class="tsd-kind-icon">Fixed<wbr>Thread<wbr>Pool</a>
220 </li>
221 <li class=" tsd-kind-class tsd-has-type-parameter">
222 <a href="../classes/threadworker.html" class="tsd-kind-icon">Thread<wbr>Worker</a>
223 </li>
224 <li class=" tsd-kind-interface">
225 <a href="clusterpooloptions.html" class="tsd-kind-icon">Cluster<wbr>Pool<wbr>Options</a>
226 </li>
227 <li class=" tsd-kind-interface tsd-has-type-parameter">
228 <a href="ipool.html" class="tsd-kind-icon">IPool</a>
229 </li>
230 <li class=" tsd-kind-interface">
231 <a href="iworker.html" class="tsd-kind-icon">IWorker</a>
232 </li>
233 </ul>
234 <ul class="current">
235 <li class="current tsd-kind-interface tsd-has-type-parameter">
236 <a href="pooloptions.html" class="tsd-kind-icon">Pool<wbr>Options</a>
237 <ul>
7c0ba920
JB		 238 <li class=" tsd-kind-property tsd-parent-kind-interface">
239 <a href="pooloptions.html#enableevents" class="tsd-kind-icon">enable<wbr>Events</a>
240 </li>
5ea22628
JB		 241 <li class=" tsd-kind-property tsd-parent-kind-interface">
242 <a href="pooloptions.html#errorhandler" class="tsd-kind-icon">error<wbr>Handler</a>
243 </li>
244 <li class=" tsd-kind-property tsd-parent-kind-interface">
245 <a href="pooloptions.html#exithandler" class="tsd-kind-icon">exit<wbr>Handler</a>
246 </li>
247 <li class=" tsd-kind-property tsd-parent-kind-interface">
248 <a href="pooloptions.html#onlinehandler" class="tsd-kind-icon">online<wbr>Handler</a>
249 </li>
250 <li class=" tsd-kind-property tsd-parent-kind-interface">
251 <a href="pooloptions.html#workerchoicestrategy" class="tsd-kind-icon">worker<wbr>Choice<wbr>Strategy</a>
252 </li>
253 </ul>
254 </li>
255 </ul>
256 <ul class="after-current">
257 <li class=" tsd-kind-interface">
258 <a href="workeroptions.html" class="tsd-kind-icon">Worker<wbr>Options</a>
259 </li>
260 <li class=" tsd-kind-type-alias tsd-has-type-parameter">
261 <a href="../index.html#errorhandler" class="tsd-kind-icon">Error<wbr>Handler</a>
262 </li>
263 <li class=" tsd-kind-type-alias tsd-has-type-parameter">
264 <a href="../index.html#exithandler" class="tsd-kind-icon">Exit<wbr>Handler</a>
265 </li>
266 <li class=" tsd-kind-type-alias">
267 <a href="../index.html#killbehavior" class="tsd-kind-icon">Kill<wbr>Behavior</a>
268 </li>
269 <li class=" tsd-kind-type-alias tsd-has-type-parameter">
270 <a href="../index.html#onlinehandler" class="tsd-kind-icon">Online<wbr>Handler</a>
271 </li>
272 <li class=" tsd-kind-type-alias">
273 <a href="../index.html#threadworkerwithmessagechannel" class="tsd-kind-icon">Thread<wbr>Worker<wbr>With<wbr>Message<wbr>Channel</a>
274 </li>
275 <li class=" tsd-kind-type-alias">
276 <a href="../index.html#workerchoicestrategy" class="tsd-kind-icon">Worker<wbr>Choice<wbr>Strategy</a>
277 </li>
278 <li class=" tsd-kind-variable">
279 <a href="../index.html#killbehaviors" class="tsd-kind-icon">Kill<wbr>Behaviors</a>
280 </li>
281 <li class=" tsd-kind-variable">
282 <a href="../index.html#workerchoicestrategies" class="tsd-kind-icon">Worker<wbr>Choice<wbr>Strategies</a>
283 </li>
284 </ul>
285 </nav>
286 </div>
287 </div>
288</div>
289<footer class="with-border-bottom">
290 <div class="container">
291 <h2>Legend</h2>
292 <div class="tsd-legend-group">
293 <ul class="tsd-legend">
294 <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
295 <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
296 </ul>
297 <ul class="tsd-legend">
298 <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
299 <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
300 </ul>
301 <ul class="tsd-legend">
302 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
303 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
304 </ul>
305 <ul class="tsd-legend">
306 <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
307 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
308 </ul>
309 <ul class="tsd-legend">
310 <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
311 </ul>
312 </div>
313 </div>
314</footer>
315<div class="container tsd-generator">
316 <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
317</div>
318<div class="overlay"></div>
319<script src="../assets/js/main.js"></script>
320</body>
321</html>
Fast and small Node.js thread pool implementation mirror - https://github.com/poolifier/poolifier