/** 
 * @file lllogtextmessage.h
 * @author Phoenix
 * @date 2005-01-11
 * @brief Declaration of class for coalescing text logs generated
 * from chat and IM
 *
 * $LicenseInfo:firstyear=2005&license=viewergpl$
 * 
 * Copyright (c) 2005-2007, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlife.com/developers/opensource/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at http://secondlife.com/developers/opensource/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LL_LLLOGTEXTMESSAGE_H
#define LL_LLLOGTEXTMESSAGE_H

#include <deque>
#include <string>

#include "lluuid.h"
#include "llhost.h"

/** 
 * @class LLLogTextMessage
 * @brief This class represents a coalesced collection of text messages
 * generated by agents and their objects.
 *
 * This class is intended to be used as a singleton. Since use on the
 * simulator and userserver is somewhat different the class does not
 * enforce a singleton or provide an extern.
 */
class LLLogTextMessage
{
public:
	LLLogTextMessage(const LLHost& dataserver) :
		mDataserver(dataserver),
		mPendingSize(0) {}
	~LLLogTextMessage();

	void log(const LLUUID& from, const LLUUID& to, const char* mesg);
	void log(const LLUUID& from, F64 global_x, F64 global_y, const char* mesg);
	void log(
		const LLUUID& from,
		const LLUUID& to,
		F64 global_x,
		F64 global_y,
		const char* mesg);
	void flush();

protected:
	struct LLLogTextMessageData
	{
		LLLogTextMessageData(
			const LLUUID& from,
			const LLUUID& to,
			const F64& global_x,
			const F64& gloabl_y,
			const char* message);
		LLUUID mFromID;
		LLUUID mToID;
		F64 mGlobalX;
		F64 mGlobalY;
		std::string mMessage;
		S32 mTime;
	};

	// The destination of the messages
	LLHost mDataserver;

	// Keep the messages queued in order of arrival.
	std::deque<LLLogTextMessageData> mQueue;

	// Tracks the outgoing message size in bytes of the pending queued
	// text logs.
	S32 mPendingSize;
};

#endif // LL_LLLOGTEXTMESSAGE_H