/*

Copyright (c) 2002-2005, Yauheni Akhotnikau
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

- The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.

*/

/*
	ObjESSty-1
*/
#if !defined( _OESS_1__DB__STORAGE__DIRTY_PAGE_STORAGE_HPP_ )
#define _OESS_1__DB__STORAGE__DIRTY_PAGE_STORAGE_HPP_

#include <memory>

#include <cpp_util_2/h/nocopy.hpp>

#include <oess_1/db/h/declspec.hpp>

#include <oess_1/defs/h/types.hpp>

#include <oess_1/db/storage/h/loaded_page.hpp>

namespace oess_1 {

namespace db {

namespace storage {

//
// dirty_page_actor_t
//

/*!
	\since v.1.3.1
	\brief Базовый класс для функтора, который будет выполнять
		какие-то действия над страницами в dirty page storage.
*/
class	OESS_1__DB__TYPE	dirty_page_actor_t
	:	private cpp_util_2::nocopy_t
	{
	public :
		virtual ~dirty_page_actor_t();

		//! Этот метод должен быть переопределен в производных классах.
		virtual void
		operator()(
			//! Индекс страницы в файле БД.
			oess_1::uint_t page_ordinal,
			//! Значение страницы.
			const oess_1::char_t * page,
			//! Исходное значение страницы.
			//! Значение 0 указывает, что исходного значения не было,
			//! т.к. страница была создана в файле.
			//! Исходное значение учитывается только при первом
			//! помещении страницы в хранилище грязных страниц.
			const oess_1::char_t * source_value,
			//! Размер страницы в байтах.
			oess_1::uint_t page_size ) = 0;
	};

//
// dirty_page_storage_t
//

/*!
	\since v.1.3.1
	\brief Интерфейс хранилища грязных страниц, в которое выталкиваются
		грязные страницы из кэша при проведении транзакции.
*/
class	OESS_1__DB__TYPE	dirty_page_storage_t
	:	private cpp_util_2::nocopy_t
	{
	public :
		virtual ~dirty_page_storage_t();

		//! Поместить страницу в хранилище.
		/*!
			Если такая страница в хранилище уже была, то ничего не делается.
		*/
		virtual void
		put(
			const ref_loaded_page_t & page ) = 0;

		//! Попробовать получить значение страницы из хранилища.
		/*!
			Если страница найдена, то в \a page помещается ссылка
			на значение страницы.
 
			\note Возвращеные значения действительны только до
				ближайшего вызова clear().

			\return true, если страница найдена. В противном случае
				возвращается false.
		*/
		virtual bool
		find(
			//! Индекс страницы в файле БД.
			oess_1::uint_t page_ordinal,
			//! Приемник ссылки на страницу.
			ref_loaded_page_t & receiver ) const = 0;

		//! Выполнить действия над всеми страницами хранилища.
		/*!
			\note Для повышения эффективности операций над БД
				необходимо, чтобы хранилище осуществляло
				переход от станиц с меньшими индексами к страницам
				с большими индексами.
		*/
		virtual void
		for_each( dirty_page_actor_t & actor ) const = 0;

		//! Очистить хранилище.
		/*!
			Должен вызываться при завершении транзакций.
		*/
		virtual void
		clear() = 0;

		//! Количество страниц в хранилище.
		/*!
			\return количество страниц, которые были помещены
				в хранилище после последнего вызова clear.

			Значение 0 означает, что в течении транзакции не было
			изменено ни одной страницы.
		*/
		virtual oess_1::uint_t
		size() const = 0;
	};

//
// create_std_dirty_page_storage
//

/*!
	\since v.1.3.1
	\brief Создать штатную реализацию хранилища грязных страниц.

	\return указатель на динамически созданный объект.
*/
std::auto_ptr< dirty_page_storage_t >
create_std_dirty_page_storage();

} /* namespace storage */

} /* namespace db */

} /* namespace oess */

#endif

