kPageCache.h

Go to the documentation of this file.

#ifndef K_FIRESYNC_PAGE_CACHE_H
#define K_FIRESYNC_PAGE_CACHE_H

#include <kFireSync/kFsDef.h>
#include <kFireSync/Utils/kPageCache.x.h>

//typedef kObject kPageCache;            --forward-declared in kFsDef.x.h  

typedef kPointer kPageCacheItem;

kFsFx(kStatus) kPageCache_Construct(kPageCache* cache, kSize pageCapacity, kSize pageSize, kSize spareSize, kAlloc allocator); 

kFsFx(kStatus) kPageCache_Invalidate(kPageCache cache);

kFsFx(kStatus) kPageCache_InvalidatePage(kPageCache cache, kSize pageIndex);

kFsFx(kStatus) kPageCache_InvalidateRange(kPageCache cache, kSize pageIndex, kSize pageCount);

kFsFx(kStatus) kPageCache_FindPage(kPageCache cache, kSize pageIndex, kPageCacheItem* page);

kFsFx(kStatus) kPageCache_AccessPage(kPageCache cache, kSize pageIndex, kPageCacheItem* page);

kFsFx(kStatus) kPageCache_AllocatePage(kPageCache cache, kSize pageIndex, kPageCacheItem* page);

kFsFx(kStatus) kPageCache_CopyToPageData(kPageCache cache, kPageCacheItem page, const kPointer source, kSize length);

kFsFx(kStatus) kPageCache_CopyFromPageData(kPageCache cache, kPageCacheItem page, kPointer dest, kSize length);

kFsFx(kStatus) kPageCache_CopyToPageSpare(kPageCache cache, kPageCacheItem page, const kPointer source, kSize length);

kFsFx(kStatus) kPageCache_CopyFromPageSpare(kPageCache cache, kPageCacheItem page, kPointer dest, kSize length);

kInlineFx(kSize) kPageCache_PageSize(kPageCache cache)
{
    kObj(kPageCache, cache);

    return obj->pageSize;
}

kInlineFx(kSize) kPageCache_SpareSize(kPageCache cache)
{
    kObj(kPageCache, cache);

    return obj->spareSize;
}

kInlineFx(kPointer) kPageCache_PageData(kPageCache cache, kPageCacheItem page)
{
    kAssertType(cache, kPageCache);

    return ((kPageCacheEntry*)page)->data;
}

kInlineFx(kPointer) kPageCache_PageSpare(kPageCache cache, kPageCacheItem page)
{
    kAssertType(cache, kPageCache);

    return ((kPageCacheEntry*)page)->spare;
}

#endif