All files mqtt-plus-timer.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
9x
9x
9x
9x
9x
1x
1x
1x
2112x
2112x
2112x
2112x
2x
2x
2x
2x
 
 
 
2112x
2112x
1x
1x
1x
45x
45x
42x
42x
42x
45x
 
 
/*
**  MQTT+ -- MQTT Communication Patterns
**  Copyright (c) 2018-2026 Dr. Ralf S. Engelschall <rse@engelschall.com>
**
**  Permission is hereby granted, free of charge, to any person obtaining
**  a copy of this software and associated documentation files (the
**  "Software"), to deal in the Software without restriction, including
**  without limitation the rights to use, copy, modify, merge, publish,
**  distribute, sublicense, and/or sell copies of the Software, and to
**  permit persons to whom the Software is furnished to do so, subject to
**  the following conditions:
**
**  The above copyright notice and this permission notice shall be included
**  in all copies or substantial portions of the Software.
**
**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
**  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
**  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
**  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
**  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
**  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
**  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
 
/*  internal requirements  */
import type { APISchema }     from "./mqtt-plus-api"
import { SubscriptionTrait }  from "./mqtt-plus-subscription"
import { ensureError }        from "./mqtt-plus-error"
 
/*  Timer trait with reusable timer management  */
export class TimerTrait<T extends APISchema = APISchema> extends SubscriptionTrait<T> {
    /*  internal state  */
    private timers = new Map<string, ReturnType<typeof setTimeout>>()
 
    /*  destroy timer trait  */
    override async destroy () {
        for (const timer of this.timers.values())
            clearTimeout(timer)
        this.timers.clear()
        await super.destroy()
    }
 
    /*  refresh (or start) a named timer  */
    protected timerRefresh (id: string, onTimeout: () => void | Promise<void>): void {
        const timer = this.timers.get(id)
        if (timer !== undefined)
            clearTimeout(timer)
        this.timers.set(id, setTimeout(async () => {
            this.timers.delete(id)
            try {
                await onTimeout()
            }
            catch (err: unknown) {
                this.error(ensureError(err), `timer "${id}" failed`)
            }
        }, this.options.timeout))
    }
 
    /*  clear a named timer  */
    protected timerClear (id: string): void {
        const timer = this.timers.get(id)
        if (timer !== undefined) {
            clearTimeout(timer)
            this.timers.delete(id)
        }
    }
}