Merge branch 'master' of https://github.com/actboy168/bee.lua

Author: actboy168

meta/channel.lua

@@ -0,0 +1,48 @@
+---@meta bee.channel
+
+---通道库，用于线程间通信
+---@class bee.channel
+local channel = {}
+
+---通道对象
+---@class bee.channel.box
+local channel_box = {}
+
+---向通道推送数据
+---数据会被序列化后发送，支持的数据类型与 bee.serialization 相同
+---@param ... any 要推送的数据
+function channel_box:push(...)
+end
+
+---从通道弹出数据
+---@return boolean ok # 是否成功弹出数据，false表示通道为空
+---@return any ... # 弹出的数据
+function channel_box:pop()
+end
+
+---获取通道的文件描述符
+---可用于 epoll/select 等待通道有数据
+---@return lightuserdata fd # 文件描述符
+function channel_box:fd()
+end
+
+---创建一个新的通道
+---@param name string 通道名称，必须唯一
+---@return bee.channel.box # 通道对象
+function channel.create(name)
+end
+
+---销毁一个通道
+---会清空通道中的所有数据
+---@param name string 通道名称
+function channel.destroy(name)
+end
+
+---查询一个已存在的通道
+---@param name string 通道名称
+---@return bee.channel.box? # 通道对象，如果不存在则返回nil
+---@return string? # 错误消息
+function channel.query(name)
+end
+
+return channel

meta/crash.lua

@@ -0,0 +1,18 @@
+---@meta bee.crash
+
+---崩溃处理库
+---@class bee.crash
+local crash = {}
+
+---崩溃处理器对象
+---@class bee.crash.handler
+local handler = {}
+
+---创建崩溃处理器
+---当程序崩溃时，会在指定路径生成dump文件
+---@param dump_path string dump文件保存路径
+---@return bee.crash.handler # 崩溃处理器对象
+function crash.create_handler(dump_path)
+end
+
+return crash

meta/debugging.lua

@@ -0,0 +1,22 @@
+---@meta bee.debugging
+
+---调试库
+---@class bee.debugging
+local debugging = {}
+
+---触发断点
+---在调试器中会中断执行
+function debugging.breakpoint()
+end
+
+---检查是否有调试器附加
+---@return boolean # 是否有调试器附加
+function debugging.is_debugger_present()
+end
+
+---仅在有调试器附加时触发断点
+---如果没有调试器附加，则不执行任何操作
+function debugging.breakpoint_if_debugging()
+end
+
+return debugging

meta/epoll.lua

@@ -0,0 +1,68 @@
+---@meta bee.epoll
+
+---Epoll I/O多路复用库
+---跨平台的epoll风格API，在Windows上使用IOCP实现
+---@class bee.epoll
+---@field EPOLLIN integer 可读事件
+---@field EPOLLPRI integer 紧急数据可读
+---@field EPOLLOUT integer 可写事件
+---@field EPOLLERR integer 错误事件
+---@field EPOLLHUP integer 挂起事件
+---@field EPOLLRDNORM integer 普通数据可读
+---@field EPOLLRDBAND integer 优先数据可读
+---@field EPOLLWRNORM integer 普通数据可写
+---@field EPOLLWRBAND integer 优先数据可写
+---@field EPOLLMSG integer 消息事件
+---@field EPOLLRDHUP integer 对端关闭连接
+---@field EPOLLONESHOT integer 一次性事件（触发后自动删除）
+local epoll = {}
+
+---Epoll实例对象
+---@class bee.epoll.fd
+local epfd = {}
+
+---等待事件
+---@param timeout? integer 超时时间，单位为毫秒，-1表示无限等待
+---@return fun(): any?, integer? iterator # 返回迭代器函数，迭代产生 (关联对象, 事件标志)
+function epfd:wait(timeout)
+end
+
+---关闭Epoll实例
+---@return boolean? # 成功返回true，失败返回nil
+---@return string? # 错误消息
+function epfd:close()
+end
+
+---添加事件监听
+---@param fd bee.socket.fd|lightuserdata 要监听的文件描述符或套接字
+---@param events integer 事件标志，可组合多个EPOLL*常量
+---@param userdata? any 关联的用户数据，默认为fd本身
+---@return boolean? # 成功返回true，失败返回nil
+---@return string? # 错误消息
+function epfd:event_add(fd, events, userdata)
+end
+
+---修改事件监听
+---@param fd bee.socket.fd|lightuserdata 文件描述符或套接字
+---@param events integer 新的事件标志
+---@param userdata? any 新的关联用户数据
+---@return boolean? # 成功返回true，失败返回nil
+---@return string? # 错误消息
+function epfd:event_mod(fd, events, userdata)
+end
+
+---删除事件监听
+---@param fd bee.socket.fd|lightuserdata 文件描述符或套接字
+---@return boolean? # 成功返回true，失败返回nil
+---@return string? # 错误消息
+function epfd:event_del(fd)
+end
+
+---创建Epoll实例
+---@param max_events integer 最大事件数量（必须大于0）
+---@return bee.epoll.fd? # Epoll实例对象
+---@return string? # 错误消息
+function epoll.create(max_events)
+end
+
+return epoll