WorldStorage.h

Go to the documentation of this file.

// WorldStorage.h

// Interfaces to the cWorldStorage class representing the chunk loading / saving thread
// This class decides which storage schema to use for saving; it queries all available schemas for loading
// Also declares the base class for all storage schemas, cWSSchema
// Helper serialization class cJsonChunkSerializer is declared as well





#pragma once

#include "../OSSupport/IsThread.h"
#include "../OSSupport/Queue.h"





// fwd:
class cWorld;

typedef cQueue<cChunkCoordsWithCallback> cChunkCoordsQueue;





class cWSSchema abstract
{
public:
    cWSSchema(cWorld * a_World) : m_World(a_World) {}
    virtual ~cWSSchema() {}  // Force the descendants' destructors to be virtual

    virtual bool LoadChunk(const cChunkCoords & a_Chunk) = 0;
    virtual bool SaveChunk(const cChunkCoords & a_Chunk) = 0;
    virtual const AString GetName(void) const = 0;

protected:

    cWorld * m_World;
} ;

typedef std::list<cWSSchema *> cWSSchemaList;





class cWorldStorage :
    public cIsThread
{
    typedef cIsThread super;

public:

    cWorldStorage(void);
    virtual ~cWorldStorage() override;

    void QueueLoadChunk(int a_ChunkX, int a_ChunkZ, cChunkCoordCallback * a_Callback = nullptr);

    void QueueSaveChunk(int a_ChunkX, int a_ChunkZ, cChunkCoordCallback * a_Callback = nullptr);

    void Initialize(cWorld & a_World, const AString & a_StorageSchemaName, int a_StorageCompressionFactor);
    void Stop(void);  // Hide the cIsThread's Stop() method, we need to signal the event
    void WaitForFinish(void);
    void WaitForLoadQueueEmpty(void);
    void WaitForSaveQueueEmpty(void);

    size_t GetLoadQueueLength(void);
    size_t GetSaveQueueLength(void);

protected:

    cWorld * m_World;
    AString  m_StorageSchemaName;

    cChunkCoordsQueue  m_LoadQueue;
    cChunkCoordsQueue m_SaveQueue;

    cWSSchemaList m_Schemas;

    cWSSchema * m_SaveSchema;

    cEvent m_Event;


    bool LoadChunk(int a_ChunkX, int a_ChunkZ);

    void InitSchemas(int a_StorageCompressionFactor);

    virtual void Execute(void) override;

    bool LoadOneChunk(void);

    bool SaveOneChunk(void);
} ;