/*

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.

*/

/*!
	\file
	\brief Интерфейс хранилища потоков сущностей.
*/
#if !defined( _OESS_1__DB__STORAGE__STREAM_STORAGE_HPP_ )
#define _OESS_1__DB__STORAGE__STREAM_STORAGE_HPP_

#include <set>

#include <cpp_util_2/h/nocopy.hpp>

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

#include <oess_1/db/storage/h/chain_storage.hpp>
#include <oess_1/db/storage/h/entity_stream.hpp>

namespace oess_1 {

namespace db {

namespace storage {

/*
** stream_storage_t
*/

/*!
	\brief Интерфейс хранилища потоков сущностей.
*/
class	OESS_1__DB__TYPE	stream_storage_t
	:	private cpp_util_2::nocopy_t
	{
	public :
		virtual ~stream_storage_t();

	//! \name Методы для работы с транзакциями.
	//! \{
		//! Начать транзакцию.
		virtual void
		trans_start() = 0;

		/*!
			Зафиксировать изменения транзакции в БД.
		*/
		virtual void
		trans_commit() = 0;

		/*!
			\since v.1.3.1

			Откатить транзакцию.
		*/
		virtual void
		trans_rollback() = 0;
	//! \}

	//! \name Методы для работы с потоками сущностей.
	//! \{

		//! Создать поток.
		/*!
			Имя потока должно быть уникальным.
		*/
		virtual void 
		stream_create(
			//! Имя создаваемого потока.
			const std::string & name ) = 0;

		//! Проверить существование потока по имени.
		/*!
			\return true, если поток существует.
		*/
		virtual bool
		stream_is_exists(
			//! Имя потока, существование которого проверяется.
			const std::string & name ) const = 0;

		//! Уничтожить поток.
		/*!
			Если для этого потока ранее был получен объект
			entity_stream_t, то этот объект будет уничтожен и указатель
			на него окажется недействительным.
		*/
		virtual void
		stream_destroy(
			const std::string & name ) = 0;

		//! Получить имена всех существующих потоков.
		virtual std::set< std::string >
		stream_names() const = 0;

		//! Получить доступ к потоку по имени.
		/*!
			\note Возвращаемая ссылка остается корректной только в
				рамках одной транзакции. Ссылка может стать некорректной
				в результате отката транзакции или обращания к методу
				stream_destroy. Поэтому рекомендуется получать доступ
				к потоку только для выполнения необходимых операций без
				сохранения возвращенной ссылки на длительное время.

			\throw oess_1::logic_ex_t, если потока не существует.
		*/
		virtual entity_stream_t &
		stream_get(
			//! Имя необходимого потока.
			const std::string & name ) = 0;

		//! Получить доступ к потоку по идентификатору.
		/*!
			\note Возвращаемая ссылка остается корректной только в
				рамках одной транзакции. Ссылка может стать некорректной
				в результате отката транзакции или обращания к методу
				stream_destroy. Поэтому рекомендуется получать доступ
				к потоку только для выполнения необходимых операций без
				сохранения возвращенной ссылки на длительное время.

			\throw oess_1::logic_ex_t, если потока не существует.
		*/
		virtual entity_stream_t &
		stream_get(
			//! Идентификатор необходимого потока.
			const oess_1::uint_t & id ) = 0;
	//! \}
};

//
// create_stream_storage
//

/*!
	\since v.1.4.0
	\brief Создание нового хранилища.

	Создает необходимые файлы хранилища. Если эти файлы уже существовали,
	то они уничтожаются.

	Возвращается указатель на штатную реализацию интерфейса
	stream_storage_t. Созданная БД является открытой и с ней можно
	осуществлять работу.

	\return указатель на динамически созданный объект, ответственность за
		удаление которого несет вызывающая сторона.
*/
OESS_1__DB__FUNC(stream_storage_t *)
create_stream_storage(
	//! Физическое имя создаваемой БД.
	const std::string & physic_name,
	//! Конфигурация для новой БД.
	const config_t & config );

//
// open_stream_storage
//

/*!
	\since v.1.4.0
	\brief Открытие существующего хранилища.

	Открывает указанное хранилище и считывает оттуда объект,
	который был записан первым при создании хранилища.

	Возвращается указатель на штатную реализацию интерфейса
	stream_storage_t. Созданная БД является открытой и с ней можно
	осуществлять работу.

	\return указатель на динамически созданный объект, ответственность за
		удаление которого несет вызывающая сторона.
*/
OESS_1__DB__FUNC(stream_storage_t *)
open_stream_storage(
	//! Физическое имя открываемой БД.
	const std::string & physic_name,
	//! Конфигурация для БД.
	const config_t & config,
	//! true, если БД открывается в режиме read-only.
	bool is_read_only,
	//! true, если разрешается автоматическое восстановление БД после сбоя.
	bool is_auto_repair_enabled );

//
// is_stream_storage_exists
//

/*!
	\since v.1.4.0
	\brief Проверка существования хранилища.

	Хранилище считается существующим, если:
	- есть хотя бы один trace-файл, и
	- есть основной файл хранилища или "грязный" основной файл хранилища.
*/
OESS_1__DB__FUNC(bool)
is_stream_storage_exists(
	//! Физическое имя БД, существование которой будет проверяться.
	const std::string & physic_name );

//
// destroy_stream_storage
//

/*!
	\since v.1.4.0
	\brief Уничтожение хранилища.

	Уничтожаются все файлы, которые имеют отношение к указанному
	хранилищу.
*/
OESS_1__DB__FUNC(void)
destroy_stream_storage(
	//! Физическое имя уничтожаемой БД.
	const std::string & physic_name );

} /* namespace storage */

} /* namespace db */

} /* namespace oess_1 */

#endif
