/** 
 * @file llthreadwatchdog.h
 * @brief The LLThreadWatchdog class declaration
 *
 * $LicenseInfo:firstyear=2007&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * 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;
 * version 2.1 of the License only.
 * 
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLTHREADWATCHDOG_H
#define LL_LLTHREADWATCHDOG_H

#include <boost/function.hpp>

#ifndef LL_TIMER_H					
	#include "lltimer.h"
#endif

// LLWatchdogEntry is the interface used by the tasks that 
// need to be watched.
class LLWatchdogEntry
{
public:
	LLWatchdogEntry();
	virtual ~LLWatchdogEntry();

	// isAlive is accessed by the watchdog thread.
	// This may mean that resources used by 
	// isAlive and other method may need synchronization.
	virtual bool isAlive() const = 0;
	virtual void reset() = 0;
	virtual void start();
	virtual void stop();
};

class LLWatchdogTimeout : public LLWatchdogEntry
{
public:
	LLWatchdogTimeout();
	virtual ~LLWatchdogTimeout();

	/* virtual */ bool isAlive() const;
	/* virtual */ void reset();
	/* virtual */ void start() { start(""); }
	/* virtual */ void stop();

	// <FS:ND> Change from std::string to char const*, saving a lot of object construction/destruction per frame

	// void start(const std::string& state); 
	// void setTimeout(F32 d);
	// void ping(const std::string& state);
	// const std::string& getState() {return mPingState; }

	void start( char const *state); 
	void setTimeout(F32 d);
	void ping( char const *state );
	std::string getState() {return mPingState; }

	// </FS:ND>

private:
	LLTimer mTimer;
	F32 mTimeout;

	// <FS:ND> Change from std::string to char const*, saving a lot of object construction/destruction per frame

	// std::string mPingState;
	char const *mPingState;

	// </FS:ND>
};

class LLWatchdogTimerThread; // Defined in the cpp
class LLWatchdog : public LLSingleton<LLWatchdog>
{
	LLSINGLETON(LLWatchdog);
	~LLWatchdog();

public:
	// Add an entry to the watchdog.
	void add(LLWatchdogEntry* e);
	void remove(LLWatchdogEntry* e);

	void init();
	void run();
	void cleanup();
    
private:
	void lockThread();
	void unlockThread();

	typedef std::set<LLWatchdogEntry*> SuspectsRegistry;
	SuspectsRegistry mSuspects;
	LLMutex* mSuspectsAccessMutex;
	LLWatchdogTimerThread* mTimer;
	U64 mLastClockCount;
};

#endif // LL_LLTHREADWATCHDOG_H
