APIリファレンス
GDOnlineMatch
ゲーム名ごとに部屋と身元確認サーバーの場所を記録し、参加先を返すエンドポイントです。ゲームの通信内容は中継しません。
メソッド
handle(req: GDWebRequest) -> GDWebResponse, Errlisten(port: int, host: String = "127.0.0.1") -> Variant, Errport() -> intstop() -> void
handle
handle(req: GDWebRequest) -> GDWebResponse, ErrWebアプリケーションのハンドラーとしてマッチング要求に答えます。返事は値とErrの二値です。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
req | GDWebRequest | 省略不可 | ミドルウェアやハンドラーへ渡された現在のHTTPリクエスト。 |
戻り値
GDWebResponse, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
listen
listen(port: int, host: String = "127.0.0.1") -> Variant, Errマッチング用のHTTP待ち受けを開始します。返り値は値とErrの二値です。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
Variant, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
port
port() -> intlistenで開いたポートを返します。待ち受け前は0です。
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
stop
stop() -> void待ち受けを停止します。
引数
引数はありません。
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。