класс CGI::Session::PStore

Родитель:: Объект

Класс хранения сессии на основе PStore.

Он основан на классе верхнего уровня PStore, предоставляемом файлом библиотеки pstore.rb. Данные сессии Session сериализуются и хранятся в файле. Предоставляются службы блокировки и транзакций файлов File.

Публичные методы класса

new (session, option={})

Исходный код

# 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 — это сессия, для которой создаётся этот экземпляр. Идентификатор сессии должен содержать только буквенно-цифровые символы; автоматически сгенерированные идентификаторы сессий соблюдают это требование.

option — это хеш опций для инициализатора. Признаются следующие опции:

tmpdir: каталог для хранения файла PStore. По умолчанию Dir::tmpdir (обычно «/tmp» в системах Unix).
prefix: префикс, добавляемый к идентификатору сессии при создании имени файла для файла PStore этой сессии. По умолчанию пустая строка.

Файл 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.

Ruby Core © 1993–2024 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.