downloadInterface.h

Go to the documentation of this file.

/* -*- Mode: c++ -*- */
/*
 *  this is part of Spm
 *
 *  Copyright (c) 2005 Guillaume Chevallereau
 *
 *  This program is free software. You can redistribute it and/or modify it 
 *  under the terms of the GNU General Public License as published by the 
 *  Free Software Foundation. Either version 2 of the license or (at your 
 *  option) any later version.
 *
 *  This program is distributed in the hope that it will be usefull 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., 
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
 */
#ifndef __DOWNLOAD_INTERFACE_H__
#define __DOWNLOAD_INTERFACE_H__

#include <map>
#include "interface.h"
#include <boost/filesystem/path.hpp>
#include <util/net.h>

#define SPM_DOWNLOADER_PLUGIN(plugin)                                   \
  extern "C"                                                            \
  {                                                                     \
    Spm::Plugin::pluginDescription_t getSpmPluginDescription ()         \
    {                                                                   \
      return plugin ().getDescription ();                               \
    }                                                                   \
                                                                        \
    plugin * getSpmPluginInfo ()                                        \
    {                                                                   \
      return new plugin ();                                             \
    }                                                                   \
                                                                        \
    plugin * getSpmPlugin (const Spm::Util::urlDetails & url)           \
    {                                                                   \
      return new plugin (url);                                          \
    }                                                                   \
  }

namespace Spm
{
  namespace Plugin
  {
    class DownloadInterface : public Interface
    {
    protected :
      double fractionDone;
      Util::urlDetails url;

      DownloadInterface ()
      {
        description_.pluginType_ = DOWNLOAD_TYPE;
      }
      
      DownloadInterface (const Util::urlDetails & u)
      {
        url = u;
        fractionDone = -1;
        description_.pluginType_ = DOWNLOAD_TYPE;
      }

    public :
      virtual ~DownloadInterface (){};
      virtual void download (const miniXml::ustring & uri, 
                             const boost::filesystem::path & to) = 0;
      virtual bool handle (const miniXml::ustring & uri) = 0;

      double getFractionDone ()
      {
        return fractionDone;
      }
    };
  }
}

#endif

---