SailsSocket メソッド
このセクションでは、各 SailsSocket インスタンスで使用可能なメソッドについて説明します。これらのメソッドのほとんどは、ソケットがサーバーに接続する前でも呼び出すことができます。.get() や .request() のようなリクエストメソッドの場合、ソケットが接続するまで呼び出しはキューに入れられ、接続されると順番に実行されます。
基本メソッド
SailsSocket インスタンスで使用する最も一般的なメソッドは、メインのSocket クライアントリファレンスセクションに記載されています。これらには、.get()、.put()、.post()、.delete()、.request()、.on()、および.off()が含まれます。
高度なメソッド
基本的な通信とイベントリスニングメソッドに加えて、各 SailsSocket インスタンス（io.socket を含む）は、サーバー接続を処理するためのいくつかのメソッドを公開しています。
.isConnected()
SailsSocket インスタンスが現在サーバーに接続されているかどうかを判定します。接続が確立されている場合はtrueを返します。
io.socket.isConnected();
.isConnecting()
SailsSocket インスタンスが現在サーバーへの接続処理中かどうかを判定します。接続が試行されている場合はtrueを返します。
io.socket.isConnecting();
.mightBeAboutToAutoConnect()
SailsSocket インスタンスが既にロードされているが、まだ完全に構成されていないか、自動接続を試行していないことを検出します。
sails.io.js ライブラリは、イベントループの1ティック待ってから、autoConnectが有効になっているかどうかを確認し、有効な場合は接続を試みます。これにより、接続を試みる前にSailsSocketインスタンスを構成できます（例：io.sails.urlの設定）。mightBeAboutToAutoConnect()メソッドは、sails.io.jsがロードされたが、イベントループの必要なティックがまだ経過していない場合にtrueを返します。
io.socket.mightBeAboutToAutoConnect();
.disconnect()
SailsSocket インスタンスをサーバーから切断します。ソケットが既に切断されている場合はエラーをスローします。
io.socket.disconnect();
.reconnect()
切断された後（非意図的に、または.disconnect()の呼び出しによって）SailsSocket インスタンスをサーバーに再接続します。インスタンスは、現在構成されているプロパティを使用して接続します。ソケットが既にサーバーに接続されている場合は、.reconnect()はエラーをスローします。
io.socket.reconnect();
インスタンスが切断状態の場合、そのプロパティを変更できます。つまり、あるサーバーから切断されたインスタンスは、イベントバインディングやキューに入れられたリクエストを失うことなく、別のサーバーに再接続できます。
.removeAllListeners()
connectやdisconnectを含む、SailsSocket インスタンス上のサーバー関連のイベントのリスニングを停止します。
io.socket.removeAllListeners();
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.