APIリファレンス
GDRedisClient
1つのRedis接続を操作します。通常の関数は呼び出した処理だけを待たせ、_async付きの関数はSignalを返します。
メソッド
open(host: String = "127.0.0.1", port: int = 6379, opts: Dictionary = { }) -> Variant, Errquery(cmd: String, args: Array = []) -> Variant, Errpipeline(cmds: Array) -> Array, Errtransaction(cmds: Array) -> Array, Errsubscribe(channels: PackedStringArray) -> Variant, Erropen_async(host: String = "127.0.0.1", port: int = 6379, opts: Dictionary = { }) -> await Variant, Errquery_async(cmd: String, args: Array = []) -> await Variant, Errpipeline_async(cmds: Array) -> await Array, Errtransaction_async(cmds: Array) -> await Array, Errsubscribe_async(channels: PackedStringArray) -> await Variant, Erris_open() -> boolis_subscribed() -> boolin_flight() -> intclose() -> void
open
open(host: String = "127.0.0.1", port: int = 6379, opts: Dictionary = { }) -> Variant, Err英語原文Connect and immediately authenticate when a password is supplied. Return a signal whose completion carries a value and an Err.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 6379 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query
query(cmd: String, args: Array = []) -> Variant, Errコマンドの結果とErrを返します。値がなければNOT_FOUNDで、info.codeはnilです。配列内のnullはそのまま残し、バイナリデータはPackedByteArrayで保持します。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
cmd | String | 省略不可 | コマンド名。引数の値は別に渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
Variant, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
WATCHによる中断はErr.INTERRUPTEDで、e.info.codeは"tx_failed"です。1回の送信の大きさはサーバー側の設定に従います。
pipeline
pipeline(cmds: Array) -> Array, Errコマンドが1件の場合も、コマンド順のArrayを返します。失敗時も受信済みの結果は残し、受信できなかった位置にErrを入れます。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
cmds | Array | 省略不可 | コマンドと引数の値で表した、実行順のコマンド列。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
transaction
transaction(cmds: Array) -> Array, Err各コマンドの結果とErrを返します。WATCHによる中断はINTERRUPTEDで、info.codeはtx_failedです。あるコマンドが失敗しても、ほかのコマンドの結果は残ります。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
cmds | Array | 省略不可 | コマンドと引数の値で表した、実行順のコマンド列。 |
戻り値
Array, Err
この関数は、呼び出した処理だけを待たせ、完了すると結果を返します。待っている間もほかの処理は進みます。awaitを書く必要はありません。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
subscribe
subscribe(channels: PackedStringArray) -> Variant, Err英語原文Begin subscription reads and emit message for each received item.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
channels | PackedStringArray | 省略不可 | 購読するチャネル名。 |
戻り値
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 = { }) -> await Variant, Err英語原文Connect and immediately authenticate when a password is supplied. Return a signal whose completion carries a value and an Err.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
host | String | "127.0.0.1" | 接続または待ち受けに使うホスト名・IPアドレス。 |
port | int | 6379 | ネットワークのポート番号。待ち受け時の0はOSがポートを選びます。 |
opts | Dictionary | { } | 処理の設定を名前と値で指定する辞書。省略した項目には、この関数の既定値が使われます。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
query_async
query_async(cmd: String, args: Array = []) -> await Variant, Errコマンドの結果とErrを返します。値がなければNOT_FOUNDで、info.codeはnilです。配列内のnullはそのまま残し、バイナリデータはPackedByteArrayで保持します。
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
cmd | String | 省略不可 | コマンド名。引数の値は別に渡します。 |
args | Array | [] | 関数へ渡す引数、またはSQL文中のプレースホルダーに渡す値を、順番に並べた配列。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
WATCHによる中断はErr.INTERRUPTEDで、e.info.codeは"tx_failed"です。1回の送信の大きさはサーバー側の設定に従います。
pipeline_async
pipeline_async(cmds: Array) -> await Array, Err英語原文Send a pipeline and collect replies as an array in one round trip. Each command has the form ["SET", "k", "v"].
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
cmds | Array | 省略不可 | コマンドと引数の値で表した、実行順のコマンド列。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
transaction_async
transaction_async(cmds: Array) -> await Array, Err英語原文Wrap commands in MULTI and EXEC for transactional execution.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
cmds | Array | 省略不可 | コマンドと引数の値で表した、実行順のコマンド列。 |
戻り値
await Array, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
subscribe_async
subscribe_async(channels: PackedStringArray) -> await Variant, Err英語原文Begin subscription reads and emit message for each received item.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
channels | PackedStringArray | 省略不可 | 購読するチャネル名。 |
戻り値
await Variant, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
is_open
is_open() -> bool英語原文---------------- Connections ----------------
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
is_subscribed
is_subscribed() -> bool英語原文Return whether this connection is in subscription mode.
引数
引数はありません。
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
in_flight
in_flight() -> int英語原文Count commands queued for encoding or awaiting server replies.
引数
引数はありません。
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
close
close() -> void英語原文Close and release retained resources.
引数
引数はありません。
戻り値
void
値を返しません。
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。