MpBufPool.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2012 SIPez LLC.  All rights reserved.
//  
// Copyright (C) 2006 SIPfoundry Inc. 
// Licensed by SIPfoundry under the LGPL license. 
//  
// $$ 

#ifndef _INCLUDED_MPBUFPOOL_H // [
#define _INCLUDED_MPBUFPOOL_H

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <os/OsMutex.h>
#include <utl/UtlString.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS

struct MpBuf;
struct MpBufList;
class MpFlowGraphBase;
class UtlString;

class MpBufPool {

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
/* ============================ CREATORS ================================== */


    MpBufPool(unsigned blockSize, unsigned numBlocks, const UtlString& poolName);

    virtual
    ~MpBufPool();


/* ============================ MANIPULATORS ============================== */


    MpBuf *getBuffer();
    void releaseBuffer(MpBuf *pBuffer);


/* ============================ ACCESSORS ================================= */


    unsigned getBlockSize() const {return mBlockSize;};

    unsigned getNumBlocks() const {return mNumBlocks;};

    int getBufferNumber(MpBuf *pBuf) const;

    int getFreeBufferCount();

    int scanBufPool(MpFlowGraphBase *pFG);

    int profileFlowgraphPoolUsage();

    const UtlString& getName();


/* ============================ INQUIRY =================================== */



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

    void *getPoolDataEnd() {return mpPoolData + mBlockSpan*mNumBlocks;}

    char *getNextBlock(char *pBlock) {return pBlock + mBlockSpan;}
    
    void appendFreeList(MpBuf *pBuf);

    UtlString  mPoolName;      
    unsigned   mBlockSize;     
    unsigned   mBlockSpan;     
    unsigned   mNumBlocks;     
    unsigned   mPoolBytes;     
    char      *mpPoolData;     
    MpBufList *mpFreeList;     
    OsMutex    mMutex;         

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    unsigned   mNumGets;       
    unsigned   mNumFrees;      
    unsigned   mNumFree;       
    unsigned   mMinFree;       
 
};


#endif // _INCLUDED_MPBUFPOOL_H ]