/* ***** BEGIN LICENSE BLOCK *****
 * Source last modified: $Id: clientpq.h,v 1.2.42.1 2004/07/09 02:06:18 hubbe Exp $
 * 
 * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
 * 
 * The contents of this file, and the files included with this file,
 * are subject to the current version of the RealNetworks Public
 * Source License (the "RPSL") available at
 * http://www.helixcommunity.org/content/rpsl unless you have licensed
 * the file under the current version of the RealNetworks Community
 * Source License (the "RCSL") available at
 * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
 * will apply. You may also obtain the license terms directly from
 * RealNetworks.  You may not use this file except in compliance with
 * the RPSL or, if you have a valid RCSL with RealNetworks applicable
 * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
 * the rights, obligations and limitations governing use of the
 * contents of the file.
 * 
 * Alternatively, the contents of this file may be used under the
 * terms of the GNU General Public License Version 2 or later (the
 * "GPL") in which case the provisions of the GPL are applicable
 * instead of those above. If you wish to allow use of your version of
 * this file only under the terms of the GPL, and not to allow others
 * to use your version of this file under the terms of either the RPSL
 * or RCSL, indicate your decision by deleting the provisions above
 * and replace them with the notice and other provisions required by
 * the GPL. If you do not delete the provisions above, a recipient may
 * use your version of this file under the terms of any one of the
 * RPSL, the RCSL or the GPL.
 * 
 * This file is part of the Helix DNA Technology. RealNetworks is the
 * developer of the Original Code and owns the copyrights in the
 * portions it created.
 * 
 * This file, and the files included with this file, is distributed
 * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
 * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
 * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
 * ENJOYMENT OR NON-INFRINGEMENT.
 * 
 * Technology Compatibility Kit Test Suite(s) Location:
 *    http://www.helixcommunity.org/content/tck
 * 
 * Contributor(s):
 * 
 * ***** END LICENSE BLOCK ***** */

/*
 *
 * Priority Queue Time-Based Scheduler
 *
 */

#ifndef _CLIENTPQ_H_
#define _CLIENTPQ_H_

//#include "id.h"
#include "hxassert.h"
#include "pq.h"
#include "hxthread.h"

class HXMutex;

#define DEFAULT_NODE_CACHE_SIZE	    50
class ClientPQ : public PQ
{
public:
    ClientPQ(CHXID* pIds = NULL);
    virtual ~ClientPQ();

    virtual int    execute(Timeval now);
    virtual UINT32 enter(Timeval t, IHXCallback* i);
    virtual void   remove(UINT32 handle);
    virtual BOOL   removeifexists(UINT32 id);

    
    void SetCacheSize(UINT16 uCacheSize) {m_uNumNodesToCache = uCacheSize;};

    inline PQElem* new_elem(void);
    inline void free_elem(PQElem*& pElem);

protected:
    PQElem*	m_pFreeList;
    UINT16	m_uNumFreeNodes;
    UINT16	m_uNumNodesToCache;
    HXMutex*   m_pMutex;
};

inline PQElem*
ClientPQ::new_elem(void)
{
    if (!m_pFreeList)
    {
	return (new PQElem);
    }
    
    m_pMutex->Lock();
    PQElem* pNew = m_pFreeList;
    m_pFreeList = m_pFreeList->m_pNext;
    m_uNumFreeNodes--;
    m_pMutex->Unlock();
    return pNew;
}

inline void
ClientPQ::free_elem(PQElem*& pElem)
{
    m_pMutex->Lock();
    if (m_uNumFreeNodes < m_uNumNodesToCache)
    {
	pElem->m_bDefunct   = FALSE;
	HX_ASSERT(!m_pFreeList || m_uNumFreeNodes > 0);
	if (!m_pFreeList)
	{
	    m_pFreeList	    = pElem;
	    pElem->m_pNext  = NULL;
	}
	else
	{
	    pElem->m_pNext = m_pFreeList;
	    m_pFreeList = pElem;
	}   
	m_uNumFreeNodes++;
    }
    else
    {
	delete pElem;
    }
    m_pMutex->Unlock();
}
#endif /*_CLIENTPQ_H_*/

