.leaveAll()
ルーム(例:chatroom7
)の全メンバーをそのルームから、そして現在購読している他のすべてのルームからも購読解除します。ただし、ソケットIDに関連付けられた自動ルームは除きます。
sails.sockets.leaveAll(roomName, cb);
引数 | 型 | 詳細 | |
---|---|---|---|
1 | roomName | 退室させるルーム。このルームのメンバーは、このルームだけでなく、すべてのルームから強制的に退出します。 | |
2 | cb | オプションのコールバック関数。操作が現在のサーバー上で完了した場合(詳細については下記の注記を参照)、または致命的なエラーが発生した場合に呼び出されます。エラーが発生した場合は、単一の引数(err )を使用して呼び出されます。 |
コントローラーアクション内
unsubscribeFunRoomMembersFromEverything: function(req, res) {
sails.sockets.leaveAll('funRoom', function(err) {
if (err) { return res.serverError(err); }
// Unsubscribed all sockets in "funRoom" from "funRoom".
// And... from every other room too.
return res.ok();
});
}
- マルチサーバー環境では、コールバック関数(
cb
)は、.leaveAll()
呼び出しが現在のサーバーで完了したときに実行されます。これは、クラスタ内の他のサーバーが既に操作の実行を完了していることを保証するものではありません。