1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>JSDoc: Module: ipc</title>
|
6 |
|
7 | <script src="scripts/prettify/prettify.js"> </script>
|
8 | <script src="scripts/prettify/lang-css.js"> </script>
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
14 | </head>
|
15 |
|
16 | <body>
|
17 |
|
18 | <div id="main">
|
19 |
|
20 | <h1 class="page-title">Module: ipc</h1>
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | <section>
|
28 |
|
29 | <header>
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
|
35 | </header>
|
36 |
|
37 | <article>
|
38 | <div class="container-overview">
|
39 |
|
40 |
|
41 | <div class="description"><p>Provides basic interprocess signalling. A script running in a node.js
|
42 | process may wait on a signal sent by another script running in the same
|
43 | or another process.</p></div>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 | <dl class="details">
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 |
|
94 |
|
95 |
|
96 | </dl>
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 | </div>
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 | <h3 class="subsection-title">Methods</h3>
|
135 |
|
136 |
|
137 |
|
138 |
|
139 |
|
140 |
|
141 |
|
142 | <h4 class="name" id=".clearSignals"><span class="type-signature">(static) </span>clearSignals<span class="signature">()</span><span class="type-signature"></span></h4>
|
143 |
|
144 |
|
145 |
|
146 |
|
147 |
|
148 |
|
149 | <div class="description">
|
150 | <p>Clears all previously sent signals</p>
|
151 | </div>
|
152 |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 |
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 | <dl class="details">
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 |
|
180 |
|
181 |
|
182 |
|
183 |
|
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 | </dl>
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 |
|
221 |
|
222 |
|
223 | <h4 class="name" id=".once"><span class="type-signature">(static) </span>once<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 | <div class="description">
|
231 | <p>Resolves once when a signal is sent</p>
|
232 | </div>
|
233 |
|
234 |
|
235 |
|
236 |
|
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 | <dl class="details">
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 |
|
259 |
|
260 |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 |
|
270 |
|
271 |
|
272 |
|
273 |
|
274 |
|
275 |
|
276 |
|
277 |
|
278 |
|
279 | </dl>
|
280 |
|
281 |
|
282 |
|
283 |
|
284 |
|
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 |
|
293 | <h5>Returns:</h5>
|
294 |
|
295 |
|
296 | <div class="param-desc">
|
297 | <p>A promise which is resolved when the signal is sent</p>
|
298 | </div>
|
299 |
|
300 |
|
301 |
|
302 | <dl>
|
303 | <dt>
|
304 | Type
|
305 | </dt>
|
306 | <dd>
|
307 |
|
308 | <span class="param-type">Promise</span>
|
309 |
|
310 |
|
311 | </dd>
|
312 | </dl>
|
313 |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 |
|
326 | <h4 class="name" id=".send"><span class="type-signature">(static) </span>send<span class="signature">(signal)</span><span class="type-signature"></span></h4>
|
327 |
|
328 |
|
329 |
|
330 |
|
331 |
|
332 |
|
333 | <div class="description">
|
334 | <p>Sends a signal</p>
|
335 | </div>
|
336 |
|
337 |
|
338 |
|
339 |
|
340 |
|
341 |
|
342 |
|
343 |
|
344 |
|
345 | <h5>Parameters:</h5>
|
346 |
|
347 |
|
348 | <table class="params">
|
349 | <thead>
|
350 | <tr>
|
351 |
|
352 | <th>Name</th>
|
353 |
|
354 |
|
355 | <th>Type</th>
|
356 |
|
357 |
|
358 |
|
359 |
|
360 |
|
361 | <th class="last">Description</th>
|
362 | </tr>
|
363 | </thead>
|
364 |
|
365 | <tbody>
|
366 |
|
367 |
|
368 | <tr>
|
369 |
|
370 | <td class="name"><code>signal</code></td>
|
371 |
|
372 |
|
373 | <td class="type">
|
374 |
|
375 |
|
376 | <span class="param-type">String</span>
|
377 |
|
378 |
|
379 |
|
380 | </td>
|
381 |
|
382 |
|
383 |
|
384 |
|
385 |
|
386 | <td class="description last"><p>Name of the signal to send.</p></td>
|
387 | </tr>
|
388 |
|
389 |
|
390 | </tbody>
|
391 | </table>
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 | <dl class="details">
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 |
|
410 |
|
411 |
|
412 |
|
413 |
|
414 |
|
415 |
|
416 |
|
417 |
|
418 |
|
419 |
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 |
|
430 |
|
431 | </dl>
|
432 |
|
433 |
|
434 |
|
435 |
|
436 |
|
437 |
|
438 |
|
439 |
|
440 |
|
441 |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 |
|
447 |
|
448 |
|
449 |
|
450 |
|
451 |
|
452 |
|
453 |
|
454 |
|
455 |
|
456 | </article>
|
457 |
|
458 | </section>
|
459 |
|
460 |
|
461 |
|
462 |
|
463 | </div>
|
464 |
|
465 | <nav>
|
466 | <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-authn.html">authn</a></li><li><a href="module-bigIqLicenseProviderFactory.html">bigIqLicenseProviderFactory</a></li><li><a href="module-cryptoUtil.html">cryptoUtil</a></li><li><a href="module-httpUtil.html">httpUtil</a></li><li><a href="module-ipc.html">ipc</a></li><li><a href="module-localCryptoUtil.html">localCryptoUtil</a></li><li><a href="module-localKeyUtil.html">localKeyUtil</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-metricsCollector.html">metricsCollector</a></li><li><a href="module-sharedConstants.html">sharedConstants</a></li><li><a href="module-signals.html">signals</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="BigIp.html">BigIp</a></li><li><a href="BigIpCluster.html">BigIpCluster</a></li><li><a href="BigIpGtm.html">BigIpGtm</a></li><li><a href="BigIpOnboard.html">BigIpOnboard</a></li><li><a href="BigIq.html">BigIq</a></li><li><a href="BigIq50LicenseProvider.html">BigIq50LicenseProvider</a></li><li><a href="BigIq52LicenseProvider.html">BigIq52LicenseProvider</a></li><li><a href="BigIq53LicenseProvider.html">BigIq53LicenseProvider</a></li><li><a href="BigIq54LicenseProvider.html">BigIq54LicenseProvider</a></li><li><a href="CloudProvider.html">CloudProvider</a></li><li><a href="DnsProvider.html">DnsProvider</a></li><li><a href="GenericNodeProvider.html">GenericNodeProvider</a></li><li><a href="GtmDnsProvider.html">GtmDnsProvider</a></li><li><a href="IControl.html">IControl</a></li></ul><h3>Mixins</h3><ul><li><a href="bigIqClusterMixins.html">bigIqClusterMixins</a></li><li><a href="bigIqOnboardMixins.html">bigIqOnboardMixins</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkTask">checkTask</a></li><li><a href="global.html#forceResetUserPassword">forceResetUserPassword</a></li><li><a href="global.html#getDataFromPropPath">getDataFromPropPath</a></li><li><a href="global.html#getLicenseProvider">getLicenseProvider</a></li></ul>
|
467 | </nav>
|
468 |
|
469 | <br class="clear">
|
470 |
|
471 | <footer>
|
472 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
473 | </footer>
|
474 |
|
475 | <script> prettyPrint(); </script>
|
476 | <script src="scripts/linenumber.js"> </script>
|
477 | </body>
|
478 | </html> |
\ | No newline at end of file |