class CGI::Session::PStore

基于 PStore 的会话存储类。

这建立在库文件 pstore.rb 提供的顶层 PStore 类的基础上。Session 数据被编组并存储在文件中。提供了 File 锁定和事务服务。

公共类方法

源代码

# File lib/cgi/session/pstore.rb, line 46
def initialize(session, option={})
  option = {'suffix'=>''}.update(option)
  path, @hash = session.new_store_file(option)
  @p = ::PStore.new(path)
  @p.transaction do |p|
    File.chmod(0600, p.path)
  end
end

创建一个新的 CGI::Session::PStore 实例

此构造函数由 CGI::Session 内部使用。用户通常不需要直接调用它。

session 是要为其创建此实例的会话。会话 ID 必须只包含字母数字字符；自动生成的会话 ID 会遵守此要求。

option 是初始化器的选项哈希。以下选项会被识别：

tmpdir: 用于存储 PStore 文件的目录。默认为 Dir::tmpdir (在 Unix 系统上通常为 “/tmp”)。
prefix: 在为该会话的 PStore 文件生成文件名时，添加到会话 ID 的前缀。默认为空字符串。

如果不存在此会话的 PStore 文件，则会创建该文件，如果存在，则会打开该文件。

公共实例方法

close ()

源代码

# File lib/cgi/session/pstore.rb, line 75
def close
  update
end

更新并关闭会话的 PStore 文件。

delete ()

源代码

# File lib/cgi/session/pstore.rb, line 80
def delete
  path = @p.path
  File::unlink path
end

关闭并删除会话的 PStore 文件。

restore ()

源代码

# File lib/cgi/session/pstore.rb, line 58
def restore
  unless @hash
    @p.transaction do
      @hash = @p['hash'] || {}
    end
  end
  @hash
end

从会话的 PStore 文件中恢复会话状态。

以哈希形式返回会话状态。

update ()

源代码

# File lib/cgi/session/pstore.rb, line 68
def update
  @p.transaction do
    @p['hash'] = @hash
  end
end

将会话状态保存到会话的 PStore 文件中。