APIリファレンス
GDWebSessionStore
CookieのIDに対応するセッション情報を、有効期限付きで保存します。保存先はこのプロセス内です。
メソッド
issue(value: Variant) -> String, Errtake(id: String) -> Variant, Errdrop(id: String) -> voidclear() -> voidsize() -> intcookie(id: String, secure: bool = true) -> Stringclear_cookie(secure: bool = true) -> Stringhandle(req: GDWebRequest) -> Variant
issue
issue(value: Variant) -> String, Err英語原文Issue a new ID, replacing older sessions when the configured capacity is reached.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
value | Variant | 省略不可 | 保存、変換、検査など、この関数で処理する値。 |
戻り値
String, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
take
take(id: String) -> Variant, Err英語原文Return a valid session and extend its idle deadline.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | String | 省略不可 | 対応するAPIから取得した識別子。 |
戻り値
Variant, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
drop
drop(id: String) -> void英語原文Invalidate the selected stored value.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | String | 省略不可 | 対応する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を返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
cookie
cookie(id: String, secure: bool = true) -> String英語原文Build a safe Cookie header for a session ID.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
id | String | 省略不可 | 対応するAPIから取得した識別子。 |
secure | bool | true | CookieをSecure属性によりHTTPSへ制限するかどうか。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
clear_cookie
clear_cookie(secure: bool = true) -> String英語原文Build a header that deletes the session cookie.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
secure | bool | true | CookieをSecure属性によりHTTPSへ制限するかどうか。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
handle
handle(req: GDWebRequest) -> Variant英語原文Validate or transform input before passing it to the next handler.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
req | GDWebRequest | 省略不可 | ミドルウェアやハンドラーへ渡された現在のHTTPリクエスト。 |
戻り値
Variant
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。