/*

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.

*/

/*!
	\since v.1.4.0
	\brief Стандарная реализация интерфейса %trace_stream_t.
*/
#if !defined( _OESS_1__DB__STORAGE__TRX__STD_TRACE_STREAM_HPP_ )
#define _OESS_1__DB__STORAGE__TRX__STD_TRACE_STREAM_HPP_

#include <memory>

#include <oess_1/db/storage/trx/h/types.hpp>

namespace oess_1 {

namespace db {

namespace storage {

namespace trx {

namespace impl
{
	class chain_ostream_t;
} /* namespace impl */

//
// std_trace_stream_t
//

/*!
	\since v.1.4.0
	\brief Стандартная реализация интерфейса %trace_stream_t.

	Данная реализация предназначена для поддержки режима trace_all.

	Методы append и reverse_replay можно вызывать только после
	успешного обращения к методам open или create.

	Методы is_exists и destroy можно вызывать вне зависимости от
	того, открыт ли trace-stream или нет.
*/
class	std_trace_stream_t
	:	public trace_stream_t
	{
	public :
		std_trace_stream_t();
		virtual ~std_trace_stream_t();

	//! \name Реализация унаследованных методов.
	//! \{
		virtual void
		open(
			const std::string & physic_name,
			const config_t & config,
			bool is_read_only );

		virtual void
		create(
			const std::string & physic_name,
			const config_t & config );

		virtual void
		destroy(
			const std::string & physic_name );

		virtual bool
		is_exists(
			const std::string & physic_name );

		virtual void
		append(
			const trace_stream_item_t & item );

		virtual void
		reverse_replay(
			committer_t & committer,
			trace_file_number_set_t * used_files = 0,
			trace_file_number_set_t * unused_files = 0,
			std::ostream * verbose_stream = 0 );

		virtual void
		close();
	//! \}

	protected :
		//! Создать объект для сохранения восстановочной информации
		//! в trace-файлах.
		/*!
			Данная реализация возвращает указатель на объект, который
			дописывает транзакции в конец существующего trace-stream не
			удаляя существующих trace-файлов.

			\return указатель на динамически созданный объект,
				ответственность за удаление которого несет
				вызывающая сторона.
		*/
		virtual std::auto_ptr< impl::chain_ostream_t >
		create_chain_ostream();

		//! Открыт ли trace-stream.
		/*!
			Метод предназначен для предоставления производным классам
			доступа к информации из данного класса.
		*/
		bool
		is_open() const;

		//! Получить физическое имя БД с которой происходит работа.
		/*!
			Метод предназначен для предоставления производным классам
			доступа к информации из данного класса.
		*/
		const std::string &
		physic_name() const;

		//! Получить конфигурацию БД.
		/*!
			Метод предназначен для предоставления производным классам
			доступа к информации из данного класса.
		*/
		const config_t &
		config() const;

		//! Получить множество идентификаторов существующих trace-файлов.
		/*!
			Метод предназначен для предоставления производным классам
			доступа к информации из данного класса.
		*/
		trace_file_number_set_t &
		all_traces();

	private :
		//! Физическое имя БД с которой происходит работа.
		/*!
			Содержит актуальное значение только после того, как
			успешно завершатся методы open() или create().
		*/
		std::string	m_physic_name;

		//! Конфигурация БД.
		/*!
			Содержит актуальное значение только после того, как
			успешно завершаться методы open() или create().
		*/
		config_t	m_config;

		//! Множество идентификаторов существующих trace-файлов.
		/*!
			Первоначально заполняется в методах open(), create().
			Далее дополняется в методе append().
		*/
		trace_file_number_set_t	m_all_traces;

		//! Признак того, что поток открыт.
		/*!
			Содержит true, если trace-поток успешно открыт и
			можно вызывать методы append() и reverse_replay.
		*/
		bool	m_is_open;

		//! Признак того, что поток открыт только для чтения.
		/*!
			Если содержит значение true, то вызывать метод
			append() нельзя.
		*/
		bool	m_is_read_only;

		//! Поток для записи трасировочной информации.
		/*!
			Создается при первом обращении к append().
		*/
		std::auto_ptr< impl::chain_ostream_t >	m_chain_ostream;
	};

//
// last_trx_only_trace_stream_t
//

/*!
	\since v.1.4.0
	\brief Реализация интерфейса %trace_stream_t для режима сохранения
		в trace-stream только последней транзакции.

	Наследует свою функциональность от std_trace_stream_t. Различие состоит
	лишь в:
	- создании chain_ostream. Данный класс создает такую реализацию
	chain_ostream, которая автоматически удаляет trace-файлы с предыдущими
	транзакциями;
	- обратном воспроизведении. Поскольку в последней транзакции заведомо
	не хватает информации для восстановления всего хранилища, поэтому
	иключение о недостаточности восстановочной информации перехватывается
	и наружу не отпускается.
*/
class	last_trx_only_trace_stream_t
	:	public std_trace_stream_t
	{
	public :
		last_trx_only_trace_stream_t();
		virtual ~last_trx_only_trace_stream_t();

	protected :
		//! Создать объект для сохранения восстановочной информации
		//! в trace-файлах.
		/*!
			Данная реализация возвращает указатель на объект, который
			создает для новой транзакции новый trace-файл, а предшествующие
			trace-файлы удаляет.

			\return указатель на динамически созданный объект,
				ответственность за удаление которого несет
				вызывающая сторона.
		*/
		virtual std::auto_ptr< impl::chain_ostream_t >
		create_chain_ostream();
	};

//
// pseudo_trace_stream_t
//

/*!
	\since v.1.4.0
	\brief Реализация интерфейса %trace_stream_t для режима, в
		котором восстановочная информация не сохраняется.

	Методы, за исключением reverse_replay, ничего не делают. Метод
	reverse_replay порождает исключение.

	Метод is_exists всегда возвращает true.
*/
class	pseudo_trace_stream_t
	:	public trace_stream_t
	{
	public :
		pseudo_trace_stream_t();
		virtual ~pseudo_trace_stream_t();

	//! \name Реализация унаследованных методов.
	//! \{
		virtual void
		open(
			const std::string & physic_name,
			const config_t & config,
			bool is_read_only );

		virtual void
		create(
			const std::string & physic_name,
			const config_t & config );

		virtual void
		destroy(
			const std::string & physic_name );

		virtual bool
		is_exists(
			const std::string & physic_name );

		virtual void
		append(
			const trace_stream_item_t & item );

		virtual void
		reverse_replay(
			committer_t & committer,
			trace_file_number_set_t * used_files = 0,
			trace_file_number_set_t * unused_files = 0,
			std::ostream * verbose_stream = 0 );

		virtual void
		close();
	//! \}
	};

} /* namespace trx */

} /* namespace storage */

} /* namespace db */

} /* namespace oess */

#endif

