APIリファレンス
GDUDPPacketConn
UDPのパケットを送受信します。パケットの区切りと送信元アドレスを保持します。待ち時間を制限でき、close()を呼ぶと待機中の処理も終了します。
メソッド
read_from(max: int = 65536) -> Dictionary, Errread_from_async(max: int = 65536) -> await Dictionary, Errwrite_to(data: PackedByteArray, host: String, port: int) -> int, Errwrite_to_async(data: PackedByteArray, host: String, port: int) -> await int, Errset_deadline(seconds: float) -> Errset_read_deadline(seconds: float) -> Errset_write_deadline(seconds: float) -> Erraddr() -> Dictionaryis_open() -> boolclose() -> void
read_from
read_from(max: int = 65536) -> Dictionary, Err次のUDPパケットを受け取ります。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
max | int | 65536 | 1回の受信で要求する最大バイト数。 |
戻り値
Dictionary, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
data、host、port、truncatedを持つ辞書を返します。パケット同士は結合されません。
read_from_async
read_from_async(max: int = 65536) -> await Dictionary, Err次のUDPパケットを受け取ります。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
max | int | 65536 | 1回の受信で要求する最大バイト数。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
data、host、port、truncatedを持つ辞書を返します。パケット同士は結合されません。
write_to
write_to(data: PackedByteArray, host: String, port: int) -> int, Err英語原文Start sending a UDP packet to an IP address.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
戻り値
int, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
write_to_async
write_to_async(data: PackedByteArray, host: String, port: int) -> await int, Err英語原文Start sending a UDP packet to an IP address.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
data | PackedByteArray | 省略不可 | 処理するデータ。上に示した引数の型に合わせて渡します。 |
host | String | 省略不可 | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 省略不可 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
戻り値
await int, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
set_deadline
set_deadline(seconds: float) -> Err英語原文Set both UDP receive and send deadlines.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
seconds | float | 省略不可 | 秒単位の期限設定。相対時間や期限解除の扱いはメソッドの説明に従います。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
set_read_deadline
set_read_deadline(seconds: float) -> Err英語原文Apply the UDP receive deadline to existing waits too.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
seconds | float | 省略不可 | 秒単位の期限設定。相対時間や期限解除の扱いはメソッドの説明に従います。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
set_write_deadline
set_write_deadline(seconds: float) -> Err英語原文Apply the UDP send deadline to existing waits too.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
seconds | float | 省略不可 | 秒単位の期限設定。相対時間や期限解除の扱いはメソッドの説明に従います。 |
戻り値
Err
エラー
Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。
addr
addr() -> Dictionary英語原文Return the UDP endpoint's listen address.
引数
引数はありません。
戻り値
Dictionary
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
is_open
is_open() -> bool英語原文Check whether the UDP endpoint is open.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
close
close() -> void英語原文Close the UDP endpoint and wake all pending operations.
引数
引数はありません。
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。