CascadeSharedList.h

Go to the documentation of this file.

//
// CascadeSharedList.h - header file for class CascadeSharedList
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_INTERPROCESS_CASCADESHAREDLIST_H
#define _ROKU_INCLUDE_CASCADE_INTERPROCESS_CASCADESHAREDLIST_H

#include <cascade/CascadeObject.h>

class CascadeSharedList : public CascadeObject
{
public:
        CascadeSharedList();
    virtual ~CascadeSharedList();

public:
    enum {
        kMaxHeaderSize = 0xF000,    
        kMaxEntrySize = 0xF000,     
        kMaxEntries = 0xF000        
    };
    
public:
    bool Open(const char * pName, u16 nHeaderSize, u16 nEntrySize, u16 nMaxEntries, bool bCreateIfNecessary);
    bool Close();
        bool MapLock();
        bool Unlock();
public:
    // public List accessor functions - these will only work if the list is successfully MapLocked.
    typedef void Entry;
    bool InsertAtHead(void * pData);
    bool AddToTail(void * pData);
    bool Insert(void * pData, Entry * pEntryToInsertBefore);
    u16 GetNumEntries();
    u16 GetMaxEntries();
    u16 GetNumEntriesWatermark();
    Entry * GetFirstEntry();
    Entry * GetLastEntry();
    Entry * GetNextEntry(Entry * pEntry);
    Entry * GetPrevEntry(Entry * pEntry);
    int  GetEntryPID(Entry * pEntry);
    void ResetEntryPID(Entry * pEntry, int nPID);
    bool IsStalePIDEntry(Entry * pEntry);
    bool MoveEntry(Entry * pEntry, Entry * pEntryToMoveBefore);
    bool MoveEntryToHead(Entry * pEntry);
    bool MoveEntryToTail(Entry * pEntry);
    bool RemoveEntry(Entry * pEntry);
    void PurgeDeadPIDEntries();
    void * GetListHeader();
    typedef bool (EnumProc)(Entry * pEnry, void * pClientData);
    bool Enumerate(EnumProc * pEnumProc, void * pClientData);
    bool PIDPurgeEnumerate(EnumProc * pEnumProc, void * pClientData);
        
private:
    void * m_pSharedListInternal;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_INTERPROCESS_CASCADESHAREDLIST_H

//  LOG
//  27-Feb-03   dwoodward       created
//  02-Mar-03   dwoodward   added Enumerate and PIDPurgeEnumerate
//  05-May-03   dwoodward   doxygenated
//  12-May-03   dwoodward   added ResetEntryPID()

---