EMILUA(3em)

EMILUA(3em) 💖

okay bestie, welcome to the Emilua reference manual — this is the EMILUA(3em) page, and it's giving steady_timer main character energy. iykyk ✨

---

🌸 NAME 🌸

Emilua — Lua execution engine. periodt.

---

✨ DESCRIPTION ✨

local timer = require('time').steady_timer
local t = timer.new()

spawn(function() print('Hello') end)

t:expires_after(2) --< 2 seconds
t:wait()
print('World')

It's a monotonic timer (i.e. the time points of the underlying clock cannot decrease as physical time moves forward). As in Boost.Asio (https://www.boost.org/doc/libs/1_66_0/doc/html/boost_asio/reference/steady_timer.html):

A waitable timer is always in one of two states: "expired" or "not expired". If the wait() or async_wait() function is called on an expired timer, the wait operation will complete immediately. Changing an active waitable timer’s expiry time Changing the expiry time of a timer while there are pending asynchronous waits causes those wait operations to be cancelled.

---

🎀 FUNCTIONS 🎀

new() → steady_timer

local t = steady_timer.new()

Constructor. Returns a new steady_timer object. slay 💅

expires_at(self, tp: time.steady_clock.time_point) → integer

Forward the call to the Boost.Asio function with the same name (https://www.boost.org/doc/libs/1_66_0/doc/html/boost_asio/reference/basic_waitable_timer/expires_at.html):

Set the timer’s expiry time as an absolute time. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the boost::asio::error::operation_aborted error code. Return Value The number of asynchronous operations that were cancelled.

expires_after(self, secs: number) → integer

Forward the call to the Boost.Asio function with the same name (https://www.boost.org/doc/libs/1_66_0/doc/html/boost_asio/reference/basic_waitable_timer/expires_after.html):

Set the timer’s expiry time relative to now. Any pending asynchronous wait operations will be cancelled. The handler for each cancelled operation will be invoked with the boost::asio::error::operation_aborted error code. Return Value The number of asynchronous operations that were cancelled.

Expiry time is given in seconds. 🍓

wait(self)

Initiate a wait operation on the timer and block the current fiber until one of these events occurs:

• The timer has expired.
• The timer was cancelled, in which case it raises boost::asio::error::operation_aborted.

cancel(self) → integer

Cancel any operations that are waiting on the timer. Returns the number of asynchronous operations that were cancelled.

---

👑 PROPERTIES 👑

expiry: time.steady_clock.time_point

The timer’s expiry time as an absolute time.

Whether the timer has expired or not does not affect this value.

---

mwah 💋 — source/version: Emilua 0.12.1-nixpkgs1; date: 1980-01-01; page: EMILUA(3em). xoxo, your Unix bestie 🫶