Description

Represents a pool of GoWebScanPipeMsg objects. The pool allocates GoWebScanPipeMsg objects with a default reference count of 1. Messages are recycled to the pool's free list when the message's reference count reaches 0. A GoWebScanPipeMsgPool can only contain GoWebScanPipeMsg objects of the same GoWebScanMsgType.

Inheritance diagram for GoWebScanPipeMsgPool:

Public Member Functions
kStatus	GoWebScanPipeMsgPool_Alloc (GoWebScanPipeMsgPool pool, GoWebScanPipeMsg *msg)
	Allocates a GoWebScanPipeMsg object and adds it to the pool's allocated list. More...

kSize	GoWebScanPipeMsgPool_AllocCount (GoWebScanPipeMsgPool pool)
	Gets the count of the pool's allocated list. More...

kStatus	GoWebScanPipeMsgPool_Construct (GoWebScanPipeMsgPool *pool, kAlloc allocator)
	Constructs a GoWebScanPipeMsgPool object. More...

kSize	GoWebScanPipeMsgPool_FreeCount (GoWebScanPipeMsgPool pool)
	Gets the count of the pool's free list. More...

kStatus	GoWebScanPipeMsgPool_SetAllocHandler (GoWebScanPipeMsgPool pool, GoWebScanPipeMsgPoolAllocFx alloc, kPointer receiver)
	Sets the message allocation callback function. More...

kStatus	GoWebScanPipeMsgPool_SetDestroyHandler (GoWebScanPipeMsgPool pool, GoWebScanPipeMsgPoolDestroyFx destroy)
	Sets the message destruction callback function. More...

kStatus	GoWebScanPipeMsgPool_SetFreeHandler (GoWebScanPipeMsgPool pool, GoWebScanPipeMsgPoolFreeFx free)
	Sets the callback function to recycle memory allocated for a message. More...

kStatus	GoWebScanPipeMsgPool_SetSizeHandler (GoWebScanPipeMsgPool pool, GoWebScanPipeMsgPoolSizeFx size)
	Sets the callback function for the message's data buffer size (in bytes). More...

The documentation for this class was generated from the following file:

Public Member Functions