Luv - Thermonuclear 电池包 Lua 使用技术文档

1. 安装指南

为了安装 Luv，请按照以下步骤操作：

• 确保您的系统中已安装 Lua。
• 克隆或下载 Luv 的源代码。
• 打开终端或命令提示符，导航到源代码目录。
• 运行 make 命令，编译 Luv。
• 将生成的 luv.so 文件复制到您需要的目录下。

请注意，虽然理论上 ØMQ 和 libuv 支持 WIN32，但作者并不清楚那里的构建系统如何工作，因此如果需要在 Windows 上构建，可能需要提交补丁。

2. 使用说明

Luv 是对 libuv 的 Lua 绑定，旨在适应具有协程的语言，而不是边缘触发的基于回调的事件循环编程风格。

协程与纤程

Luv 的核心是一个相当快速的协程调度器（在我的笔记本电脑上，每秒 20,000,000 次上下文切换）。

协程被包装为“纤程”，增加了一些额外的信息，允许它们被 libuv 事件循环挂起和恢复。这使得编程感觉更像是线程，具有线性流程，但不会出现令人印象深刻的崩溃。

以下是一个典型的 TCP 回声服务器示例：

local main = luv.fiber.create(function()
   local server = luv.net.tcp()
   server:bind("127.0.0.1", 8080)
   server:listen()

   while true do
      local client = luv.net.tcp()
      server:accept(client)

      local child = luv.fiber.create(function()
         while true do
            local got, str = client:read()
            if got then
               client:write("you said: "..str)
            else
               client:close()
               break
            end
         end
      end)

      -- 将其放入就绪队列
      child:ready()
   end
end)

main:join()

纤程以最高优先级运行，因此处于 I/O 负载下的进程不会饿处理实际处理数据的任务。

一旦所有待处理的纤程都已获得运行的机会，事件循环就会启动并轮询事件，并唤醒等待事件的任何挂起的纤程。

3. 项目 API 使用文档

以下是 Luv 项目的主要 API 使用文档：

纤程

• luv.fiber.create(func, [arg1, ..., argN]): 创建一个纤程，并传递要运行的函数及其参数。
• fiber:ready(): 将纤程插入调度器的就绪队列中。
• fiber:join(): 将纤程插入线程的调度器并挂起当前状态，直到纤程退出。

定时器

• luv.timer.create(): 创建一个新的定时器实例。
• timer:start(delay, repeat): 启动定时器，参数 delay 和 repeat 均为毫秒。
• timer:wait(): 挂起当前状态，直到定时器触发。
• timer:stop(): 停止定时器。
• timer:again(): 停止定时器，并使用重复值重新启动。

空闲监视器

• luv.idle.create(): 创建一个空闲监视器。
• idle:start(): 启动空闲监视器。
• idle:stop(): 停止空闲监视器。
• idle:wait(): 挂起当前状态，直到没有其他事情要做。

文件系统操作

• luv.fs.open(path, mode, perm): 打开一个文件。
• luv.fs.unlink(path): 删除一个文件。
• luv.fs.mkdir(path): 创建一个目录。
• luv.fs.rmdir(path): 删除一个目录。
• luv.fs.readdir(path): 读取目录条目。
• luv.fs.stat(path): 查询路径的状态。
• luv.fs.rename(path, newpath): 重命名文件或目录。
• luv.fs.sendfile(outfile, infile): 高效地从 infile 复制数据到 outfile。
• luv.fs.chmod(path, mode): 更改文件或目录的模式。
• luv.fs.chown(path, uid, gid): 更改路径的所有权。
• luv.fs.utime(path, atime, mtime): 更改路径的访问和修改时间。

TCP 流

• luv.net.tcp(): 创建一个新的未绑定且未连接的 TCP 套接字。
• tcp:bind(host, port): 将套接字绑定到指定的主机和端口。
• tcp:listen([backlog]): 开始监听传入的连接。
• tcp:accept(tcp2): 接受连接，tcp2 成为客户端套接字。
• tcp:connect(host, port): 连接到指定的主机和端口。
• tcp:getsockname(): 返回套接字的本地信息。
• tcp:getpeername(): 返回对等套接字的信息。
• tcp:keepalive(enable, seconds): 启用或禁用 TCP 保持活动状态。

4. 项目安装方式

请参考“安装指南”部分中的步骤进行安装。