ページの編集
.leave()
ソケットをルームから登録解除します。
sails.sockets.leave(socket, roomName);
または
sails.sockets.leave(socket, roomName, cb);
使用法
| 引数 | 型 | 詳細 | |
|---|---|---|---|
| 1 | socket | 登録解除するソケット。着信ソケットリクエスト (req) または別のソケットの ID を指定できます。 | |
| 2 | roomName | ソケットを登録解除するルームの名前。 | |
| 3 | _cb_ | オプションのコールバック。現在のサーバーでの操作が完了したとき（詳細については以下の注を参照）、または致命的なエラーが発生した場合に呼び出されます。エラーが発生した場合、単一の引数（err）で呼び出されます。 |
例
コントローラーアクションで、指定されたルームからリクエスト元のソケットを登録解除します。
leaveFunRoom: function(req, res) {
if ( _.isUndefined(req.param('roomName')) ) {
return res.badRequest('`roomName` is required.');
}
if (!req.isSocket) {
return res.badRequest('This endpoints only supports socket requests.');
}
var roomName = req.param('roomName');
sails.sockets.leave(req, roomName, function(err) {
if (err) {return res.serverError(err);}
return res.json({
message: 'Left a fun room called '+roomName+'!'
});
});
}
追加の例
sails.sockets.leave() の使用例は、こちらで確認できます。これには、ID による他のソケットの登録解除、データベースとのより深い統合、サービス内での使用、async ライブラリとの使用が含まれます。
注
sails.sockets.leave()は、Socket.IO の.leave()の機能とほぼ同等ですが、マルチサーバーデプロイメントに対する追加の組み込みサポートがあります。推奨される本番環境設定では、コードがどのサーバーで実行されているか、またはターゲットソケットが接続されているサーバーに関係なく、sails.sockets.leave()はドキュメントどおりに動作します。- マルチサーバー環境で、ソケットID引数を使用して
.leave()を呼び出すと、.leave()呼び出しが現在のサーバーで完了したときにコールバック関数（cb）が実行されます。これは、クラスター内の他のサーバーが既に操作の実行を完了していることを保証するものではありません。- 登録解除するソケットとして
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フレームワークは、テキサス州オースティンにあるWeb＆モバイルショップによって、コントリビューターの協力を得て構築されています。私たちは2012年にNode.jsプロジェクトを支援するためにSailsを作成しました。当然、それをオープンソース化しました。それがあなたの生活を少しでも楽にすることを願っています！
© 2012-2024 The Sails Company.
SailsフレームワークはMITライセンスの下で無料でオープンソースです。
イラストレーション: Edamame.