Skip to content

Clarify ngx.timer.every callback argument conventions #1409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Clarify ngx.timer.every callback argument conventions #1409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7977,6 +7977,9 @@ Similar to the [ngx.timer.at](#ngxtimerat) API function, but
1. `delay` *cannot* be zero,
1. timer will be created every `delay` seconds until the current Nginx worker process starts exiting.

Like [ngx.timer.at](#ngxtimerat), the `callback` argument will be called
automatically with the arguments `premature`, `user_arg1`, `user_arg2`, etc.
Copy link
Member

@thibaultcha thibaultcha Nov 2, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not edit this file directly. Instead, make your edits to the HttpLuaModule.wiki file, and generate the README file with the wiki2markdown.pl utility.


When success, returns a "conditional true" value (but not a `true`). Otherwise, returns a "conditional false" value and a string describing the error.

This API also respect the [lua_max_pending_timers](#lua_max_pending_timers) and [lua_max_running_timers](#lua_max_running_timers).
Expand Down