Stream.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#ifndef ARP_USE_ARP_SYSTEM_COMMONS
#include "Arp/Base/Commons/Io/Stream.hpp"
namespace Arp::System::Commons::Io
{
using Arp::Base::Commons::Io::Stream;
using Arp::Base::Commons::Io::SeekOrigin;
}
#else
#include "Arp/System/Core/Arp.h"
#include "Arp/Base/Commons/Io/Stream.hpp"
#include "Arp/System/Commons/Io/SeekOrigin.hpp"
 
namespace Arp { namespace System { namespace Commons { namespace Io
{
 
// forwards
class NullStream;
 
class Stream
{
public: // construction/destruction
    Stream(void) = default;
 
public: // static properties
    static NullStream Empty;
 
public: // setter/getter operations
    virtual bool    CanRead(void) = 0;
    virtual bool    CanWrite(void) = 0;
    virtual bool    CanSeek(void) = 0;
    virtual size_t  GetLength(void) = 0;
    virtual void    SetLength(size_t length) = 0;
    virtual size_t  GetPosition(void) = 0;
    virtual void    SetPosition(size_t position) = 0;
 
public: // abstract operations
    virtual void    Flush(void) = 0;
    virtual size_t  Seek(size_t offset, SeekOrigin origin) = 0;
    virtual size_t  Read(byte* pBuffer, size_t bufferSize, size_t offset, size_t count) = 0;
    virtual void    Write(const byte* pBuffer, size_t bufferSize, size_t offset, size_t count) = 0;
    virtual void    Close(void) = 0;
 
public: // overridden operations
    virtual byte    ReadByte(void);
    virtual void    WriteByte(byte value);
    virtual void    WriteTo(Stream& other);
    ARP_DEPRECATED("This operation is deprecated, use WriteTo(..) instead.")
    void CopyTo(Stream& other);
 
public: // operations
    ARP_DEPRECATED("This operation is deprecated, implement destrcutor instead")
    void    Dispose(void);
 
protected: // operations
    ARP_DEPRECATED("This operation is deprecated")
    bool    IsDisposed(void);
    ARP_DEPRECATED("This operation is deprecated")
    void    CheckDisposed(void);
 
protected: // abstract operations
    ARP_DEPRECATED("This operation is deprecated")
    virtual void    InternalDispose(void);
 
private: // fields
    bool isDisposed = false;
};
 
}}}} // end of namespace Arp::System::Commons::Io
 
#endif // ndef ARP_USE_ARP_SYSTEM_COMMONS