代码拉取完成，页面将自动刷新
ngx_tcp_module - A tcp stream module for nginx.
ngx_tcp_lua_module - Embed the power of Lua into Nginx Servers. Work under tcp stream mode.
This module is not distributed with the Nginx source. See the installation instructions.
Production ready. This markdwon is in progress...
This document describes nginx tcp module v0.2.
# yum -y install -y pcre* openssl*
# for pcre, such as ngx.gmatch etc, --with-pcre=PATH/pcre-8.36 --with-pcre-jit
# if use openssl, then need --with-http_ssl_module
#
export LUAJIT_LIB=/usr/local/lib
export LUAJIT_INC=/usr/local/include/luajit-2.0
./configure --prefix=/usr/local/nginx_tcp \
--with-debug \
--with-pcre=/root/ngx_tcp_compile/softwares/pcre-8.36 \
--with-pcre-jit \
--without-http_gzip_module \
--with-http_stub_status_module \
--with-http_ssl_module \
--with-tcp \
--with-tcp_ssl_module \
--with-openssl=/opt/openssl-1.0.1e \
--with-openssl-opt=-g \
--add-module=src/tcp/ngx_tcp_log_module \
--add-module=src/tcp/ngx_tcp_demo_module \
--add-module=src/tcp/ngx_tcp_lua_module
wget http://luajit.org/download/LuaJIT-2.0.0.tar.gz
tar -xvfz LuaJIT-2.0.0.tar.gz
cd LuaJIT-2.0.0
make && make install
# tell nginx's build system where to find luajit:
export LUAJIT_LIB=/usr/local/lib
export LUAJIT_INC=/usr/local/include/luajit-2.0
# or tell where to find Lua
#export LUA_LIB=/path/to/lua/lib
#export LUA_INC=/path/to/lua/include
tcp {
#connection_pool_size 1k; #main/srv/take one/default 0.5k
session_pool_size 1k; #main/srv/take one/default 1k
client_max_body_size 1k; #main/srv/take one/default 1k;
read_timeout 60s; #main/srv/take one/default 60s
#send_timeout 60s; #main/srv/take one/default 60s
#keepalive_timeout 60; #main/srv/take one/no set,no keepalive_timeout
#error_log logs/error_tcp.log debug_tcp; #main/srv/take one more/default null
error_log logs/error_tcp.log info;
log_format token '$remote_addr $time_iso8601 $msec $request_time $connection $connection_requests $bytes_sent $protocol';
#default log_format combined '$remote_addr $time_iso8601 $msec $request_time $connection $connection_requests $protocol';
server {
listen 6666;
protocol demo;
#access_log off;
access_log logs/access_tcp.log token; #default access_log logs/access_tcp.log;
access_nlog 0.0.0.0:5002 0.0.0.0:5151;
allow 127.0.0.1;
deny all;
}
#server {
# listen 6433;
#
# protocol demo;
#
# #access_log off;
# access_log logs/access_tcp.log demo; #default access_log logs/access_tcp.log;
# access_nlog 0.0.0.0:5002 0.0.0.0:5151;
#
# ssl on;
# ssl_certificate xxx-chain.pem;
# ssl_certificate_key xxx-key.pem;
# ssl_session_timeout 5m;
# ssl_protocols SSLv2 SSLv3 TLSv1;
# ssl_ciphers HIGH:!aNULL:!MD5;
# ssl_prefer_server_ciphers on;
#}
}
tcp {
lua_package_path '/usr/local/nginx_tcp/conf/?.lua;/usr/local/nginx_tcp/conf/lua_module/?.lua;;';
lua_package_cpath '/usr/local/nginx_tcp/conf/lua_module/?.so;;';
lua_shared_dict db_lock 100m;
init_by_lua_file 'conf/init_by_lua.lua';
server {
listen 6666;
protocol tcp_lua;
process_by_lua_file 'conf/test.lua';
}
and for the test.lua, see example Code Exapmle for ngx_tcp_lua_module
Based on nginx-1.4.1, refer to nginx-http-lua, follow the principles of simple, efficient and highly extensible, the nginx-tcp module is designed as a customized stream protocol server, more than http, mail server. And the ngx_tcp_lua module is very useful in fast implement your own service.
nlog,access_nlog to send error_log,access_log to log server with udp.syntax: listen [ip:]port [backlog=number] [rcvbuf=size] [sndbuf=size] [deferred] [bind] [ssl] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];
default: listen *:0;
context: server
example:
listen 127.0.0.1:110;
listen *:110;
listen 110; # same as *:110
Sets the address and port for IP on which the server will accept requests. Only IPv4 supported now.
One server{} can have diffrent ip addresses. But one specified port only can be set in one server{}.
syntax: protocol protocol_name;
default: -;
context: server
example:
protocol demo;
protocol_name must be defined in an implemented module, such as ngx_tcp_demo_module. One server{} can only have one specified protocol_name.
syntax: read_timeout time;
default: 60s;
context: tcp,server
example:
read_timeout 60s;
Sets the timeout for read the whole protocol data.
syntax: send_timeout time;
default: 60s;
context: tcp,server
example:
send_timeout 60s;
Sets a timeout for transmitting a response to the client. The timeout is set only between two successive write operations, not for the transmission of the whole response. If the client does not receive anything within this time, the connection is closed.
syntax: keepalive_timeout time;
default: 6000s;
context: tcp,server
example:
send_timeout 6000s;
Sets a timeout during which a keep-alive client connection will stay open on the server side. The zero value disables keep-alive client connections. (TODO: enable never close client connection)
syntax: connection_pool_size size;
default: 0.5k;
context: tcp,server
example:
connection_pool_size 1k;
Allows accurate tuning of per-connection memory allocations. This directive has minimal impact on performance and should not generally be used.
syntax: session_pool_size size;
default: 1k;
context: tcp,server
example:
session_pool_size 1k;
Allows accurate tuning of per-session memory allocations. This directive has minimal impact on performance and should not generally be used. The optimal value is little larger than average receiving data length, so it can take full use of memory and minimum times of allocations.
syntax: client_max_body_size size;
default: 1k;
context: tcp,server
example:
client_max_body_size 1k;
Sets the maximum allowed size of the client request body, specified by protocol.
syntax: error_log file | stderr | [debug | info | notice | warn | error | crit | alert | emerg];
default: error_log logs/error.log error;
context: main,tcp,server
example:
error_log logs/error.log error;
#or in tcp{},server{} below:
error_log logs/error_tcp.log debug_tcp;
Configures logging. 'debug_tcp' can be used like 'debug_http'.
syntax: nlog local_ip:local_port remote_ip:remote_prot;
default: -;
context: main,tcp,server
example:
error_log logs/error.log error;
nlog 0.0.0.0:5001 0.0.0.0:5151; #nlog must set after error_log.
Configures ip address to support logging to UDP log server.
syntax: allow ip | all;
default: -;
context: tcp,server
example:
allow 127.0.0.1;
allow 127.0.0.0/24;
allow all;
Allows access for the specified network or address. The rules are checked in sequence until the first match is found.
syntax: deny ip | all;
default: -;
context: tcp,server
example:
deny 127.0.0.1;
deny 127.0.0.0/24;
deny all;
Denies access for the specified network or address. The rules are checked in sequence until the first match is found.
syntax: resolver address [valid=time];
default: -;
context: tcp,server
example:
resolver 127.0.0.1 8.8.8.8 valid=30s;;
Configures name servers used to resolve names of upstream servers into addresses. By default, nginx caches answers using the TTL value of a response. An optional valid parameter allows overriding it.
syntax: resolver time;
default: 30s;
context: tcp,server
example:
resolver_timeout 10s;
Sets a timeout for name resolution.
syntax: log_format name string ...;
default: combined '$remote_addr $time_iso8601 $msec $request_time $connection $connection_requests $protocol';
context: tcp,server
example:
log_format log1 '$remote_addr $time_iso8601 $msec $request_time $connection $connection_requests $bytes_sent $protocol';
Specifies log format.
The log format can contain common variables, and variables that exist only at the time of a log write:
$remote_addr
client ip address.
$time_local
local time in the Common Log Format, "28/Sep/1970:12:00:00 +0600".
$time_iso8601
local time in the ISO 8601 standard format, "1970-09-28T12:00:00+06:00".
$msec
time in seconds with a milliseconds resolution at the time of the log write.
$request_time
request processing time in seconds with a milliseconds resolution; time elapsed between the first bytes were read from the client and the log write after the last bytes were sent to the client.
$connection
connection serial number.
$connection_requests
the current number of requests made through a connection.
$bytes_sent
the number of bytes sent to a client.
$protocol
the current protocol name.
syntax: access_log path | off [format];
default: logs/access_tcp.log combined;
context: tcp,server
example:
access_log logs/access_tcp.log log1;
Sets the path, format for a buffered log write. Several logs can be specified on the same level.
syntax: access_nlog local_ip:local_port remote_ip:remote_prot;
default: -;
context: tcp,server
example:
access_log logs/access_tcp.log log1;
access_nlog 127.0.0.1:5002 127.0.0.1:5151;#access_nlog must set after access_log.
Configures ip address to support logging to UDP log server.
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
refer to http://nginx.org/en/docs/http/ngx_http_ssl_module.html
syntax: lua_package_cpath lua-style-cpath-str;
default: The content of LUA_CPATH environment variable or Lua's compiled-in defaults.;
context: tcp
example:
lua_package_cpath '/bar/baz/?.so;/blah/blah/?.so;;';
Sets the Lua C-module search path used by scripts specified by init_by_lua[_file], protocol_by_lua[_file]. The cpath string is in standard Lua cpath form, and ;; can be used to stand for the original cpath.
syntax: lua_package_path lua-style-path-str;
default: The content of LUA_PATH environ variable or Lua's compiled-in defaults.
context: tcp
example:
lua_package_path '/foo/bar/?.lua;/blah/?.lua;;'
Sets the Lua module search path used by scripts specified by init_by_lua[_file], protocol_by_lua[_file]. The path string is in standard Lua path form, and ;; can be used to stand for the original search paths.
syntax: lua_code_cache on | off;
default: The content of LUA_PATH environ variable or Lua's compiled-in defaults.
context: tcp,server
example:
lua_code_cache on;
Enables or disables the Lua code cache for Lua code in *_by_lua_file directives and Lua modules.
When turning off, every request served by ngx_lua will run in a separate Lua VM instance.
Disabling the Lua code cache is strongly discouraged for production use and should only be used during development as it has a significant negative impact on overall performance.
syntax: init_by_lua lua-script-str;
default: -
context: tcp
example:
init_by_lua 'a = require("a")';
Runs the Lua code specified by the argument on the global Lua VM level when the Nginx master process (if any) is loading the Nginx config file.
syntax: init_by_lua_file path-to-lua-script-file;
default: -
context: tcp
example:
init_by_lua_file 'conf/init_by_lua.lua';
Equivalent to init_by_lua, except that the file specified by contains the Lua code or Lua/LuaJIT bytecode to be executed.
syntax: process_by_lua lua-script-str;
default: -
context: server
example:
process_by_lua 'ngx.exit()';
Executes Lua code string specified in for requests of every connection. The Lua code may make API calls and is executed as a new spawned coroutine in an independent global environment (i.e. a sandbox).
syntax: process_by_lua_file path-to-lua-script-file;
default: -
context: server
example:
process_by_lua_file 'conf/test.lua';
Equivalent to process_by_lua, except that the file specified by contains the Lua code or Lua/LuaJIT bytecode to be executed.
syntax: lua_socket_connect_timeout time;
default: 60s;
context: tcp,server
example:
lua_socket_connect_timeout 5;
This directive controls the default timeout value used in tcp socket object's connect method and can be overridden by the settimeout method.
The
syntax: lua_socket_send_lowat size;
default: 0;
context: tcp,server
example:
lua_socket_send_lowat 0;
Controls the lowat (low water) value for the cosocket send buffer.
syntax: lua_socket_pool_size size;
default: 30;
context: tcp,server
example:
lua_socket_pool_size 10;
Specifies the size limit (in terms of connection count) for every cosocket connection pool associated with every remote server (i.e., identified by either the host-port pair).
When the connection pool exceeds the available size limit, the least recently used (idle) connection already in the pool will be closed to make room for the current connection.
Note that the cosocket connection pool is per nginx worker process rather than per nginx server instance, so size limit specified here also applies to every single nginx worker process.
syntax: lua_check_client_abort on|off;
default: off;
context: tcp,server
example:
lua_check_client_abort on;
This directive controls whether to check for premature client connection abortion.
syntax: lua_shared_dict name size;
default: -;
context: tcp
example:
lua_shared_dict dogs 10m;
Declares a shared memory zone, , to serve as storage for the shm based Lua dictionary ngx.shared..
Shared memory zones are always shared by all the nginx worker processes in the current nginx server instance.
The argument accepts size units such as k and m. At least 8k;
syntax: lua_regex_cache_max_entries num;
default: 1024;
context: tcp
example:
lua_shared_dict dogs 10m;
Specifies the maximum number of entries allowed in the worker process level compiled regex cache.
The regular expressions used in ngx.re.match, ngx.re.gmatch, ngx.re.sub, and ngx.re.gsub will be cached within this cache if the regex option o (i.e., compile-once flag) is specified.
syntax: lua_regex_match_limit num;
default: 0;
context: tcp
example:
lua_shared_dict dogs 10m;
Specifies the "match limit" used by the PCRE library when executing the ngx.re API. To quote the PCRE manpage, "the limit ... has the effect of limiting the amount of backtracking that can take place."
When the limit is hit, the error string "pcre_exec() failed: -8" will be returned by the ngx.re API functions on the Lua land.
When setting the limit to 0, the default "match limit" when compiling the PCRE library is used. And this is the default value of this directive.
syntax: demo_echo str;
default: -;
context: server
example:
demo_echo "hello world";
This directive is used for ngx_tcp_demo_module, which define a echo protocol. The request stream is 4 bytes head contains request data length. When demo_echo string set, the server will response 4 bytes head contains response data length, and demo_echo string. when this directive not set, the response body data is request body data.
local client_sock = ngx.socket.tcp()
client_sock:settimeout(5000,1000,3000)
local data = "hello world 1234567890"
local data_len = string.len(data)
local data_len_h = netutil.htonl(data_len)
local req_data = netutil.packint32(data_len_h) .. data
local upstream_test = function(u)
local ret,err = u:connect("127.0.0.1",8000,"127.0.0.1_8000_1");
local reuse = u:getreusedtimes()
ngx.log(ngx.INFO,"connect : "..tostring(ret).." "..tostring(err).." "..tostring(reuse))
if not ret then
return
end
ret,err = u:send(req_data)
ngx.log(ngx.INFO,"send : "..tostring(ret).." "..tostring(err))
if not ret then
return
end
local data,err = u:receive(4,nil)
if use_log then ngx.log(ngx.INFO,"receive : "..tostring(data).." "..tostring(err)) end
if not data then
return
end
local totoal_len = netutil.unpackint32(string.sub(data,1,4))
ngx.log(ngx.INFO,"totoal_len : "..tostring(totoal_len))
local data,err = u:receive(totoal_len - 4,nil)
ngx.log(ngx.INFO,"receive again: ["..tostring(data).."] "..tostring(err))
if not data then
return
end
if totoal_len - 4 ~= #data then
ngx.log(ngx.INFO,"receive len not match")
return
end
u:setkeepalive()
end
local test_shm = function()
local key = "x"
local value = "hello world"
local dogs = ngx.shared.db_lock
local shm_value = dogs:get(key)
if not shm_value then
local succ, err, forcible = dogs:set(key,value,10000)
ngx.log(ngx.INFO,tostring(succ)..","..tostring(err)..","..tostring(forcible))
end
local shm_value = dogs:get(key)
ngx.log(ngx.INFO,tostring(shm_value))
end
while true do
local data,r2,r3 = ngx.receive(10,6)
ngx.say("receive ret "..tostring(data).." "..tostring(r2).." "..tostring(r3) .. ","..collectgarbage("count"))
if not data then
ngx.say("exit")
ngx.exit()
end
--ngx.sleep(5)
--upstream_test(client_sock)
test_shm()
--collectgarbage()
ngx.wait_next_request()
end
The Nginx Lua API described below can only be called within the user Lua code run in the context of these configuration directives.
The API is exposed to Lua in the form of two standard packages ngx and ndk. These packages are in the default global scope within ngx_lua and are always available within ngx_lua directives.
Any way, lua exception will be thrown when something internal error occurs in APIs. Here are some common reason: out of memory, api calls in wrong context('no session found'), wrong arguments('expecting 1 or 2 arguments', 'expecting number parameter!', 'bad argument <= 0' etc).
syntax: send_bytes, err = ngx.say(...)
context: process_by_lua*
Just as ngx.print but also emit a trailing newline.
syntax: send_bytes, err = ngx.print(...)
context: process_by_lua*
arguments:
one or more lua variables inclue table, string, nil, number, boolean and `ngx.null`. table is array table incule other variable types.
returns: send_bytes, err possiable values:
nil, "closed" #failed, invalid socket, or client closed. nil, "will send nothing" #failed, nothing to send nil, "EAGAIN error" #failed, network errors. *number*, nil #success, *number* is send bytes.
example:
local send_bytes, err = ngx.print("hello world",21,nil,true,false,{"a","b"})
--output: hello world21niltruefalseab
Emits arguments concatenated to the client as response body.
syntax: data, err, partial = ngx.receive(totoal-size, at-least-size)
context: process_by_lua*
arguments:
totoal-size : positive integer, bytes expected receive. at-least-size : positive integer between(include) 1 and totoal-size.
returns: data, err, partial possiable values:
nil, error string, partial received data #failed, read timedout, network errors, client closed etc.string, nil, nil #success
example:
Receives data from the client socket according to the reading pattern or size.
This method is a synchronous operation and is 100% onblocking.
at-least-size is designed to parse uncertain length protocol, such as read a line.
syntax: ngx.wait_next_request()
context: process_by_lua*
arguments: [no]
returns: [no]
example:
while true do
--process request
--...
ngx.wait_next_request()
end
This method separate each request in one connection, reset read/write buffer, set connection into idle state. This method is a synchronous operation and is 100% nonblocking. It will return in a new request arrival, or exit lua code when keepalive timedout.
syntax: ngx.exit()
context: process_by_lua*
arguments: [no]
returns: [no]
example:
This method will exit from lua code, and close current client connection.
syntax: ngx.sleep(time-of-seconds)
context: process_by_lua*
arguments:
time-of-seconds : sleeps for the specified seconds without blocking. One can specify time resolution up to 0.001 seconds (i.e., one milliseconds).
returns: [no]
example:
ngx.sleep(1.5)
syntax: str = ngx.utctime()
context: init_by_lua*, process_by_lua*
arguments: [no]
returns:
str : current time stamp (in the format yyyy-mm-dd hh:mm:ss) of the nginx cached time (no syscall involved unlike Lua's os.date function).
example:
This is the UTC time.
syntax: str = ngx.localtime()
context: init_by_lua*, process_by_lua*
arguments: [no]
returns:
str : Returns the current time stamp (in the format yyyy-mm-dd hh:mm:ss) of the nginx cached time (no syscall involved unlike Lua's os.date function).
example:
This is the local time.
syntax: secs = ngx.time()
context: init_by_lua*, process_by_lua*
arguments: [no]
returns:
secs : Returns the elapsed seconds from the epoch for the current time stamp from the nginx cached time (no syscall involved unlike Lua's date library).
example:
Updates of the Nginx time cache an be forced by calling ngx.update_time first.
syntax: secs = ngx.now()
context: init_by_lua*, process_by_lua*
arguments: [no]
returns:
secs : Returns a floating-point number for the elapsed time in seconds (including milliseconds as the decimal part) from the epoch for the current time stamp from the nginx cached time (no syscall involved unlike Lua's date library).
example:
Updates of the Nginx time cache an be forced by calling ngx.update_time first.
syntax: str = ngx.today()
context: init_by_lua*, process_by_lua*
arguments: [no]
returns:
str : Returns current date (in the format yyyy-mm-dd) from the nginx cached time (no syscall involved unlike Lua's date library).
example:
This is the local time.
syntax: str = ngx.tcp_time(sec)
context: init_by_lua*, process_by_lua*
arguments:
sec: time stamp in seconds (like those returned from ngx.time).
returns:
str : Returns a formated string can be used as the http header time.
example:
ngx.say(ngx.http_time(1290079655))
-- yields "Thu, 18 Nov 2010 11:27:35 GMT"
syntax: sec = ngx.parse_http_time(str)
context: init_by_lua*, process_by_lua*
arguments:
str : A formated string can be used as the http header time.
returns:
sec: time stamp in seconds (like those returned from ngx.time).
example:
local time = ngx.parse_http_time("Thu, 18 Nov 2010 11:27:35 GMT")
if time == nil then
...
end
Parse the http time string (as returned by ngx.http_time) into seconds. Returns the seconds or nil if the input string is in bad forms.
syntax: ngx.update_time()
context: init_by_lua*, process_by_lua*
arguments: [no]
returns: [no]
example:
Forcibly updates the Nginx current time cache. This call involves a syscall and thus has some overhead, so do not abuse it.
syntax: secs =ngx.start_time()
context: process_by_lua*
arguments: [no]
returns:
A floating-point number representing the timestamp (including milliseconds as the decimal part) when the current request was created.
example:
syntax: tcpsock = ngx.socket.tcp()
context: process_by_lua*
arguments: [no]
returns:
tcpsock: Creates and returns a TCP object (also known as one type of the "cosocket" objects).
example:
The following methods are supported on this object:
It is intended to be compatible with the TCP API of the LuaSocket library but is 100% nonblocking out of the box. Also, we introduce some new APIs to provide more functionalities.
The cosocket object created by this API function has exactly the same lifetime as the Lua handler creating it. So never pass the cosocket object to any other Lua handler (including ngx.timer callback functions) and never share the cosocket object between different NGINX requests.
For every cosocket object's underlying connection, if you do not explicitly close it (via close) or put it back to the connection pool (via setkeepalive), then it is automatically closed when one of the following two events happens:
Fatal errors in cosocket operations always automatically close the current connection (note that, read timeout error is the only error that is not fatal), and if you call close on a closed connection, you will get the "closed" error.
After create cosocket, the default connect timedout is value set by lua_socket_connect_timeout, default send timedout is value set by send_timeout, default read timedout is value set by read_timeout. And it can be changed by tcpsock:settimeout in any time.
syntax: ok, err = tcpsock:connect(host, port, pool_name)
context: process_by_lua*
arguments:
host: string type, need ip or domain name port: numebr type, [0,65536] pool_name: specify a custom name for the connection pool being used. If omitted, then the connection pool name will be generated from the string template "<host>:<port>"
returns: ok, err possiable values:
1,nil : connect ok. nil,<error msg> : failed.
example:
local ok,err = tcpsock:connect("127.0.0.1", 80, "httphost")
Calling this method on an already connected socket object will cause the original connection to be closed first.
syntax: ok, err = tcpsock:sslhandshake()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:receive()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:receive_http()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:send()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:close()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:setoption()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:settimeout()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:getreusedtimes()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = tcpsock:setkeepalive()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = ngx.new_ssl_ctx()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = ngx.log()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = ngx.print()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = ngx.nlog()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: ok, err = nlog:send()
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxrefind
syntax: captures, err = ngx.re.match(subject, regex, options?, ctx?, res_table?)
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
local m, err = ngx.re.match("hello, 1234", "[0-9]+")
if m then
-- m[0] == "1234"
else
if err then
ngx.log(ngx.ERR, "error: ", err)
return
end
ngx.say("match not found")
end
local m, err = ngx.re.match("hello, 1234", "([0-9])[0-9]+")
-- m[0] == "1234"
-- m[1] == "1"
Matches the subject string using the Perl compatible regular expression regex with the optional options.
Only the first occurrence of the match is returned, or nil if no match is found. In case of errors, like seeing a bad regular expression or exceeding the PCRE stack limit, nil and a string describing the error will be returned.
When a match is found, a Lua table captures is returned, where captures[0] holds the whole substring being matched, and captures[1] holds the first parenthesized sub-pattern's capturing, captures[2] the second, and so on.
syntax: iterator, err = ngx.re.gmatch(subject, regex, options?)
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: iterator, err = ngx.re.sub(subject, regex, options?)
context: process_by_lua*
arguments:
returns: ok, err possiable values:
example:
syntax: iterator, err = ngx.re.gsub(subject, regex, options?)
context: process_by_lua*
arguments:
returns: iterator, err possiable values:
example:
syntax: iterator, err = ngx.re.gsub(subject, regex, options?)
context: process_by_lua*
arguments:
returns: iterator, err possiable values:
example:
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxdecode_base64
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxencode_base64
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxmd5_bin
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxmd5
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxsha1_bin
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxcrc32_short
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxcrc32_long
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxhmac_sha1
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxescape_uri
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxquote_sql_str
Fetching the shm-based Lua dictionary object for the shared memory zone named DICT defined by the lua_shared_dict directive.
Shared memory zones are always shared by all the nginx worker processes in the current nginx server instance.
The resulting object dict has the following methods:
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictget
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictget_stale
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictset
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictsafe_set
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictadd
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictsafe_add
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictreplace
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictdelete
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictincr
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictflush_all
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictflush_expired
refer to https://github.com/openresty/lua-nginx-module/blob/master/README.markdown#ngxshareddictget_keys
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型