ReadDataStream.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   PDSerializatoin/PDSerialization/ReadDataStream.h
//  PROJECT     :   PDSerialization
//
//  AUTHOR      :   Yi Luo
//  CREATION    :   2002-07-10
//  Copyright (C) MicroStrategy, Inc. 2002
//==============================================================================================
#ifndef Serialization_ReadDataStream_H
#define Serialization_ReadDataStream_H

#include "PDSerialization.h"
#include "DataType/DataType/Binary.h"
#include "DataType/DataType/Variant.h"
#include "Base/Base/GUID.h"
#include "Base/Base/ReturnString.h"
#include "Base/Interfaces/BaseMemoryContract.h"
#include "Base/Defines/SmartPtrI.h"
#include "FileSystem/FileSystem/ReadableFile.h"
#include "Synch/Defines/SmartPtr.h"
#if !defined(WIN32) && !defined(__ANDROID__)
    #include "MultiProcess/SharedMemory/SharedMemory.h"
#endif
#include "PDSerialization/PDSerialization/ReadByteStream.h"

namespace MDataType
{
    class BinaryCollection;
    class DynamicTime;
}

namespace MSerialization
{

    class WriteDataStream;  // foward class declaration

    class DLL_PDSERIALIZATION_EXIM ReadDataStream
    {
    public:

        virtual ReadDataStream& operator >> (MDataType::Binary& orValue)=0;

        virtual ReadDataStream& operator >> (bool& orValue)=0;

        virtual void Read(bool * iopValueArray, unsigned Int32 iElementCount)=0;

        virtual void Read(unsigned char * iopValueArray, unsigned Int32 iElementCount)=0;

        virtual ReadDataStream& operator >> (short & orValue)=0;

        virtual ReadDataStream& operator >> (unsigned short & orValue)=0;

        virtual void Read(short * iopValueArray, unsigned Int32 iElementCount)=0;

        virtual ReadDataStream& operator >> (Int32& orValue)=0;

        virtual ReadDataStream& operator >> (unsigned Int32 & orValue)=0;

        virtual void Read(Int32* iopValueArray, unsigned Int32 iElementCount)=0;

        virtual ReadDataStream& operator >> (Int64& orValue)=0;

        virtual void Read(Int64* iopValueArray, unsigned Int32 iElementCount)=0;

        virtual ReadDataStream& operator >> (float& orValue)=0;

        virtual void Read(float* iopValueArray, unsigned Int32 iElementCount)=0;

        virtual ReadDataStream& operator >> (double& orValue)=0;

        virtual void Read(double* iopValueArray, unsigned Int32 iElementCount)=0;

#ifndef NO_WCHAR_SUPPORT

        virtual MBase::ReturnWString ReadWString()=0;
#endif

        virtual MBase::ReturnString ReadString()=0;

        virtual char ReadByte()=0;

#ifndef NO_WCHAR_SUPPORT

        virtual wchar_t ReadWChar()=0;
#endif

        // serialization of complext data type

        virtual ReadDataStream& operator >> (GUID& orValue)=0;

        virtual void Read(GUID * iopValueArray, unsigned Int32 iElementCount )=0;

        virtual ReadDataStream& operator >> (MDataType::DateTime& orValue)=0;

        virtual void Read(MDataType::DateTime * iopValueArray, unsigned Int32 iElementCount)=0;

        virtual ReadDataStream& operator >> (MDataType::DynamicTime& orValue)=0;

        virtual void Read(MDataType::DynamicTime * iopValueArray, unsigned Int32 iElementCount)=0;


        virtual ReadDataStream& operator >> (MDataType::CellFmtData& orValue)=0;

        virtual void Read(MDataType::CellFmtData * iopValueArray, unsigned Int32 iElementCount)=0;


        virtual ReadDataStream& operator >> (MDataType::Variant& orValue)=0;

        virtual ReadDataStream& operator >> (SerializableObject& irValue)=0;

        virtual void Read(MDataType::Variant * iopValueArray, unsigned Int32 iElementCount)=0;

        virtual Int32 ReadSafeInt()=0;

        virtual void Rewind() =0 ;

        virtual unsigned Int32 GetSize() = 0;

        virtual Int64 Get64BitSize() throw() = 0;

        virtual Int64 GetNumberOfUnreadBytes() throw() = 0;

        virtual MDataType::BinaryCollection* GiveOutBinaryCollection()=0;

        virtual MDataType::BinaryCollection* CopyOutBinaryCollection() const =0;

        virtual MDataType::BinaryCollection* CopyOutContentBinaryCollection() const =0;

        virtual void Delete() throw() =0;

        // return the type of next item
        virtual TYPE GetItemType() =0;

        // return whether the stream is encrypted
        virtual bool IsEncrypted() = 0;

        // Wait for data in read streams
        virtual bool WaitForData(unsigned Int32 iTimeOut) = 0;

        // set a timeout value for all subsequent read actions.
        virtual void SetTimeout(Int64 iTimeoutInMilliseconds) = 0;

    protected:

        virtual void Skip(Int64 dwOffset)=0;

        virtual void Skip(unsigned Int32 dwOffset)=0;

        virtual ~ReadDataStream(){};
    };

    typedef MBase::StrongPtr<ReadDataStream, MBase::DeleteOperatorGeneric<ReadDataStream> > ReadDataStreamPtr;

    // factory function to create a ReadDataStream from a Binary.

    DLL_PDSERIALIZATION_EXIM ReadDataStream* ConvertBinary2ReadDataStream(MDataType::Binary* ipB,
                                                                          MBase::MemoryContract * ipMemCon = 0);

    DLL_PDSERIALIZATION_EXIM ReadDataStream* ConvertWriteDataStream2ReadDataStream(WriteDataStream * ipWriteStream,
                                                                                   MBase::MemoryContract * ipMemCon = 0);


    DLL_PDSERIALIZATION_EXIM ReadDataStream* GetReadDataStreamFromFile(MFileSystem::ReadableFile::Ptr& iFilePtr);

#if !defined(WIN32) && !defined(__ANDROID__)

    DLL_PDSERIALIZATION_EXIM ReadDataStream* CreateReadDataStreamFromSharedMem(MMultiProcess::SharedMemory* ipSharedMemPtr,
                                                                                MBase::MemoryContract * ipMemCon);
#endif

    DLL_PDSERIALIZATION_EXIM ReadDataStream* CreateReadDataStreamFromSharedMemByteStream(
                        ReadByteStream * ipSharedMemReadBStreamPtr,
                        MBase::MemoryContract * ipMemCon);
}

#endif  // Serialization_ReadDataStream_H