COSTIMEREVENT_TIMEREVENTHANDLER(3erl)

✨ NAME ✨

CosTimerEvent_TimerEventHandler — bestie, this module is the whole implementation of the OMG CosTimerEvent::TimerEventHandler interface. that's it, that's the name, iconic 💅

---

🦋 DESCRIPTION 🦋

okay so before you can even look at the record definitions for the structures, you gotta pull them in like this:

-include_lib("cosTime/include/*.hrl").

that's the entry fee. no include, no records, no vibes. 🎀

---

👑 EXPORTS 👑

🌸 '_get_status'(TimerEventHandler) -> Reply

Types:

TimerEventHandler = #objref
Reply = 'ESTimeSet' | 'ESTimeCleared' | 'ESTriggered' | 'ESFailedTrigger'

this op literally just hands you back the status of the target object. no notes. here's the tea on each possible reply:

• 'ESTimeSet' — the timer is set and it will trigger event(s). she's ready. 💖
• 'ESTimeCleared' — either no time was ever set, or the timer got reset. nothing pending, bestie.
• 'ESTriggered' — the event has already been sent. done. ate. ✨
• 'ESFailedTrigger' — it tried to send the event and it failed. it's giving 😭 energy fr fr.

heads up: if the target object is of type 'TTPeriodic', then the status value 'ESTriggered' is not valid. don't come for me, that's just how it is 🫶

---

🌸 time_set(TimerEventHandler) -> Reply

Types:

TimerEventHandler = #objref
Reply = {boolean(), UTO}
UTO = #objref

this one returns true if the time has actually been set for an event that hasn't been triggered yet — and false if it hasn't. the outparameter is the current time value of the target object. so like, a boolean and a lil time receipt. obsessed. 🌈

---

🌸 set_timer(TimerEventHandler, TimeType, TriggerTime) -> void()

Types:

TimerEventHandler = #objref
TimeType = 'TTAbsolute' | 'TTRelative' | 'TTPeriodic'
TriggerTime = UTO
UTO = #objref

this operation terminates any previously set trigger (bye bestie 👋) and sets a brand new trigger, specified by the TimeType and the UTO objects. and now the important part — the relationship between the UTO object and the TimeTypes:

• 'TTAbsolute' — the UTO object must represent absolute time, i.e., the number of 100 nanoseconds passed since 15 october 1582 00:00. yes really, that specific. no cap. ⭐
• 'TTRelative' — the UTO object must represent the span from now until whenever the event should be triggered, e.g., within 30*10^7 nanoseconds.
• 'TTPeriodic' — same deal as 'TTRelative', BUT this option will trigger an event periodically until the timer gets cancelled. she keeps going. main character energy, she does not stop 💀

---

🌸 cancel_timer(TimerEventHandler) -> boolean()

Types:

TimerEventHandler = #objref

this operation cancels the triggering of event(s), if possible. it returns true if an event is actually cancelled, and false otherwise. so like, sometimes she can, sometimes she can't, and she'll tell you which 🙈

---

🌸 set_data(TimerEventHandler, EventData) -> ok

Types:

TimerEventHandler = #objref
EventData = #any

this operation changes the event data that gets sent when triggered. that's the whole thing. short, sweet, slays. 🍓

---

and that's the whole page, bestie!! this was Ericsson AB, cosTime 5.2.2, and if you peek at the footer it says CosTimerEv...ventHandler(3) — the name got cut off but we know who she is 💜 mwah, go set some timers, ily 🧚✨