gdドキュメント0.8.0

APIリファレンス

GDTCPListener

TCP接続を待ち受けます。待ち時間を制限でき、close()を呼ぶと受付待ちの処理も終了します。

メソッド

accept

accept() -> GDTCPConn, Err
英語原文

Start accepting the next TCP connection.

引数

引数はありません。

戻り値

GDTCPConn, Err

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

エラー

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

accept_async

accept_async() -> await GDTCPConn, Err
英語原文

Start accepting the next TCP connection.

引数

引数はありません。

戻り値

await GDTCPConn, Err

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

エラー

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

set_deadline

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

Set the accept deadline in seconds from now.

引数

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

戻り値

Err

エラー

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

addr

addr() -> Dictionary
英語原文

Return the listen address.

引数

引数はありません。

戻り値

Dictionary

エラー

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

is_open

is_open() -> bool
英語原文

Check whether the listener is open.

引数

引数はありません。

戻り値

bool

エラー

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

close

close() -> void
英語原文

Close the listener and wake all pending accepts.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

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