SailsSocket プロパティ
概要
このページでは、各SailsSocket インスタンスで使用できるプロパティについて説明します。これらのプロパティは、SailsSocket を作成する io.sails.connect の最初の呼び出しで設定され、ソケットが接続されている間は変更できません（headers は例外です）。
ソケットが切断された場合（意図的または.disconnectの呼び出しの結果）、ソケットが再度接続されるまでプロパティを変更できます。つまり、あるサーバーから切断されたインスタンスを、イベントバインディングやキューに入れられたリクエストを失うことなく、別のサーバーに再接続できます。
共通プロパティ
| プロパティ | 型 | デフォルト | 詳細 |
|---|---|---|---|
url |
io.sails.urlの値 |
ソケットが接続されている、または接続を試みる URL。 | |
transports |
io.sails.transportsの値 |
ソケットが接続を試みるトランスポート。トランスポートは、アップグレードが許可された状態で順番に試行されます。つまり、「polling」と「websocket」の両方をリストした場合、ロングポーリング接続を確立した後、サーバーはそれを WebSocket 接続にアップグレードしようとします。この設定は、Sails アプリの sails.config.sockets.transports の値と一致する必要があります。 |
|
headers |
io.sails.headersの値 |
このソケットが接続後に送信するすべてのリクエストにデフォルトで付与されるヘッダーの辞書。.request()の headers オプションでオーバーライドできます。最初のソケットハンドシェイクリクエストのヘッダーを設定する方法については、下記の initialConnectionHeaders を参照してください。 |
高度なプロパティ
| プロパティ | 型 | デフォルト | 詳細 |
|---|---|---|---|
query |
io.sails.queryの値 |
サーバーへの最初の接続で使用するクエリ文字列。サーバーコードでは、コントローラーアクションで req.socket.handshake.query を使用するか、ソケットライフサイクルコールバックで handshake._query を使用してアクセスできます。指定したクエリ文字列には、sails.io.js SDK のバージョンに関する情報が付加されることに注意してください。query の一般的な使い方は、Sails アプリが接続ソケットをブラウザセッションに関連付けないことを示す nosession=true を設定することです。 |
|
initialConnectionHeaders |
io.sails.initialConnectionHeadersの値 |
Node.js のみで使用可能で、ブラウザでは使用できません。 サーバーへの最初の接続で送信されるヘッダーの辞書（上記 headers プロパティとは異なり、これは最初の接続後に実行されるすべてのソケットリクエストで送信されるヘッダーです）。サーバーコードでは、最初の接続ヘッダーは、コントローラーアクションでは req.socket.handshake.headers でアクセスできるか、ソケットライフサイクルコールバックでは socket.handshake.headers でアクセスできます。これは、（たとえば）最初のハンドシェイクで cookie ヘッダーを送信し、ソケットが以前に確立された Sails セッションに接続できるようにする場合に便利です。 |
|
useCORSRouteToGetCookie |
io.sails.useCORSRouteToGetCookieの値 |
ブラウザ環境でのみ関連し、認証にデフォルトの Sails セッション + セッションクッキーを使用している場合にのみ関連します。クロスオリジンソケット接続の場合、このプロパティを使用して、適切なセッションを確立するために、クッキーを取得するために最初の JSONP リクエストを送信するルートを選択します。ルートは文字列 '_sailsIoJSConnect();' を返信する必要があります。これにより接続が続行されます。useCORSRouteToGetCookie が true の場合、Sails サーバーのデフォルトの /__getcookie ルートが使用されます。false の場合、ソケットを接続する前にリモートサーバーに接続する試行は行われません。注：この方法は、デフォルトでサードパーティクッキーをブロックする特定のブラウザ（特定のバージョンの Safari を含む）では失敗する可能性があります。 |
io.sails.* のデフォルト
io.sails オブジェクトを使用して、新しいクライアントソケットのデフォルト値を提供できます。たとえば、io.sails.url = "http://myapp.com:1234" を設定すると、io.sails.connect() の呼び出しで url 値が提供されない限り、すべての新しいクライアントソケットが http://myapp.com:1234 に接続するようになります。
以下は、io.sails のプロパティのデフォルト値です。
| プロパティ | デフォルト |
|---|---|
url |
ブラウザでは、sails.io.js スクリプトをロードしたページの URL。Node.js では、デフォルト値はありません。 |
transports |
['websocket'] |
headers |
{} |
query |
'' |
initialConnectionHeaders |
{} |
useCORSRouteToGetCookie |
true |
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年にNode.jsプロジェクトを支援するためにSailsを作成しました。当然ながら、オープンソースとして公開しました。皆様の生活が少しでも楽になることを願っています！
© 2012-2024 The Sails Company.
SailsフレームワークはMITライセンスの下で無償かつオープンソースで提供されています。
イラストはEdamameによるものです。