WebSocketServer
WebSocketServer
クラスを使って、4D で WebSocketサーバーを作成および設定することができます。 4D WebSocketサーバーがアクティブになる と、WebSocketConnection
クラス を使用して 4D とクライアント間で WebSocket 接続を開き、使用することができます。
履歴
リリース | 内容 |
---|---|
20 | 追加 |
WebSocket サーバーについて
WebSocketプロトコルは、WebSocketサーバーとクライアント (Webブラウザーなど) の間の双方向通信のチャンネルを提供します。 WebSocketサーバーの詳細については、Wikipedia のページ を参照ください。
参照
4D WebSocketサーバーについては、こちらのブログ記事 も参照ください。
要件
4D で WebSocketサーバーを作成し、扱うには、4Dビルトインクラスを 2つ使用する必要があります。
- このクラス (
4D.WebSocketServer
) は、サーバー自体を管理するためのものです。 4D.WebSocketConnection
クラスを使用して、接続とメッセージを管理します。
さらに、2つのユーザークラスを作成し、コールバック関数を定義する必要があります:
- サーバー接続を処理するためのユーザークラス
- メッセージを処理するためのユーザークラス
接続を維持するため、WebSocketサーバーの作成 は ワーカー 内にておこなう必要があります。
4D Webサーバー を起動しておく必要があります。
例題
この基本的な例では、WebSocketサーバーはメッセージを大文字で返します。
- ワーカーを使用して (必須) WebSocketサーバーを作成し、サーバー接続処理用のユーザークラスをパラメーターとして渡します。
// ユーザークラスのインスタンスを作成します
// これが、サーバーへの接続を処理します
var $handler:cs.myServerHandler
$handler:=cs.myServerHandler.new()
CALL WORKER("WebSocketServer"; Formula(wss:=4D.WebSocketServer.new($handler)))
// WebSocket を変数 (wss) に代入しておくことで
// あとで wss.terminate() の呼び出しが可能になります
- サーバーへの接続を処理するためのコールバック関数を含む
myServerHandler
ユーザークラスを定義します:
// myServerHandler クラス
Function onConnection($wss : Object; $event : Object) : Object
// ユーザークラスのインスタンスを返します
// このインスタンスがサーバーへの接続を処理します
return cs.myConnectionHandler.new()
- メッセージを処理するためのコールバック関数を含む
myConnectionHandler
ユーザークラスを定義します:
// myConnectionHandler クラス
Function onMessage($ws : 4D.WebSocketConnection; $message : Object)
// メッセージを大文字に変えて送信します
$ws.send(Uppercase($message.data))
クライアントサイド JS
WebSocket 接続を処理するクライアントサイドの Javascriptコードの例については、このブログの記事 を参照ください。
WebSocketServer オブジェクト
WebSocketサーバーオブジェクトは、以下のプロパティと機能を提供します:
.connections : Collection WebSocketサーバーが処理しているカレントの接続をすべて格納します |
.dataType : Text 受信または 送信されるデータの型 |
.handler : Object WebSocketサーバーの開始に使用された WSSHandler オブジェクトを取得するアクセサーです |
.path : Text WebSocketサーバーにアクセスするためのパスのパターンです |
.terminate() .terminate( timeout : Integer ) WebSocketサーバーを終了します |
.terminated : Boolean WebSocketサーバーが終了している場合には true です |
4D.WebSocketServer.new()
4D.WebSocketServer.new( WSSHandler : Object { ; options : Object } ) : 4D.WebSocketServer
引数 | 型 | 説明 | |
---|---|---|---|
WSSHandler | Object | -> | WebSocketサーバー用コールバックを宣言しているユーザークラスのオブジェクト |
options | Object | -> | WebSocket の設定パラメーター |
戻り値 | 4D.WebSocketServer | <- |