Skip to content

Minor document change for lua plugin #11322

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

Merged
shukitchan merged 2 commits into from
May 6, 2024
Merged

Minor document change for lua plugin #11322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5be821f
Minor document change for lua plugin
shukitchan May 4, 2024
389fa00
Update lua.en.rst
shukitchan May 4, 2024
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
10 changes: 6 additions & 4 deletions doc/admin-guide/plugins/lua.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,8 +727,8 @@ ts.ctx

**context:** do_remap/do_os_response or do_global_* or later

**description:** This table can be used to store per-request Lua context data and has a life time identical to the
current request.
**description:** This table can be used to store data in do_remap/do_os_response or do_global_* functions and can be
retrieved from handler functions hooked from these global functions.

Here is an example:

Expand Down Expand Up @@ -2179,17 +2179,19 @@ ts.server_request.server_addr.set_outgoing_addr
-----------------------------------------------
**syntax:** *ts.server_request.server_addr.set_outgoing_addr()*

**context:** earlier than or inside function @ TS_LUA_HOOK_SEND_REQUEST_HDR hook point
**context:** earlier than or inside function @ TS_LUA_HOOK_POST_REMAP hook point

**description**: This function can be used to set outgoing socket address for the request to origin.

The ts.server_request.server_addr.set_outgoing_addr function requires three inputs, ip is a string, port and family is number.

This will not be effective if called in the hook for sending request headers.

Here is an example:

::

function do_global_send_request()
function do_global_post_remap()
ts.server_request.server_addr.set_outgoing_addr("192.168.231.17", 80, TS_LUA_AF_INET)
end

Expand Down