怎样理解 cosocket

鲁迅有句名言：“其实世界上本没有路，走的人多了，也便成了路”，其实对于 cosocket 的中文翻译貌似我也碰到了类似的问题。当我想给大家一个正面解释，爬过了官方 wiki 发现，原来作者本人（章亦春）也没有先给出 cosocket 的定义。

看来只能通过一些侧面信息，从而让这条路逐渐的清晰起来。

OpenResty 中的 cosocket 不仅需要协程特性支撑，它还需 Nginx 非常最重要的“事件循环回调机制”，两部分结合在一起最终达到了 cosocket 效果，外加 Nginx 自身对各种资源的“小气”，LuaJIT 的执行效率，最终加分不少。在 Lua 世界中调用任何一个有关 cosocket 网络函数，其内部关键调用如图所示：

暂停自己，把网络事件注册到 Nginx 监听列表中，并把运行权限交给 Nginx。
当有注册的网络事件达到触发条件时，就唤醒对应的协程继续处理。

以此为蓝图，封装实现、read、receive 等操作，就形成了大家目前所看到的 cosocket API。

可以看到，cosocket 是依赖 Lua 协程 + Nginx 事件通知 两个重要特性拼组而成的。

从 0.9.9 版本开始，cosocket 对象是全双工的，也就是说，有一个专门读取的和一个专门写入的 light thread，它们可以同时对同一个 cosocket 对象进行操作（两个 light threads 必须运行在同一个 Lua 环境中，原因见上）。但是你不能让两个对同一个 cosocket 对象进行相同的操作（例如，都读取、都写入或者都连接），否则当调用 cosocket 对象时，你将得到一个类似 “socket busy reading” 的错误。

所有东西总结下来，到底什么是 cosocket，中文应该怎么翻译，笔者本人都开始纠结了。我们不妨从另外一个角度来审视它，它到底给我们带来了什么？

它是同步的；
它是非阻塞的；
它是全双工的；

同步与异步解释：

同步：做完一件事再去做另一件；异步：同时做多件事情，某个事情有结果了再去处理。

阻塞与非阻塞解释：

异步／同步是做事派发方式，阻塞／非阻塞是如何处理事情，两组概念不在同一个层面。

无论 ngx.socket.tcp()、ngx.socket.udp()、、还是 ngx.req.socket()，它们基本流程都是一样的，只是一些细节参数上有区别（比如 TCP 和 UDP 的区别）。下面这些函数，都是用来辅助完成更高级的 socket 行为控制：

connect
send
receive
close
settimeout
setoption
receiveuntil
getreusedtimes

它们不仅完整兼容 LuaSocket 库的 TCP API，而且还是 100% 非阻塞 的。

这里给大家 show 一个例子，对 cosocket 使用有一个整体认识。

可以看到，这里的 socket 操作都是 同步非阻塞 的，完全不像 node.js 那样充满各种回调，整体看上去非常简洁优雅，效率还非常棒。

对 cosocket 做了这么多铺垫，到底他有多么重要呢？直接看一下官方默认绑定包有多少是基于 cosocket 的：

ngx_stream_lua_module Nginx “stream” 子系统的官方模块版本（通用的下游 TCP 对话）。
基于 ngx_lua cosocket 的库。
lua-resty-redis 基于 ngx_lua cosocket 的库。
基于 ngx_lua cosocket 的库。
lua-resty-upload 基于 ngx_lua cosocket 的库。
提供 WebSocket 的客户端、服务端，基于 ngx_lua cosocket 的库。

效仿这些基础库的实现方法，可以完成不同系统或组件的对接，例如 syslog、beanstalkd、mongodb 等，直接 copy 这些组件的通讯协议即可。