gdドキュメント0.8.0

APIリファレンス

GDRedisPool

複数のRedis接続へ処理を割り振り、同時に利用できるようにします。

プールは互いに独立したコマンド用です。SELECT、MULTI、WATCH、購読など接続の状態を変えるコマンドには、専用のGDRedisClientを使います。

open()は接続先を記録するだけで、通信は最初のquery()から始まります。使用中の接続は返却まで専有し、空きが無ければ受付順に待ちます。待機中のキャンセルはほかの呼び出しに影響せず、実行中のキャンセルはその接続を閉じます。

size()は確立中を含む接続数、in_flight()は接続待ちを含む未完了の呼び出し数です。

メソッド

open

open(host: String = "127.0.0.1", port: int = 6379, opts: Dictionary = {  }, size: int = 0) -> Variant, Err
英語原文

Configure the destination without creating physical connections until the first query.

引数

名前型省略時の値説明
hostString"127.0.0.1"接続または待ち受けに使うホスト名・IPアドレス。
portint6379ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。
optsDictionary{ }処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。
sizeint0プールに用意する物理接続の数。

戻り値

Variant, Err

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

エラー

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

query

query(cmd: String, args: Array = []) -> Variant, Err
英語原文

Borrow a connection exclusively, waiting for return when the pool is at capacity.

引数

名前型省略時の値説明
cmdString省略不可コマンド名。引数の値は別に渡します。
argsArray[]関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。

戻り値

Variant, Err

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

エラー

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

open_async

open_async(host: String = "127.0.0.1", port: int = 6379, opts: Dictionary = {  }, size: int = 0) -> await Variant, Err
英語原文

Configure the destination without creating physical connections until the first query.

引数

名前型省略時の値説明
hostString"127.0.0.1"接続または待ち受けに使うホスト名・IPアドレス。
portint6379ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。
optsDictionary{ }処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。
sizeint0プールに用意する物理接続の数。

戻り値

await Variant, Err

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

エラー

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

query_async

query_async(cmd: String, args: Array = []) -> await Variant, Err
英語原文

Borrow a connection exclusively, waiting for return when the pool is at capacity.

引数

名前型省略時の値説明
cmdString省略不可コマンド名。引数の値は別に渡します。
argsArray[]関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。

戻り値

await Variant, Err

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

エラー

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

close

close() -> void
英語原文

Close waiters and borrowed connections first so reopening cannot inherit stale work.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

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

size

size() -> int
英語原文

Return the number of physical connections currently owned by this pool.

引数

引数はありません。

戻り値

int

エラー

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

in_flight

in_flight() -> int
英語原文

Return the number of active queries.

引数

引数はありません。

戻り値

int

エラー

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