/include/nnet.h

/* $Id: nnet.h,v 1.25 2003/10/13 20:29:32 ndiin Exp $
 *
 * nnet.h Parent Network Protocol Interface
 *
 *    Written by Eric Andresen
 *
 * Copyright 2002-2003 Eric Andresen
 * See COPYING for license information
 */

#ifndef NNET_H
#define NNET_H

#include <qstring.h>
#include <qcstring.h>
#include <qcache.h>
#include <qdatetime.h>
#include <qurlinfo.h>
#include <qsocket.h>
#include <qsocketdevice.h>
#include "nhostinfo.h"

class NNet : public QObject
{
   Q_OBJECT
public:
   struct DirCache {
      QDateTime time;         
      QCString  dirListing;   
   };

   NNet( int id, QObject *parent = 0, const char *name = 0 );

   virtual ~NNet();

   enum logType {
      NERR=0,     
      NINFO,      
      NREPLY,     
      NCOMMAND,   
      NCUSTOM,    
      NOTHER      
   };
   enum errorType {
      ErrNo=0,                
      ErrHostInvalid,         
      ErrHostNotFound,        
      ErrConnectionRefused,   
      ErrNotConnected,        
      ErrConnected,           
      ErrSocketBusy,          
      ErrFileSeek,            
      ErrUnknown              
   };
   enum Operations {
      OpList=0,      
      OpGet,         
      OpPut,         
      OpCWD,         
      OpFxp,         
      OpRemove,      
      OpRaw,         
      OpIdle,        
      OpConnecting,  
      OpInvalid      
   };

   virtual const char* protocol() const = 0;

   virtual const char* name() const { return protocol(); };

   virtual int connectToHost(NHostInfo hInfo, bool batch = false) = 0;

   virtual int sendRawCommand(QString command) = 0;

   virtual int get(QString file, QString destfile, bool resume = false) = 0;

   virtual int put(QString file, QString sourcefile, bool resume = false) = 0;

   virtual int list() = 0;

   virtual int cd(QString dir) = 0;

   virtual int move(QString newname, QString oldname) = 0;

   virtual int remove(QString name, bool recursive = false) = 0;

   virtual int makedir(QString dir) = 0;

   virtual int abort() = 0;

   virtual const NHostInfo getHostInfo() const { return hostInfo; };

   virtual bool isConnected() const { return commandReady; };

   virtual int currentOperation() const { return currentOp; };

public slots:
   virtual int closeConnection() = 0;

signals:
   void log(int id, NNet::logType type, QString msg);

   void connectionClosed(int id, NHostInfo hInfo);

   void changedDirectory(int id, const QString& dirname);

   void connected(int id, NHostInfo hInfo);

   void transferProgress(int id, unsigned int current, unsigned int total);

   void transferComplete(int id, bool finished, uint bytes, int time, double rate);

   void directoryListing(int id, const QValueList<QUrlInfo> &dirList);

   void loginComplete(int id);

protected:
   virtual QCString findDirCache(QString dir, int timeout = -1) const;

   virtual void addDirCache(QString dir, QCString dirListing);

   virtual void clearDirCache();

   QString getAppSetting(QString setName, QString defVal = "") const;
   
   int getAppSetting(QString setName, int defVal) const;

   QString getProtSetting(QString setName, QString defVal = "") const;

   int getProtSetting(QString setName, int defVal) const;

   QString getHostSetting(QString setName, QString defVal = "") const;

   int getHostSetting(QString setName, int defVal) const;

   int _id;                      
   QSocket *commandSock;         
   QSocket *dataSock;            
   NHostInfo hostInfo;           
   bool commandDelayedClose;     
   bool dataDelayedClose;        
   bool commandReady;            
   bool expectedClose;           
   bool _batch;                  
   QCString currentDirListing;   
   Operations currentOp;         

private:
   mutable QCache<DirCache> dirCache;  
};

#endif // NNET_H

---