rmbufferpool.h

神龙卡开发原代码

/*****************************************************************
*** Copyright (c) 2001 Sigma Designs Inc. All rights reserved. ***
*****************************************************************/

/**
  @file   rmbufferpool.h
  @brief  

  RMbufferPool is a factory which can return a finite
  number of constructed RMbuffers.

  @author Mathieu Lacage
  @date   2001-09-24
*/

#ifndef __RMBUFFERPOOL_H__
#define __RMBUFFERPOOL_H__

class RM_LIBRARY_IMPORT_EXPORT RMbufferPool: public RMobject
{
 public:	
	RMbufferPool(RMascii *name);
	virtual ~RMbufferPool(void);

	/**
	   GetObject:
	   Used by clients to get a pointer to a buffer 
	   of bytes of size objectSize.
	   This removes the object from the bufferPool.
	 */
	virtual RMbuffer *GetRMbuffer (void) PURE_VIRTUAL;

        /**
           Gets the number of available RMbuffer for next
           GetRMbufferCall. May be useful to implement a non blocking
           GetRMbuffer call.
	   
           @param void  
           @return <ReturnValue>
	*/
	virtual RMuint32 GetFreeRMbufferCount (void) PURE_VIRTUAL;

        /**
           Gets the maximum amout of buffer in the pool
	   
           @param void  
           @return <ReturnValue>
	*/
	virtual RMuint32 GetMaxRMbuffer (void) PURE_VIRTUAL;

	virtual RMbuffer *ShowBufferContainingAddress(RMuint8 *address) PURE_VIRTUAL;
};

#endif // __RMBUFFERPOOL_H__