客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
开源软件名称（OpenSource Name）：openresty/stream-lua-nginx-module开源软件地址(OpenSource Url)：https://github.com/openresty/stream-lua-nginx-module开源编程语言(OpenSource Language)：C 93.9%开源软件介绍(OpenSource Introduction)：Namengx_stream_lua_module - Embed the power of Lua into Nginx stream/TCP Servers. This module is a core component of OpenResty. If you are using this module, then you are essentially using OpenResty. This module is not distributed with the Nginx source. See the installation instructions. Table of Contents
StatusProduction ready. VersionThis document describes ngx_stream_lua v0.0.8, which was released on 2 July, 2020. Synopsisevents {
worker_connections 1024;
}
stream {
# define a TCP server listening on the port 1234:
server {
listen 1234;
content_by_lua_block {
ngx.say("Hello, Lua!")
}
}
}Set up as an SSL TCP server: stream {
server {
listen 4343 ssl;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
ssl_ciphers AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5;
ssl_certificate /path/to/cert.pem;
ssl_certificate_key /path/to/cert.key;
ssl_session_cache shared:SSL:10m;
ssl_session_timeout 10m;
content_by_lua_block {
local sock = assert(ngx.req.socket(true))
local data = sock:receive() -- read a line from downstream
if data == "thunder!" then
ngx.say("flash!") -- output data
else
ngx.say("boom!")
end
ngx.say("the end...")
}
}
}Listening on a UNIX domain socket is also supported: stream {
server {
listen unix:/tmp/nginx.sock;
content_by_lua_block {
ngx.say("What's up?")
ngx.flush(true) -- flush any pending output and wait
ngx.sleep(3) -- sleeping for 3 sec
ngx.say("Bye bye...")
}
}
}DescriptionThis is a port of the ngx_http_lua_module to the Nginx "stream" subsystem so as to support generic stream/TCP clients. The available Lua APIs and Nginx directives remain the same as those of the ngx_http_lua module. DirectivesThe following directives are ported directly from ngx_http_lua. Please check the documentation of ngx_http_lua for more details about their usage and behavior.
The send_timeout directive in the Nginx
"http" subsystem is missing in the "stream" subsystem. As such,
ngx_stream_lua_module uses the Note: the lingering close directive that used to exist in older version of
preread_by_lua_blocksyntax: preread_by_lua_block { lua-script } context: stream, server phase: preread Acts as a It is possible to acquire the raw request socket using ngx.req.socket
and receive data from or send data to the client. However, keep in mind that calling the The This directive was first introduced in the preread_by_lua_filesyntax: preread_by_lua_file <path-to-lua-script-file> context: stream, server phase: preread Equivalent to preread_by_lua_block, except that the file specified by Nginx variables can be used in the When a relative path like When the Lua code cache is turned on (by default), the user code is loaded once at the first connection and cached. The Nginx config must be reloaded each time the Lua source file is modified. The Lua code cache can be temporarily disabled during development by switching lua_code_cache This directive was first introduced in the log_by_lua_blocksyntax: log_by_lua_block { lua-script } context: stream, server phase: log Runs the Lua source code specified as Yielding APIs such as This directive was first introduced in the log_by_lua_filesyntax: log_by_lua_file <path-to-lua-script-file> context: stream, server phase: log Equivalent to log_by_lua_block, except that the file specified by Nginx variables can be used in the When a relative path like When the Lua code cache is turned on (by default), the user code is loaded once at the first connection and cached. The Nginx config must be reloaded each time the Lua source file is modified. The Lua code cache can be temporarily disabled during development by switching lua_code_cache This directive was first introduced in the lua_add_variablesyntax: lua_add_variable $var context: stream Add the variable By default, variables added using this directive are considered "not found" and reading them
using This directive was first introduced in the preread_by_lua_no_postponesyntax: preread_by_lua_no_postpone on|off context: stream Controls whether or not to disable postponing preread_by_lua* directives
to run at the end of the This directive was first introduced in the Nginx API for LuaMany Lua API functions are ported from ngx_http_lua. Check out the official manual of ngx_http_lua for more details on these Lua API functions. This module fully supports the new variable subsystem inside the Nginx stream core. You may access any built-in variables provided by the stream core or other stream modules.
Only raw request sockets are supported, for obvious reasons. The When the stream server is in UDP mode, reading from the downstream socket returned by the
The raw TCP sockets returned by this module will contain the following extra method: reqsock:receiveanysyntax: data, err = reqsock:receiveany(max) context: content_by_lua*, ngx.timer.*, ssl_certificate_by_lua* This method is similar to tcpsock:receiveany method This method was introduced into tcpsock:shutdownsyntax: ok, err = tcpsock:shutdown("send") context: content_by_lua* Shuts down the write part of the request socket, prevents all further writing to the client and sends TCP FIN, while keeping the reading half open. Currently only the If you called any output functions (like ngx.say)
before calling this method, consider use This feature is particularly useful for protocols that generate a response before actually finishing consuming all incoming data. Normally, the kernel will send RST to the client when tcpsock:close is called without emptying the receiving buffer first. Calling this method will allow you to keep reading from the receiving buffer and prevents RST from being sent. You can also use this method to simulate lingering close similar to that provided by the ngx_http_core_module for protocols in need of such behavior. Here is an example: local LINGERING_TIME = 30 -- 30 seconds
local LINGERING_TIMEOUT = 5000 -- 5 seconds
local ok, err = sock:shutdown("send")
if not ok then
ngx.log(ngx.ERR, "failed to shutdown: ", err)
return
end
local deadline = ngx.time() + LINGERING_TIME
sock:settimeouts(nil, nil, LINGERING_TIMEOUT)
repeat
local data, _, partial = sock:receive(1024)
until (not data and not partial) or ngx.time() >= deadlinereqsock:peeksyntax: ok, err = reqsock:peek(size) context: preread_by_lua* Peeks into the preread buffer that contains downstream data sent by the client without consuming them. That is, data returned by this API will still be forwarded upstream in later phases. This function takes a single required argument, Note that preread phase happens after the TLS handshake. If the stream server was configured with TLS enabled, the returned data will be in clear text. If preread buffer does not have the requested amount of data, then the current Lua thread will
be yielded until more data is available, When When In both cases, no further processing on the session is possible (except Note that this API cannot be used if consumption of client data has occurred. For example, after calling
Here is an example of using this API: local sock = assert(ngx.req.socket())
local data = assert(sock:peek(1)) -- peek the first 1 byte that contains the length
data = string.byte(data)
data = assert(sock:peek(data + 1)) -- peek the length + the size byte
local payload = data:sub(2) -- trim the length byte to get actual payload
ngx.log(ngx.INFO, "payload is: ", payload)This API was first introduced in the
TODO
Nginx CompatibilityThe latest version of this module is compatible with the following versions of Nginx:
Nginx cores older than 1.13.6 (exclusive) are not tested and may or may not work. Use at your own risk! InstallationIt is highly recommended to use OpenResty releases which bundle Nginx, ngx_http_lua, ngx_stream_lua, (this module), LuaJIT, as well as other powerful companion Nginx modules and Lua libraries. It is discouraged to build this module with Nginx yourself since it is tricky to set up exactly right. Note that Nginx, LuaJIT, and OpenSSL official releases have various limitations and long standing bugs that can cause some of this module's features to be disabled, not work properly, or run slower. Official OpenResty releases are recommended because they bundle OpenResty's optimized LuaJIT 2.1 fork and Nginx/OpenSSL patches. Alternatively, ngx_stream_lua can be manually compiled into Nginx:
Build the source with this module: wget 'https://nginx.org/download/nginx-1.13.6.tar.gz'
tar -xzvf nginx-1.13.6.tar.gz
cd nginx-1.13.6/
# tell nginx's build system where to find LuaJIT 2.1:
export LUAJIT_LIB=/path/to/luajit/lib
export LUAJIT_INC=/path/to/luajit/include/luajit-2.1
# Here we assume Nginx is to be installed under /opt/nginx/.
./configure --prefix=/opt/nginx \
--with-ld-opt="-Wl,-rpath,/path/to/luajit-or-lua/lib" \
--with-stream \
--with-stream_ssl_module \
--add-module=/path/to/stream-lua-nginx-module
# Build and install
make -j4
make installYou may use CommunityEnglish Mailing ListThe openresty-en mailing list is for English speakers. Chinese Mailing ListThe openresty mailing list is for Chinese speakers. Code RepositoryThe code repository of this project is hosted on GitHub at openresty/stream-lua-nginx-module. Bugs and PatchesPlease submit bug reports, wishlists, or patches by
AcknowledgmentsWe appreciate Kong Inc. for kindly sponsoring OpenResty Inc. on the following work:
Copyright and LicenseThis module is licensed under the BSD license. Copyright (C) 2009-2019, by Yichun "agentzh" Zhang (章亦春) [email protected], OpenResty Inc. Copyright (C) 2009-2016, by Xiaozhe Wang (chaoslawful) [email protected]. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. See Also
|
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
六六分期app的软件客服如何联系？不知道吗？加qq群【895510560】即可！标题：六六分期
今天小编告诉大家如何处理win10系统火狐flash插件总是崩溃的问题，可能很多用户都不知
今天小编告诉大家如何对win10系统删除桌面回收站图标进行设置，可能很多用户都不知道
今天小编告诉大家如何对win10系统电脑设置节能降温的设置方法，想必大家都遇到过需要
我们在使用xp系统的过程中,经常需要对xp系统无线网络安装向导设置进行设置，可能很多
今天小编告诉大家如何处理win7系统玩cf老是与主机连接不稳定的问题，可能很多用户都不
电脑对日常生活的重要性小编就不多说了，可是一旦碰到win7系统设置cf烟雾头的问题，很
我们在日常使用电脑的时候，有的小伙伴们可能在打开应用的时候会遇见提示应用程序无法
今天小编告诉大家如何对win7系统打开vcf文件进行设置，可能很多用户都不知道怎么对win
今天小编告诉大家如何对win10系统s4开启USB调试模式进行设置，可能很多用户都不知道怎
请发表评论