<?php
/*
*	Pt (PHP Toolkit)
*	Copyright (C) 2008  Dinu Florin
*
*	Pt is free software: you can redistribute it and/or modify
*	it under the terms of the GNU Lesser General Public License as published by
*	the Free Software Foundation, either version 3 of the License, or
*	any later version.
*
*	Pt 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 Lesser General Public License for more details.
*
*	You should have received a copy of the GNU Lesser General Public License
*	along with Pt.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
*	This file contains the Mutex interface.
*	Implement this interface to create a new mutex implementation.
*
*	@author		Dinu Florin <contact@florindinu.ro>
*	@package	Core
*	@subpackage	Mutex
*/

/**
*	Mutex interface.
*
*	@author	Dinu Florin <contact@florindinu.ro>
*	@package	Core
*	@subpackage	Mutex
*/
interface MutexInterface	
{
	/**
	*	Constructor.
	*	
	*	@param	string	$name	The mutex name.
	*	@see	Mutex::__construct()
	*/
	public function __construct($name);
	
	/**
	*	Lock the mutex.
	*/
	public function lock();
	
	/**
	*	Unlock the mutex.
	*/
	public function unlock();
	
	/**
	*	Check if this class can be instantiated. This will check if the proper PHP extensions are installed
	*	and if the requirements are met to use the mechanism that this class implements.
	*
	*	@return	boolean
	*/
	public static function canInstantiate();
}
?>