/*
    KSysGuard, the KDE System Guard
   
	Copyright (c) 1999, 2000 Chris Schlaeger <cs@kde.org>
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of version 2 of the GNU General Public
    License as published by the Free Software Foundation.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

	$Id: SensorAgent.h,v 1.2 2002/03/02 16:31:37 cschlaeg Exp $
*/

#ifndef _SensorAgent_h_
#define _SensorAgent_h_

#include <qobject.h>
#include <qptrlist.h>

class KProcess;
class KShellProcess;
class QString;

namespace KSGRD {

class SensorClient;
class SensorManager;

/**
 * This auxilliary class is used to store requests during their processing.
 */
class SensorRequest
{
public:
	SensorRequest(const QString& r, SensorClient* c, int i) :
		request(r), client(c), id(i) { }
	~SensorRequest() { }

	QString request;
	SensorClient* client;
	int id;
};

/**
 * The SensorAgent depending on the type of requested connection
 * starts a ksysguardd process or connects through a tcp connection to
 * a running ksysguardd and handles the asynchronous communication. It
 * keeps a list of pending requests that have not been answered yet by
 * ksysguardd. The current implementation only allowes one pending
 * requests. Incoming requests are queued in an input FIFO.
 */
class SensorAgent : public QObject
{
	Q_OBJECT

public:
	SensorAgent(SensorManager* sm);
	virtual ~SensorAgent();

	virtual bool start(const QString& host, const QString& shell,
					   const QString& command = "", int port = -1) = 0;

	/**
	 * This function should only be used by the the SensorManager and
	 * never by the SensorClients directly since the pointer returned by
	 * engaged is not guaranteed to be valid. Only the SensorManager knows
	 * whether a SensorAgent pointer is still valid or not.
	 *
	 * This function sends out a command to the sensor and notifies the
	 * agent to return the answer to 'client'. The 'id' can be used by the
	 * client to identify the answer. It is only passed through and never
	 * used by the SensorAgent. So it can be any value the client suits to
	 * use.
	 */
	bool sendRequest(const QString& req, SensorClient* client, int id = 0);

	const QString& getHostName() const
	{
		return (host);
	}

	virtual void getHostInfo(QString& sh, QString& cmd, int& port) const = 0;

	void unlinkClient(SensorClient* client);
	
signals:
	void reconfigure(const SensorAgent*);

protected:
	void processAnswer(const QString& buf);
	void executeCommand();

	SensorManager* sensorManager;

	bool daemonOnLine;
	bool transmitting;
	QString host;

private:
	virtual bool writeMsg(const char* msg, int len) = 0;
	virtual bool txReady() = 0;

	int state;
	QPtrList<SensorRequest> inputFIFO;
	QPtrList<SensorRequest> processingFIFO;
	QString answerBuffer;
	QString errorBuffer;
};
};
	
#endif
