stream_intf.h

Go to the documentation of this file.

 
#ifndef _ADTF_UCOM_ANT_STREAM_INTERFACE_INCLUDES_HEADER_
#define _ADTF_UCOM_ANT_STREAM_INTERFACE_INCLUDES_HEADER_
 
namespace adtf
{
namespace ucom
{
namespace ant
{
 
class DOEXPORT IInputStream : public IObject
{
    public:
        ADTF_IID(IInputStream, "input_stream.ant.ucom.adtf.iid");
 
    public:
        virtual tResult Read(void* pvBuffer, size_t nBufferSize, size_t* pnBytesRead = nullptr) const = 0;
};
 
class DOEXPORT IOutputStream: public IObject
{
    public:
        ADTF_IID(IOutputStream, "output_stream.ant.ucom.adtf.iid");
 
    public:
        virtual tResult Write(const void* pvBuffer, size_t nBufferSize, size_t* pnBytesWritten = nullptr) = 0;
};
 
class DOEXPORT IStream : public IInputStream, public IOutputStream
{
public:
    ADTF_IID(IStream, "stream.ant.ucom.adtf.iid");
 
    UCOM_RESOLVE(IObject, IInputStream);
    
    public:
        static const uint8_t m_ui8PlatformByteOrder;
 
    public:
        typedef enum : uint8_t
        {
            SO_Begin    = 0,
 
            SO_Current  = 1,
 
            SO_End      = 2
        } tSeekOrigin;
 
        typedef enum
        {
            SF_NONE                 = 0x00
        } tStreamFlags;
 
    public:        
 
        virtual tResult Seek(tFilePos nPos, tSeekOrigin eOrigin, tFilePos* pNewPos=nullptr) const = 0;
 
        virtual tResult Reset() = 0;
 
        virtual tResult Flush() = 0;
 
     protected:
        ~IStream() = default;
};
 
}//namespace ant
 
using ant::IStream;
using ant::IInputStream;
using ant::IOutputStream;
 
 
}//namespace ucom
}//namespace adtf
 
//*************************************************************************************************
#endif //_ADTF_UCOM_ANT_STREAM_INTERFACE_INCLUDES_HEADER_