gdドキュメント0.8.0

APIリファレンス

GDTCPConn

TCPまたはTLSの接続です。読み取りと書き込みはそれぞれ受付順に進みます。タイムアウトを設定でき、close()を呼ぶと待機中の処理も終了します。

メソッド

read

read(max: int = 65536) -> PackedByteArray, Err
英語原文

Start reading, suspending only this caller until bytes arrive.

引数

名前型省略時の値説明
maxint655361回の受信で要求する最大バイト数。

戻り値

PackedByteArray, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

read_async

read_async(max: int = 65536) -> await PackedByteArray, Err
英語原文

Start reading, suspending only this caller until bytes arrive.

引数

名前型省略時の値説明
maxint655361回の受信で要求する最大バイト数。

戻り値

await PackedByteArray, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

write

write(data: PackedByteArray) -> int, Err
英語原文

Start writing, suspending only this caller until all bytes reach the kernel.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。

戻り値

int, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

write_async

write_async(data: PackedByteArray) -> await int, Err
英語原文

Start writing, suspending only this caller until all bytes reach the kernel.

引数

名前型省略時の値説明
dataPackedByteArray省略不可処理するデータ。上に示した引数の型に合わせて渡します。

戻り値

await int, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

start_tls

start_tls(host: String, opts: Dictionary = {  }) -> GDTCPConn, Err

既存の平文TCP接続を同じ相手との検証済みTLS接続へ切り替えます。読み書きが待機中なら失敗します。成功時は返された接続を使います。

引数

名前型省略時の値説明
hostString省略不可接続または待ち受けに使うホスト名・IPアドレス。
optsDictionary{ }処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。

戻り値

GDTCPConn, Err

この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

start_tls_async

start_tls_async(host: String, opts: Dictionary = {  }) -> await GDTCPConn, Err
英語原文

Upgrade a quiet plaintext connection to verified TLS.

引数

名前型省略時の値説明
hostString省略不可接続または待ち受けに使うホスト名・IPアドレス。
optsDictionary{ }処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。

戻り値

await GDTCPConn, Err

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。

set_deadline

set_deadline(seconds: float) -> Err
英語原文

Set both I/O deadlines in seconds from now.

引数

名前型省略時の値説明
secondsfloat省略不可秒単位の期限設定。相対時間や期限解除の扱いはメソッドの説明に従います。

戻り値

Err

エラー

Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。

set_read_deadline

set_read_deadline(seconds: float) -> Err
英語原文

Set the read deadline, including reads already waiting.

引数

名前型省略時の値説明
secondsfloat省略不可秒単位の期限設定。相対時間や期限解除の扱いはメソッドの説明に従います。

戻り値

Err

エラー

Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。

set_write_deadline

set_write_deadline(seconds: float) -> Err
英語原文

Set the write deadline, including writes already waiting.

引数

名前型省略時の値説明
secondsfloat省略不可秒単位の期限設定。相対時間や期限解除の扱いはメソッドの説明に従います。

戻り値

Err

エラー

Errオブジェクトを直接返します。処理結果とErrの2つを返す形式ではありません。エラーが見つからない場合などはnullを返します。詳しい条件は、この関数の説明を参照してください。

local_addr

local_addr() -> Dictionary
英語原文

Return the local TCP address.

引数

引数はありません。

戻り値

Dictionary

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

remote_addr

remote_addr() -> Dictionary
英語原文

Return the remote TCP address.

引数

引数はありません。

戻り値

Dictionary

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

connection_state

connection_state() -> Dictionary

TLS接続の状態をhandshake_complete、server_name、negotiated_protocol、versionで返します。接続処理中のデータを直接参照せず、確認できた状態を返します。versionは未確定なら0、TLS 1.2なら771、TLS 1.3なら772です。

引数

引数はありません。

戻り値

Dictionary

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

is_open

is_open() -> bool
英語原文

Check whether the TCP stream permits I/O.

引数

引数はありません。

戻り値

bool

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

close

close() -> void
英語原文

Close the TCP stream and wake every pending operation.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。