ProtocolPlugin.h

#pragma once
 
#include <iolink/storage/RandomAccess.h>
#include <iolink/storage/StreamAccess.h>
 
#include <ioformat/OptionMap.h>
#include <ioformat/plugin/Plugin.h>
#include <ioformat/plugin/PluginVersion.h>
 
namespace ioformat
{
 
class ProtocolPlugin : public Plugin
{
public:
  static constexpr uint64_t PLUGIN_API_VERSION = 2;
 
  inline uint64_t api() const final override { return PLUGIN_API_VERSION; }
 
  virtual const StringSet& supportedSchemes() const = 0;
 
  virtual bool exists(const std::string& uri) = 0;
 
  virtual std::shared_ptr<iolink::RandomAccess> openReader(const std::string& uri, const OptionMap& options) = 0;
 
  virtual std::shared_ptr<iolink::StreamAccess> openWriter(const std::string& uri, const OptionMap& options) = 0;
 
  virtual StringSet list(const std::string& host, const std::string& prefix, const OptionMap& options) = 0;
 
  virtual void addCredentials(const std::string& host, const std::string& user, const std::string& password) = 0;
};
 
} // end namespace ioformat
 
#define IOFORMAT_PROTOCOL_PLUGIN_TOKEN ioformat_protocol_plugin
 
#define IOFORMAT_PROTOCOL_PLUGIN_SYMBOL "ioformat_protocol_plugin"
 
#define IOFORMAT_DECLARE_PROTOCOL_PLUGIN(PLUGIN_CLASS) \
  IOFORMAT_DECLARE_PLUGIN(PLUGIN_CLASS, IOFORMAT_PROTOCOL_PLUGIN_TOKEN)