moodle/lib/classes/session/handler.php
Petr Škoda 6ec361c6bc MDL-42485 add session lock acquire timeout to memcached session driver
Credit goes to Eric Merrill, thanks!
2013-10-27 16:05:12 +01:00

72 lines
1.9 KiB
PHP

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Session handler base.
*
* @package core
* @copyright 2013 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\session;
defined('MOODLE_INTERNAL') || die();
/**
* Session handler base.
*
* @package core
* @copyright 2013 Petr Skoda {@link http://skodak.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class handler {
/**
* Start the session.
* @return bool success
*/
public function start() {
return session_start();
}
/**
* Init session handler.
*/
public abstract function init();
/**
* Check for existing session with id $sid.
*
* Note: this verifies the storage backend only, not the actual session records.
*
* @param string $sid
* @return bool true if session found.
*/
public abstract function session_exists($sid);
/**
* Kill all active sessions, the core sessions table is
* purged afterwards.
*/
public abstract function kill_all_sessions();
/**
* Kill one session, the session record is removed afterwards.
* @param string $sid
*/
public abstract function kill_session($sid);
}