WriteBlockStream.h

Go to the documentation of this file.

//==============================================================================================
//  FILENAME    :   WriteBlockStream.h
//  AUTHOR      :   Yi Luo
//  PROJECT     :   PDSerialization
//
//  CREATION    :   2002-07-15
//  Copyright (C) MicroStrategy, Inc. 2002
//==============================================================================================
#ifndef Serialization_WriteBlockStream_H
#define Serialization_WriteBlockStream_H

#include "PDSerialization.h"
#include "PDSerialization/PDSerialization/WriteDataStream.h"
#ifndef __ANDROID__
#include "Encryptor/Encryptor/EncryptorDecryptor.h"
#endif
namespace MSerialization
{
    class DLL_PDSERIALIZATION_EXIM WriteListStream :  public WriteDataStream
    {
    public:
        virtual void StartList()=0;

        virtual void ContinueList()=0;

    protected:
        virtual ~WriteListStream() throw() {};
    };

    class DLL_PDSERIALIZATION_EXIM WriteBlockStream :  public WriteListStream
    {
    public:

        virtual void WriteBlockHeader(unsigned short iBlockType)=0;

        virtual void FinishWriteBlock()=0;

        virtual void FinishWriteBlock(unsigned short iBlockType)=0;

    protected:
        virtual ~WriteBlockStream() throw() {};

    };

    typedef MBase::StrongPtr<WriteBlockStream, MBase::DeleteOperatorGeneric<WriteBlockStream> > WriteBlockStreamPtr;

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateWriteBlockStream(MBase::MemoryContract* ipMemCon=0,
                                                                      unsigned short iHeader = 1);

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateRawWriteBlockStream(MBase::MemoryContract* ipMemCon=0,
                                                                      unsigned short iHeader = 1);

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateSafeWriteBlockStream(MBase::MemoryContract* ipMemCon=0,
                                                                          unsigned short iHeader = 1);

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateSafeRawWriteBlockStream(MBase::MemoryContract* ipMemCon=0,
                                                                          unsigned short iHeader = 1);

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* ConvertBinaries2WriteBlockStream(
                                                                MDataType::BinaryCollection* ipBinaries,
                                                                MBase::MemoryContract* ipMemCon=0);

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateWriteBlockStream(MFileSystem::WriteableFile::Ptr& iFilePtr,
                                          unsigned short header=1);
    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateRawWriteBlockStream(MFileSystem::WriteableFile::Ptr& iFilePtr,
                                         unsigned short header=1);
    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateSafeWriteBlockStream(MFileSystem::WriteableFile::Ptr& iFilePtr,
                                          unsigned short header=1);
    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreateSafeRawWriteBlockStream(MFileSystem::WriteableFile::Ptr& iFilePtr,
                                             unsigned short header=1);

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* ConvertFile2WriteBlockStream(MFileSystem::UpdateableFile::Ptr& iFilePtr, unsigned short header=1);

#ifndef __ANDROID__

    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreatePartialEncryptedSafeWriteBlockStream(MBase::MemoryContract* ipMemCon=0,
                                                                          unsigned short iHeader = 1,
                                                                          MEncryptor::EncryptionVersion iEncryptionVersion=MEncryptor::AES,
                                                                          const char* ipcKey=NULL);
    DLL_PDSERIALIZATION_EXIM WriteBlockStream* CreatePartialEncryptedSafeWriteBlockStream(MFileSystem::WriteableFile::Ptr& iFilePtr,
                                                                          unsigned short iHeader = 1,
                                                                          MEncryptor::EncryptionVersion iEncryptionVersion=MEncryptor::AES,
                                                                          const char* ipcKey=NULL);
#endif
}

#endif // Serialization_WriteBlockStream_H