编辑页面
.join()
将套接字订阅到房间。
sails.sockets.join(socket, roomName);
或者
sails.sockets.join(socket, roomName, cb);
用法
| 参数 | 类型 | 详情 | |
|---|---|---|---|
| 1 | socket | 要订阅的套接字。可以通过套接字的 ID 或传入的套接字请求 (req) 指定。 |
|
| 2 | roomName | 要订阅的房间的名称。如果房间尚不存在，它将被创建。 | |
| 3 | _cb_ | 可选的回调函数，将在当前服务器上的操作完成时被调用（有关更多信息，请参阅下面的说明），或者如果遇到致命错误。如果遇到错误，它将使用单个参数 (err) 被调用。 |
示例
在控制器操作中
subscribeToFunRoom: function(req, res) {
if (!req.isSocket) {
return res.badRequest();
}
var roomName = req.param('roomName');
sails.sockets.join(req, roomName, function(err) {
if (err) {
return res.serverError(err);
}
return res.json({
message: 'Subscribed to a fun room called '+roomName+'!'
});
});
}
说明
sails.sockets.join()基本上等同于 Socket.IO 中的.join()功能，但额外内置支持多服务器部署。使用 推荐的生产环境设置，sails.sockets.join()的工作原理与文档一致，无论代码在哪个服务器上运行或目标套接字连接到哪个服务器。- 在多服务器环境中，当使用套接字 ID 参数调用
.join()时，回调函数 (cb) 将在 当前服务器 上的.join()调用完成时执行。这不能保证集群中的其他服务器已经完成运行操作。- 每个套接字都会自动订阅到一个房间，该房间的名称与其 ID 相同，允许通过
sails.sockets.broadcast()直接向套接字发送消息。- 在将
req作为目标套接字传递之前，请确保检查req.isSocket === true。为了使这起作用，提供的req必须来自套接字请求，而不是任何旧的 HTTP 请求。
为了获得更好的 sailsjs.com 使用体验，请 更新您的浏览器。
参考
- 应用程序
- 蓝图 API
- 命令行界面
-
配置
- sails.config.*
- sails.config.blueprints
- sails.config.bootstrap()
- sails.config.custom
- sails.config.datastores
- sails.config.globals
- sails.config.http
- sails.config.i18n
- sails.config.log
- sails.config.models
- sails.config.policies
- sails.config.routes
- sails.config.security
- sails.config.session
- sails.config.sockets
- sails.config.views
-
请求 (
req)- req._startTime
- req.body
- req.cookies
- req.fresh
- req.headers
- req.hostname
- req.ip
- req.ips
- req.isSocket
- req.method
- req.options
- req.originalUrl
- req.params
- req.path
- req.protocol
- req.query
- req.secure
- req.signedCookies
- req.socket
- req.subdomains
- req.url
- req.wantsJSON
- req.xhr
- req.accepts()
- req.acceptsCharsets()
- req.acceptsLanguages()
- req.allParams()
- req.file()
- req.get()
- req.is()
- req.param()
- req.setLocale()
- req.setTimeout()
- req.host
- 响应 (`res`)
- Waterline (ORM)
- WebSocket
参考
用心打造
Sails 框架由一家位于德克萨斯州奥斯汀的网络和移动开发公司，在贡献者的帮助下构建。我们在 2012 年创建 Sails，以协助我们进行 Node.js 项目。自然而然，我们将其开源。我们希望它能使您的生活更轻松！
© 2012-2024 The Sails Company.
Sails 框架是免费的开源软件，采用 MIT 许可证授权。
插图由 Edamame 提供。