stream_interface.h

Go to the documentation of this file.

#ifndef SDK_BASE_SDK_STREAM_INTERFACE_H_
#define SDK_BASE_SDK_STREAM_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
 
namespace sdk {
namespace base {
 
FWD_DECL_INTERFACE(ISDKStream);
typedef SDKRefPtr<ISDKStream> SDKStreamSP;
 
static const wchar_t* kSDKStreamProperty_Size          = L"size";
static const wchar_t* kSDKStreamProperty_LastWriteTime = L"last write time";
 
static const wchar_t* kSDKStreamProperty_ReclaimMemoryOnSetSize = 
  L"reclaim memory on set size";
 
class ISDKStream : public ISDKComponent
{
public:
  enum SeekOrigin 
  {
    kBegin   = 0, 
    kCurrent = 1, 
    kEnd     = 2, 
  };
  
  typedef SDKUInt64 DataSize; 
  typedef SDKInt64  SeekSize; 
  typedef SDKUInt64 Position; 
 
  virtual SDKResult SDK_CALLTYPE Read(void* buffer, const DataSize& size, 
    DataSize* read_size) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Write(const void* buffer, 
    const DataSize& size, DataSize* written_size) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Seek(const SeekOrigin& origin, 
    const SeekSize& seek_size, Position* new_position) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetSize(const DataSize& new_size) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Flush() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clone(SDKStreamSP& cloned_stream) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CopyTo(const SDKStreamSP& dest_stream, 
    const DataSize& size, DataSize* read_size, 
    DataSize* written_size) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKStream)
  SDK_END_INTERFACE(ISDKStream)
};
SDK_DECLARE_IID(ISDKStream)
 
} // namespace base
} // namespace sdk 
 
#endif // SDK_BASE_SDK_STREAM_INTERFACE_H_