StreamAdaptor.h

/*
  COPYRIGHT (c) 2012-2024 Esri R&D Center Zurich
  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
  Unpublished material - all rights reserved under the
  Copyright Laws of the United States and applicable international
  laws, treaties, and conventions.

  For additional information, contact:
  Environmental Systems Research Institute, Inc.
  Attn: Contracts and Legal Services Department
  380 New York Street
  Redlands, California, 92373
  USA

  email: contracts@esri.com
*/

#ifndef PRTX_STREAM_ADAPTOR_H_
#define PRTX_STREAM_ADAPTOR_H_

#include "prt/ContentType.h"
#include "prt/Cache.h"

#include "prtx/prtx.h"
#include "prtx/Content.h"
#include "prtx/URI.h"
#include "prtx/Extension.h"
#include "prtx/ResolveMap.h"

#include <string>
#include <iosfwd>
#include <memory>


namespace prtx {

class StreamAdaptor;
using StreamAdaptorPtr = std::shared_ptr<StreamAdaptor>;

class PRTX_EXPORTS_API StreamAdaptor : public Extension {
protected:
    StreamAdaptor() = default;

public:
    virtual ~StreamAdaptor() = default;

    virtual void resolve(
            ContentPtrVector&       results,    
            prt::Cache*             cache,      
            const std::wstring&     key,        
            prt::ContentType        ct,         
            prtx::ResolveMap const* resolveMap, 
            std::wstring&           warnings    
    ) const final;

    virtual std::istream* createStream(prtx::URIPtr uri) const = 0;

    virtual void destroyStream(std::istream* stream) const = 0;

    virtual prtx::Extension::ExtensionType getExtensionType() const final override {
        return Extension::ET_STREAM_ADAPTOR;
    }

    virtual prt::ContentType getContentType() const final override {
        return prt::CT_UNDEFINED;
    }
};


} // namespace prtx


#endif /* PRTX_STREAM_ADAPTOR_H_ */