sbgEComPager.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_PAGER_H
#define SBG_ECOM_PAGER_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Structure definitions                                              -//
//----------------------------------------------------------------------//

typedef struct _SbgEComPager
{
    uint16_t                             nrPages;                                    
    uint16_t                             pageIndex;                                    
    size_t                               size;                                      
    uint8_t                             *pBuffer;                                    
    size_t                               bufferSize;                              
} SbgEComPager;
 
//----------------------------------------------------------------------//
//- Public functions                                                   -//
//----------------------------------------------------------------------//

void sbgEComPagerZeroInit(SbgEComPager *pPager);
 

SbgErrorCode sbgEComPagerInitForJoin(SbgEComPager *pPager, void *pBuffer, size_t bufferSize);
 

SbgErrorCode sbgEComPagerJoin(SbgEComPager *pPager, uint16_t pageIndex, uint16_t nrPages, const void *pPage, size_t pageSize);

bool sbgEComPagerJoinIsComplete(const SbgEComPager *pPager);

size_t sbgEComPagerGetBufferSize(const SbgEComPager *pPager);
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_PAGER_H