remote_cache_provider.hpp

//--------------------------------------------------------------------------------------------------
// Copyright (c) 2019 Marcus Geelnard
//
// This software is provided 'as-is', without any express or implied warranty. In no event will the
// authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose, including commercial
// applications, and to alter it and redistribute it freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not claim that you wrote
//     the original software. If you use this software in a product, an acknowledgment in the
//     product documentation would be appreciated but is not required.
//
//  2. Altered source versions must be plainly marked as such, and must not be misrepresented as
//     being the original software.
//
//  3. This notice may not be removed or altered from any source distribution.
//--------------------------------------------------------------------------------------------------
 
#ifndef BUILDCACHE_REMOTE_CACHE_PROVIDER_HPP_
#define BUILDCACHE_REMOTE_CACHE_PROVIDER_HPP_
 
#include <cache/cache_entry.hpp>
#include <cache/expected_file.hpp>
 
#include <map>
#include <string>
 
namespace bcache {
 
class remote_cache_provider_t {
public:
  virtual ~remote_cache_provider_t();
 
  virtual bool connect(const std::string& host_description) = 0;
 
  virtual bool is_connected() const = 0;
 
  virtual cache_entry_t lookup(const std::string& hash) = 0;
 
  virtual void add(const std::string& hash,
                   const cache_entry_t& entry,
                   const std::map<std::string, expected_file_t>& expected_files) = 0;
 
  virtual void get_file(const std::string& hash,
                        const std::string& source_id,
                        const std::string& target_path,
                        const bool is_compressed) = 0;
 
protected:
  // Constructor called by child classes.
  remote_cache_provider_t();
 
  static bool parse_host_description(const std::string& host_description,
                                     std::string& host,
                                     int& port,
                                     std::string& path);
 
  static int connection_timeout_ms();
 
  static int transfer_timeout_ms();
 
private:
  // Prohibit copy & assignment.
  remote_cache_provider_t(const remote_cache_provider_t&) = delete;
  remote_cache_provider_t& operator=(const remote_cache_provider_t&) = delete;
};
 
}  // namespace bcache
 
#endif  // BUILDCACHE_REMOTE_CACHE_PROVIDER_HPP_