/*
 * libosengine - A synchronization engine for the opensync framework
 * Copyright (C) 2004-2005  Armin Bauer <armin.bauer@opensync.org>
 * 
 * This library 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 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 * 
 */
 
#ifndef OPENSYNC_SINK_ENGINE_INTERNALS_H_
#define OPENSYNC_SINK_ENGINE_INTERNALS_H_

/** @brief OSyncSinkEngine struct members 
 *
 **/
struct OSyncSinkEngine {
	/** Reference counting */
	int ref_count;
	/** Position of OSyncSinkEngine in OSyncObjEngine */
	int position;
	/** Pointer to assinged OSyncClientProxy */
	OSyncClientProxy *proxy;
	/** Pointer to assinged OSyncObjEngine */
	OSyncObjEngine *engine;
	/** List of assinged OSyncMappingEntryEngine elements */
	OSyncList *entries;
	/** List of assinged OSyncMappingEntryEngine elemebts, but unmapped (no counter-entry) */
	OSyncList *unmapped;
};

OSyncSinkEngine *osync_sink_engine_new(int position, OSyncClientProxy *proxy, OSyncObjEngine *objengine, OSyncError **error);
OSyncSinkEngine *osync_sink_engine_ref(OSyncSinkEngine *engine);
void osync_sink_engine_unref(OSyncSinkEngine *engine);
osync_bool osync_sink_engine_is_connected(OSyncSinkEngine *engine);

/** @brief Demerge all entries of OSyncSinkEngine
 *
 * If the Member/Client of the OSyncSinkEngine doesn't have capabilities
 * this functions is NOOP and just returns with TRUE, without error.
 *
 * Changes with a current OSyncObjFormat, without merge/demerge get skipped.
 *
 * @param engine Pointer to an OSyncSinkEngine which should demerge
 * @param archive Pointer to an OSyncArchive to store the dermerged information
 * @param error Pointer to error struct, which get set on any error
 * @returns TRUE on success, FALSE otherwise
 */
osync_bool osync_sink_engine_demerge(OSyncSinkEngine *engine, OSyncArchive *archive, OSyncError **error);

/** @brief Convert all entries of OSyncSinkEngine to destitination format
 *
 * This function converters all entries of the OSyncSinkEngine to the member
 * preferd/requested format (destination).
 *
 * @param engine Pointer to an OSyncSinkEngine which should convert 
 * @param formatenv Pointer to an OSyncFormatEnv for plugins to use
 * @param error Pointer to error struct, which get set on any error
 * @returns TRUE on success, FALSE otherwise
 */
osync_bool osync_sink_engine_convert_to_dest(OSyncSinkEngine *engine, OSyncFormatEnv *formatenv, OSyncError **error);

/** @brief Write/commit all entries of OSyncSinkEngine to the client/peer
 *
 * This function writes/commits all entries of the OSyncSinkEngine to the member.
 *
 * @param engine Pointer to an OSyncSinkEngine which should write 
 * @param archive Pointer to an OSyncArchive to update the mappings
 * @param error Pointer to error struct, which get set on any error
 * @returns TRUE on success, FALSE otherwise
 */
osync_bool osync_sink_engine_write(OSyncSinkEngine *engine, OSyncArchive *archive, OSyncError **error);

#endif /*OPENSYNC_SINK_ENGINE_INTERNALS_H_*/