APIリファレンス
GDWebServer
HTTP通信を直接扱うサーバーです。HTTP/1のリクエストにはHTTP/1.1で応答し、TLSでHTTP/2を選んだ場合は、各リクエストを独立したストリームで処理します。
メソッド
body_limit(bytes: int) -> voidheader_limits(bytes: int, values: int) -> voidlisten(port: int, host: String = "127.0.0.1") -> Variant, Errport() -> intstop() -> voidis_listening() -> boolpoll() -> PackedInt32Arrayget_method(id: int) -> Stringget_path(id: int) -> Stringget_query(id: int) -> Stringget_header(id: int, name: String) -> Stringget_headers(id: int) -> Dictionaryread_body(id: int, bytes: int = 32768) -> Dictionaryrespond(id: int, status: int, body: PackedByteArray, content_type: String = "text/plain; charset=utf-8") -> voidrespond_with(id: int, status: int, headers: Dictionary, body: PackedByteArray) -> voidconnection_count() -> intdropped_headers() -> int
body_limit
body_limit(bytes: int) -> void英語原文Set the body-reader limit for all requests.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
bytes | int | 省略不可 | 文字数ではなく、バイト数で指定します。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
header_limits
header_limits(bytes: int, values: int) -> void英語原文Set request-header byte and field-count limits.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
bytes | int | 省略不可 | 文字数ではなく、バイト数で指定します。 |
values | int | 省略不可 | 受け付けるヘッダー値の個数の上限。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
listen
listen(port: int, host: String = "127.0.0.1") -> Variant, Err英語原文Start an HTTP listener on the specified host and port.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
Variant, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
port
port() -> int英語原文Return the actual listen port, including kernel-assigned ports.
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
stop
stop() -> void英語原文Close the listener and all connections, releasing retained buffers.
引数
引数はありません。
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
is_listening
is_listening() -> bool英語原文Report whether the HTTP listener is active.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
poll
poll() -> PackedInt32Array英語原文Advance connections and return ready request IDs, valid until the next poll.
引数
引数はありません。
戻り値
PackedInt32Array
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
get_method
get_method(id: int) -> String英語原文Return the request method.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
get_path
get_path(id: int) -> String英語原文Return the path component of the request target.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
get_query
get_query(id: int) -> String英語原文Return the query component of the request target.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
get_header
get_header(id: int, name: String) -> String英語原文Return the named request-header value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
name | String | 省略不可 | 対象を登録・参照するための名前。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
get_headers
get_headers(id: int) -> Dictionary英語原文Return request headers as a dictionary with lowercase names.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
read_body
read_body(id: int, bytes: int = 32768) -> Dictionary英語原文Read one body chunk through the low-level API, returning state and data.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
bytes | int | 32768 | 文字数ではなく、バイト数で指定します。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
respond
respond(id: int, status: int, body: PackedByteArray, content_type: String = "text/plain; charset=utf-8") -> void英語原文Submit the common response form with just content and type.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
status | int | 省略不可 | HTTPレスポンスのステータスコード。 |
body | PackedByteArray | 省略不可 | 書き込む内容、またはレスポンスに含める本文。 |
content_type | String | "text/plain; charset=utf-8" | HTTPのContent-Typeヘッダーで送るメディア型。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
respond_with
respond_with(id: int, status: int, headers: Dictionary, body: PackedByteArray) -> void英語原文Submit a response with additional headers.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | int | 省略不可 | 対応するAPIから取得した識別子。 |
status | int | 省略不可 | HTTPレスポンスのステータスコード。 |
headers | Dictionary | 省略不可 | レスポンスのヘッダー名と値。 |
body | PackedByteArray | 省略不可 | 書き込む内容、またはレスポンスに含める本文。 |
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
connection_count
connection_count() -> int英語原文Return the number of retained connections.
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
dropped_headers
dropped_headers() -> int英語原文Cumulative number of omitted headers.
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。