io.socket.on()
指定されたeventNameでSailsからのソケットイベントのリスニングを開始します。一致するイベントを受信すると、提供されたコールバック関数をトリガーします。
io.socket.on(eventName, function (msg) {
// ...
});
使用法
| 引数 | 型 | 詳細 | |
|---|---|---|---|
| 1 | eventName | ソケットイベントの名前です。例：'recipe'や'welcome'。 |
|
| 2 | handlerFn | サーバーがこのソケットに通知をブロードキャストしたときに呼び出されるイベントハンドラーです。受信したソケット通知がeventNameと一致する場合にのみ呼び出されます。 |
イベントハンドラー
| 引数 | 型 | 詳細 | |
|---|---|---|---|
| 1 | msg | ソケット通知からのデータです。 |
イベントハンドラーはいつ呼び出されるか？
このイベントハンドラーは、クライアントが指定されたイベント名（例：'welcome'）と一致するソケット通知を受信したときに呼び出されます。これは、サーバーがこのソケットに直接メッセージをブロードキャストした場合、またはソケットがメンバーであるルームにブロードキャストした場合に発生します。ソケット通知をブロードキャストするには、ブループリントAPIを使用するか、サーバー側のコード（例：アクション、ヘルパー、またはコマンドラインスクリプト内）を記述する必要があります。これは通常、次のいずれかの方法で実現されます。
低レベルソケットメソッド (sails.sockets)
- サーバーが接続されているすべてのソケットにメッセージを送信します（sails.sockets.blast()を参照）。
- サーバーが特定のソケットに一意のIDを使用して直接メッセージをブロードキャストするか、ソケットでいっぱいのルーム全体にブロードキャストします（sails.sockets.broadcast()を参照）。
リソースフルPubsubメソッド
- サーバーがレコードに関するメッセージをブロードキャストします。複数のソケットがサブスクライブしている可能性があります（Model.publish()を参照）。
- サーバーが「作成」ブループリントアクションの一部としてメッセージをブロードキャストします（ブループリントを使用している場合にのみ関連します）。
例
"order"イベントをリッスンする
io.socket.on('order', function onServerSentEvent (msg) {
// msg => {...whatever the server broadcasted...}
});
リアルタイムのカフェテリア
レストランチェーンの注文システムを構築していると想像してください。
// In your frontend code...
// (This example uses jQuery and Lodash for simplicity. But you can use any library or framework you like.)
var ORDER_IN_LIST = _.template('<li data-id="<%- order.id %>"><p><%- order.summary %></p></li>');
$(function whenDomIsReady(){
// Every time we receive a relevant socket event...
io.socket.on('order', function (msg) {
// Let's see what the server has to say...
switch(msg.verb) {
case 'created': (function(){
// Render the new order in the DOM.
var newOrderHtml = ORDER_IN_LIST(msg.data);
$('#orders').append(newOrderHtml);
})(); return;
case 'destroyed': (function(){
// Find any existing orders w/ this id in the DOM.
//
// > Remember: To prevent XSS attacks and bugs, never build DOM selectors
// > using untrusted provided by users. (In this case, we know that "id"
// > did not come from a user, so we can trust it.)
var $deletedOrders = $('#orders').find('[data-id="'+msg.id+'"]');
// Then, if there are any, remove them from the DOM.
$deletedOrders.remove();
})(); return;
// Ignore any unrecognized messages
default: return;
}//< / switch >
});//< / io.socket.on() >
});//< / when DOM is ready >
この例では、バックエンドがどこかの時点で
.publish()または.broadcast()を呼び出すことを前提としていることに注意してください。これは、カスタムコードを介して、またはブループリントAPIを介して行うことができます。
'connect'イベント
デフォルトでは、Sailsソケットクライアントがページにロードされると、自動的にソケットの接続を開始します。デフォルトの自動接続ソケット（io.socket）を使用する場合、ソケットが接続されるのを待つ必要はありません。つまり、他のソケットイベントをリッスンしたり、io.socket.get()のようなメソッドをすぐに呼び出すことができます。Sailsソケットクライアントは、その間に実行したすべてをキューに入れ、接続がライブになると自動的に再生します。
したがって、'connect'イベントを直接使用することは、ほとんどのアプリでは必要ありません。ただし、完全に説明するために、独自の'connect'ハンドラーをバインドすることもできることに言及する価値があります。
io.socket.on('connect', function onConnect(){
console.log('This socket is now connected to the Sails server.');
});
'disconnect'イベント
サーバーの再起動やクライアントに何らかのネットワークの問題が発生したなどで、ソケットのサーバーへの接続が中断された場合は、エラーメッセージを表示したり、ソケットを手動で再接続したりするために、disconnectイベントを処理することが可能です。
io.socket.on('disconnect', function onDisconnect(){
console.log('This socket lost connection to the Sails server');
});
ソケットは自動的に再接続するように構成できます。ただし、Sails v1の時点では、Sailsソケットクライアントはこの動作をデフォルトで無効にしています。実際には、ユーザーインターフェースが切断中にソケット通知を見逃している可能性があるため、関連するカスタムロジックをほぼ常に手動で処理する必要があります。（例：「インターネット接続を確認してください」というエラーメッセージ）。
注
- ソケットは、ブラウザータブが開いている間など、接続されている間のみ、または
.unsubscribe()または.leave()を使用してサーバー上で手動でサブスクライブ解除されるまで、ルームにサブスクライブしたままになることを忘れないでください。- リソースフルPubSub呼び出しおよびブループリントからのソケットメッセージをリッスンする場合、イベント名は常に呼び出し元のモデルのIDと同じです。たとえば、「UserComment」という名前のモデルがある場合、モデルのID（したがって、
UserComment.publish()で使用されるソケットイベント名）は「usercomment」です。- コンテキストとして、ソケット通知は「サーバー送信イベント」または「Comet）メッセージ」と呼ばれることもあります。
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)
- WebSockets
リファレンス
愛を込めて構築
Sailsフレームワークは、テキサス州オースティンのウェブ＆モバイルショップが、貢献者の協力を得て構築しています。2012年にNode.jsプロジェクトを支援するためにSailsを作成しました。当然ながら、オープンソース化しました。それがあなたの生活を少しでも楽にすることを願っています！
© 2012-2024 The Sails Company.
Sailsフレームワークは、MITライセンスの下で無料でオープンソースです。
イラスト：Edamame。