客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
开源软件名称（OpenSource Name）：Kong/lua-resty-worker-events开源软件地址(OpenSource Url)：https://github.com/Kong/lua-resty-worker-events开源编程语言(OpenSource Language)：Lua 98.4%开源软件介绍(OpenSource Introduction)：lua-resty-worker-eventsInter process events for Nginx worker processes Table of Contents
StatusThis library is production ready. Synopsishttp {
lua_package_path "/path/to/lua-resty-worker-events/lib/?.lua;;";
# the size depends on the number of event to handle:
lua_shared_dict process_events 1m;
init_worker_by_lua_block {
local ev = require "resty.worker.events"
local handler = function(data, event, source, pid)
print("received event; source=",source,
", event=",event,
", data=", tostring(data),
", from process ",pid)
end
ev.register(handler)
local ok, err = ev.configure {
shm = "process_events", -- defined by "lua_shared_dict"
timeout = 2, -- life time of unique event data in shm
interval = 1, -- poll interval (seconds)
wait_interval = 0.010, -- wait before retry fetching event data
wait_max = 0.5, -- max wait time before discarding event
shm_retries = 999, -- retries for shm fragmentation (no memory)
}
if not ok then
ngx.log(ngx.ERR, "failed to start event system: ", err)
return
end
}
server {
...
# example for polling:
location = /some/path {
default_type text/plain;
content_by_lua_block {
-- manually call `poll` to stay up to date, can be used instead,
-- or together with the timer interval. Polling is efficient,
-- so if staying up-to-date is important, this is preferred.
require("resty.worker.events").poll()
-- do regular stuff here
}
}
}
}DescriptionThis module provides a way to send events to the other worker processes in an Nginx server. Communication is through a shared memory zone where event data will be stored. The order of events in all workers is guaranteed to be the same. The worker process will setup a timer to check for events in the background. The module follows a singleton pattern and hence runs once per worker. If staying up-to-date is important though, the interval can be set to a lesser frequency and a call to poll upon each request received makes sure everything is handled as soon as possible. The design allows for 3 usecases;
This module itself will fire two events with
See event_list for using events without hardcoded magic values/strings. TroubleshootingTo properly size the shm, it is important to understand how it is being used. Event data is stored in the shm to pass it to the other workers. As such there are 2 types of entries in the shm:
The result of the above is that the SHM will always be full! so that is not a metric to investigate at. How to prevent problems:
Methodsconfigure
Will initialize the event listener. This should typically be called from the
The
The return value will be This method can be called repeatedly to update the settings, except for the NOTE: the configured
The events module runs as a singelton per workerprocess. The local events = require "resty.worker.events"
local initialization_of_my_module = function()
assert(events.configured(), "Please configure the 'lua-resty-worker-events' "..
"module before using my_module")
-- do initialization here
endevent_list
Utility function to generate event lists and prevent typos in
magic strings. Accessing a non-existing event on the returned table will result
in an 'unknown event error'.
The first parameter Example usage; local ev = require "resty.worker.events"
-- Event source example
local events = ev.event_list(
"my-module-event-source", -- available as _M.events._source
"started", -- available as _M.events.started
"event2" -- available as _M.events.event2
)
local raise_event = function(event, data)
return ev.post(events._source, event, data)
end
-- Post my own 'started' event
raise_event(events.started, nil) -- nil for clarity, no eventdata is passed
-- define my module table
local _M = {
events = events -- export events table
-- implementation goes here
}
return _M
-- Event client example;
local mymod = require("some_module") -- module with an `events` table
-- define a callback and use source modules events table
local my_callback = function(data, event, source, pid)
if event == mymod.events.started then -- 'started' is the event name
-- started event from the resty-worker-events module
elseif event == mymod.events.stoppping then -- 'stopping' is the event name
-- the above will throw an error because of the typo in `stoppping`
end
end
ev.register(my_callback, mymod.events._source)
poll
Will poll for new events and handle them all (call the registered callbacks). The implementation is efficient, it will only check a single shared memory value and return immediately if no new events are available. The return value will be post
Will post a new event. If the The return value will be Note: the worker process sending the event, will also receive the event! So if the eventsource will also act upon the event, it should not do so from the event posting code, but only when receiving it. post_local
The same as post except that the event will be local to the worker process,
it will not be broadcasted to other workers. With this method, the The return value will be register
Will register a callback function to receive events. If The callback should have the following signature;
The parameters will be the same as the ones provided to post, except for the extra value
The return value of WARNING: event handlers must return quickly. If a handler takes more time than
the configured Note: to receive the process own register_weak
This function is identical to unregister
Will unregister the callback function and prevent it from receiving further events. The parameters work exactly the same as with register. The return value will be InstallationNothing special is required, install like any other pure Lua module. Just make sure its location is in the module search path. Bugs and PatchesPlease report bugs or submit patches by creating a ticket on the GitHub Issue Tracker, AuthorThijs Schreijer [email protected], Kong Inc. Copyright and LicenseThis module is licensed under the Apache 2.0 license. Copyright (C) 2016-2020, by Thijs Schreijer, Kong Inc. All rights reserved. HistoryReleasing new versions
unreleased
2.0.1, 28-June-2021
2.0.0, 16-September-2020
1.1.0, 23-Dec-2020 (maintenance release)
1.0.0, 18-July-2019
0.3.3, 8-May-2018
0.3.2, 11-Apr-2018
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调试模式进行设置，可能很多用户都不知道怎
请发表评论