1.7.2.9
Gameface
cohtml::IDataStorageHandler Class Referenceabstract

Class that will handle data storage requests. More...

Public Member Functions

virtual ~IDataStorageHandler ()
 
virtual void OnDataStorageRead (const cohtml::IDataStorageRequest *request, cohtml::IDataStorageResponse *response)=0
 Called when data storage needs a key or value data. More...
 
virtual bool OnDataStorageWrite (const char *id, const char *key, const char *value)=0
 Called when data storage needs a data to be stored for a specific ID and key If data collection for that ID doesn't exist it should be created. More...
 
virtual void OnDataStorageRemove (const char *id, const char *key)=0
 Called when data storage needs a data to be removed from the collection. More...
 
virtual void OnDataStorageClear (const char *id)=0
 Called when data storage needs all data for a given collection to be cleared. More...
 
virtual unsigned long OnDataStorageCount (const char *id)=0
 Called when data storage needs the count of all data stored in a specific collection. More...
 

Detailed Description

Class that will handle data storage requests.

Constructor & Destructor Documentation

◆ ~IDataStorageHandler()

virtual cohtml::IDataStorageHandler::~IDataStorageHandler ( )
virtual

Member Function Documentation

◆ OnDataStorageClear()

virtual void cohtml::IDataStorageHandler::OnDataStorageClear ( const char *  id)
pure virtual

Called when data storage needs all data for a given collection to be cleared.

Parameters
idof the data collection

◆ OnDataStorageCount()

virtual unsigned long cohtml::IDataStorageHandler::OnDataStorageCount ( const char *  id)
pure virtual

Called when data storage needs the count of all data stored in a specific collection.

Parameters
idof the data collection

◆ OnDataStorageRead()

virtual void cohtml::IDataStorageHandler::OnDataStorageRead ( const cohtml::IDataStorageRequest request,
cohtml::IDataStorageResponse response 
)
pure virtual

Called when data storage needs a key or value data.

Parameters
requestobject describing the data requested
responseobject where to pass the data read

◆ OnDataStorageRemove()

virtual void cohtml::IDataStorageHandler::OnDataStorageRemove ( const char *  id,
const char *  key 
)
pure virtual

Called when data storage needs a data to be removed from the collection.

Parameters
idof the data collection
keythat needs to be removed

◆ OnDataStorageWrite()

virtual bool cohtml::IDataStorageHandler::OnDataStorageWrite ( const char *  id,
const char *  key,
const char *  value 
)
pure virtual

Called when data storage needs a data to be stored for a specific ID and key If data collection for that ID doesn't exist it should be created.

Parameters
idof the data collection
keyfor storing the value
valuethat needs to be stored