APIリファレンス
GD.net
TCP・TLSの接続、接続の待ち受け、UDP通信、名前解決、アドレスの検査を行います。TLSでは既定で証明書チェーンと接続先のホスト名を検証します。完了を待つのは、呼び出した処理だけです。
メソッド
is_free(port: int, host: String = "127.0.0.1") -> boolfree_port(from: int = 0, host: String = "127.0.0.1") -> int, Errresolve(host: String) -> String, Errresolve_async(host: String) -> await String, Errdial_tcp(host: String, port: int, opts: Dictionary = { }) -> GDTCPConn, Errdial_tcp_async(host: String, port: int, opts: Dictionary = { }) -> await GDTCPConn, Errdial_tls(host: String, port: int, opts: Dictionary = { }) -> GDTCPConn, Errdial_tls_async(host: String, port: int, opts: Dictionary = { }) -> await GDTCPConn, Errlisten_tcp(host: String = "127.0.0.1", port: int = 0) -> GDTCPListener, Errlisten_udp(host: String = "127.0.0.1", port: int = 0, buffer: int = 0) -> GDUDPPacketConn, Erris_free_async(port: int, host: String = "127.0.0.1") -> await boolfree_port_async(from: int = 0, host: String = "127.0.0.1") -> await int, Errlocal_addresses() -> PackedStringArray, Errlocal_addresses_async() -> await PackedStringArray, Erris_ip(text: String) -> boolsplit_host(text: String, default_port: int = 80) -> Dictionary
is_free
is_free(port: int, host: String = "127.0.0.1") -> bool英語原文Check whether a host port is available for listening.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
free_port
free_port(from: int = 0, host: String = "127.0.0.1") -> int, Err0ならOSに空きポートを選ばせ、正の値ならその番号から探します。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
from | int | 0 | 探索を始めるポート。0ならOSに空きポートの選択を任せます。 |
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
int, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
待ち受けと探索の開始にはポート0を指定できます。接続先とis_free()は1..65535です。結果はその瞬間の確認で、番号を確保するものではありません。
resolve
resolve(host: String) -> String, Errホスト名をIPアドレスにします。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
String, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
OSが選んだ先頭のアドレスを1つ返します。名前のキャッシュは持ちません。
resolve_async
resolve_async(host: String) -> await String, Errホスト名をIPアドレスにします。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
await String, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
OSが選んだ先頭のアドレスを1つ返します。名前のキャッシュは持ちません。
dial_tcp
dial_tcp(host: String, port: int, opts: Dictionary = { }) -> GDTCPConn, Err英語原文Open a TCP connection while suspending only the caller during connection setup.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
GDTCPConn, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
dial_tcp_async
dial_tcp_async(host: String, port: int, opts: Dictionary = { }) -> await GDTCPConn, Err英語原文Open a TCP connection while suspending only the caller during connection setup.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await GDTCPConn, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
dial_tls
dial_tls(host: String, port: int, opts: Dictionary = { }) -> GDTCPConn, Err証明書を検証してTLS接続を開きます。optsにはtimeout、server_name、insecure_skip_verify、ca_file、クライアント認証用のcert_file/key_file、ALPNの候補を並べたnext_protosを指定できます。証明書ファイルのアクセス権限は別スレッドで確認します。認証に失敗しても暗号化なしの接続には切り替えません。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
GDTCPConn, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
dial_tls_async
dial_tls_async(host: String, port: int, opts: Dictionary = { }) -> await GDTCPConn, Err英語原文Open a verified TLS connection while suspending only the caller during setup.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await GDTCPConn, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
listen_tcp
listen_tcp(host: String = "127.0.0.1", port: int = 0) -> GDTCPListener, Err英語原文Open TCP listeners and UDP packet connections.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 0 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
戻り値
GDTCPListener, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
listen_udp
listen_udp(host: String = "127.0.0.1", port: int = 0, buffer: int = 0) -> GDUDPPacketConn, Err指定したホストとポートでUDPの送受信を始めます。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 0 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
buffer | int | 0 | ソケットの受信バッファーとして要求するバイト数。 |
戻り値
GDUDPPacketConn, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
buffer=0はOSの受信バッファーをそのまま使います。正の値を指定した場合だけ変更を要求します。
is_free_async
is_free_async(port: int, host: String = "127.0.0.1") -> await bool英語原文Dispatch port checks and discovery to I/O workers.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
await bool
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
free_port_async
free_port_async(from: int = 0, host: String = "127.0.0.1") -> await int, Err0ならOSに空きポートを選ばせ、正の値ならその番号から探します。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
from | int | 0 | 探索を始めるポート。0ならOSに空きポートの選択を任せます。 |
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
待ち受けと探索の開始にはポート0を指定できます。接続先とis_free()は1..65535です。結果はその瞬間の確認で、番号を確保するものではありません。
local_addresses
local_addresses() -> PackedStringArray, ErrこのコンピューターのIPアドレスを一覧で返します。
引数
引数はありません。
戻り値
PackedStringArray, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
空の一覧とOSの失敗は区別して返します。失敗時のe.infoにはsyscall、source、source_codeが入ります。
local_addresses_async
local_addresses_async() -> await PackedStringArray, ErrこのコンピューターのIPアドレスを一覧で返します。
引数
引数はありません。
戻り値
await PackedStringArray, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
空の一覧とOSの失敗は区別して返します。失敗時のe.infoにはsyscall、source、source_codeが入ります。
is_ip
is_ip(text: String) -> bool英語原文Check whether text is an IP address.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
split_host
split_host(text: String, default_port: int = 80) -> Dictionary英語原文Split a host and port.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
text | String | 省略不可 | 調査・デコード・変換する文字列。入力自体は書き換えません。 |
default_port | int | 80 | 入力にポート番号がない場合に使うポート。 |
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。