Skip to content

Commit 6dab801

Browse files
committed
lib-lua: Extend lib-lua C-API documentation
1 parent 3402bcb commit 6dab801

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

docs/core/admin/lua/lib_lua.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,25 @@ When script is being unloaded, `script_deinit()` function is called, if found.
4949

5050
## C API
5151

52+
### `struct event *dlua_check_event(lua_State *L, int arg)`
53+
54+
Check the argument with index `arg` from stack and try to convert
55+
it to an Dovecot Event. Throws an error of the argument is no valid
56+
Dovecot Event.
57+
5258
### `void dlua_dovecot_register(struct dlua_script *script)`
5359

5460
Register dovecot variable. This item can also be extended by context specific
5561
tables, like authentication database adds `dovecot.auth`.
5662

57-
### `void dlua_push_event(struct event *event)`
63+
### `void dlua_push_event(lua_State *L, struct event *event)`
5864

5965
Pushes an Dovecot Event to stack.
6066

67+
### `void dlua_push_timeval(lua_State *L, const struct timeval *tv)`
68+
69+
Pushes an timeval struct to stack as integer.
70+
6171
## Lua API
6272

6373
### Base Functions

0 commit comments

Comments
 (0)