gdドキュメント0.8.0

APIリファレンス

GDWebSessionStore

CookieのIDに対応するセッション情報を、有効期限付きで保存します。保存先はこのプロセス内です。

メソッド

issue

issue(value: Variant) -> String, Err
英語原文

Issue a new ID, replacing older sessions when the configured capacity is reached.

引数

名前型省略時の値説明
valueVariant省略不可保存、変換、検査など、この関数で処理する値。

戻り値

String, Err

エラー

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

take

take(id: String) -> Variant, Err
英語原文

Return a valid session and extend its idle deadline.

引数

名前型省略時の値説明
idString省略不可対応するAPIから取得した識別子。

戻り値

Variant, Err

エラー

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

drop

drop(id: String) -> void
英語原文

Invalidate the selected stored value.

引数

名前型省略時の値説明
idString省略不可対応するAPIから取得した識別子。

戻り値

void

値を返しません。

エラー

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

clear

clear() -> void
英語原文

Remove all stored values.

引数

引数はありません。

戻り値

void

値を返しません。

エラー

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

size

size() -> int
英語原文

Remove only expired index entries and return the active session count.

引数

引数はありません。

戻り値

int

エラー

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

handle

handle(req: GDWebRequest) -> Variant
英語原文

Validate or transform input before passing it to the next handler.

引数

名前型省略時の値説明
reqGDWebRequest省略不可ミドルウェアやハンドラーへ渡された現在のHTTPリクエスト。

戻り値

Variant

エラー

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