From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Tue, 1 Apr 2025 08:37:08 +0000 (+0200)
Subject: MINOR: hlua_fcn: add Queue:alarm()
X-Git-Tag: v3.2-dev10~21
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=976890edda6cfe4393683c5824712c61fe1f2650;p=thirdparty%2Fhaproxy.git

MINOR: hlua_fcn: add Queue:alarm()

Queue:alarm() sets a wakeup alarm on the task when new data becomes
available on Queue. It must be re-armed for each event.

Lua documentation was updated
---

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index a283da10a..a1261f648 100644
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -1882,6 +1882,17 @@ Queue class
 
   Use :js:func:`core.queue` to get a new Queue object.
 
+.. js:function:: Queue.alarm()
+
+  **context**: task, action, service
+
+  Sets a wakeup alarm on the current Lua context so that when new data
+  becomes available on the Queue, the current Lua context is woken up
+  automatically. It can be combined with :js:func:`core.wait` to wait
+  for Queue events.
+
+  :param class_queue queue: A :ref:`queue_class` to the current queue
+
 .. js:function:: Queue.size(queue)
 
   This function returns the number of items within the Queue.
diff --git a/src/hlua_fcn.c b/src/hlua_fcn.c
index 6d3d6696d..0b84f45e1 100644
--- a/src/hlua_fcn.c
+++ b/src/hlua_fcn.c
@@ -537,6 +537,32 @@ static int hlua_queue_size(lua_State *L)
 	return 1;
 }
 
+/* queue:alarm(): (re)arms queue waiting alarm so that the current
+ * Lua task is woken up on new queue events
+ */
+static int hlua_queue_alarm(lua_State *L)
+{
+	struct hlua_queue *queue = hlua_check_queue(L, 1);
+
+	struct hlua *hlua;
+
+	BUG_ON(!queue);
+
+	/* Get hlua struct, or NULL if we execute from main lua state */
+	hlua = hlua_gethlua(L);
+
+	if (!hlua || HLUA_CANT_YIELD(hlua)) {
+		luaL_error(L, "alarm() may only be used within task context "
+			      "(requires yielding)");
+		return 0; /* not reached */
+	}
+
+	if (!notification_new_mt(&hlua->com, &queue->wait_tasks, hlua->task))
+		luaL_error(L, "out of memory");
+
+	return 0;
+}
+
 /* queue:push(): push an item (any type, except nil) at the end of the queue
  *
  * Returns boolean:true for success and boolean:false on error
@@ -701,6 +727,7 @@ static int hlua_queue_new(lua_State *L)
 	hlua_class_function(L, "pop", hlua_queue_pop);
 	hlua_class_function(L, "pop_wait", hlua_queue_pop_wait);
 	hlua_class_function(L, "push", hlua_queue_push);
+	hlua_class_function(L, "alarm", hlua_queue_alarm);
 
 	return 1;
 }