Module resty.session.file.thread

File storage backend worker thread module

Functions

module.set (path, prefix, suffix, name, key, value, ttl, current_time[, old_key], stale_ttl[, metadata], remember) Store session data.
module.GET (path, prefix, suffix, name, key) Retrieve session data.
module.delete (path, prefix, suffix, name, key, current_time) Delete session data.
module.read_metadata (path, prefix, suffix, name, audience, subject, current_time) Read session metadata.


Functions

module.set (path, prefix, suffix, name, key, value, ttl, current_time[, old_key], stale_ttl[, metadata], remember)
Store session data.

Parameters:

  • path string the path where sessions are stored
  • prefix string the prefix for session files
  • suffix string the suffix for session files
  • name string the cookie name
  • key string session key
  • value string session value
  • ttl number session ttl
  • current_time number current time
  • old_key string old session id (optional)
  • stale_ttl string stale ttl
  • metadata table table of metadata (optional)
  • remember table whether storing persistent session or not

Returns:

  1. table or nil session metadata
  2. string error message
module.GET (path, prefix, suffix, name, key)
Retrieve session data.

Parameters:

  • path string the path where sessions are stored
  • prefix string the prefix for session files
  • suffix string the suffix for session files
  • name string cookie name
  • key string session key

Returns:

  1. string or nil session data
  2. string error message
module.delete (path, prefix, suffix, name, key, current_time)
Delete session data.

Parameters:

  • path string the path where sessions are stored
  • prefix string the prefix for session files
  • suffix string the suffix for session files
  • name string the cookie name
  • key string session key
  • current_time number current time

Returns:

  1. table or nil session metadata
  2. string error message
module.read_metadata (path, prefix, suffix, name, audience, subject, current_time)
Read session metadata.

Parameters:

  • path string the path where sessions are stored
  • prefix string the prefix for session files
  • suffix string the suffix for session files
  • name string the cookie name
  • audience string session audience
  • subject string session subject
  • current_time number current time

Returns:

  1. table or nil session metadata
  2. string error message
generated by LDoc 1.5.0 Last updated 2023-08-16 18:11:28