simgear/io/AbstractRepository.hxx

   1 // AbstractRepository.hxx - API for terrasyc to access remote server
   2 //
   3 // Copyright (C) 2016  James Turner <zakalawe@mac.com>
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18
  19
  20 #ifndef SG_IO_ABSTRACT_REPOSITORY_HXX
  21 #define SG_IO_ABSTRACT_REPOSITORY_HXX
  22
  23 #include <string>
  24
  25 #include <simgear/misc/sg_path.hxx>
  26
  27 namespace simgear  {
  28
  29   namespace HTTP {
  30     class Client;
  31   }
  32
  33 class AbstractRepository
  34 {
  35 public:
  36
  37     virtual ~AbstractRepository();
  38
  39     virtual SGPath fsBase() const = 0;
  40
  41     virtual void setBaseUrl(const std::string& url) =0;
  42     virtual std::string baseUrl() const = 0;;
  43
  44     virtual HTTP::Client* http() const = 0;
  45
  46     virtual void update() = 0;
  47
  48     virtual bool isDoingSync() const = 0;
  49
  50     virtual size_t bytesStillToDownload() const;
  51
  52     enum ResultCode {
  53         REPO_NO_ERROR = 0,
  54         REPO_ERROR_NOT_FOUND,
  55         REPO_ERROR_SOCKET,
  56         SVN_ERROR_XML,
  57         SVN_ERROR_TXDELTA,
  58         REPO_ERROR_IO,
  59         REPO_ERROR_CHECKSUM,
  60         REPO_ERROR_FILE_NOT_FOUND,
  61         REPO_ERROR_HTTP,
  62         REPO_PARTIAL_UPDATE
  63     };
  64
  65     virtual ResultCode failure() const = 0;
  66   protected:
  67
  68 };
  69
  70 } // of namespace simgear
  71
  72 #endif // of SG_IO_ABSTRACT_REPOSITORY_HXX