Compute Library
 23.05
IMemoryPool Class Referenceabstract

Memory Pool Inteface. More...

#include <IMemoryPool.h>

Public Member Functions

virtual ~IMemoryPool ()=default
 Default Virtual Destructor. More...
 
virtual void acquire (MemoryMappings &handles)=0
 Sets occupant to the memory pool. More...
 
virtual void release (MemoryMappings &handles)=0
 Releases a memory block. More...
 
virtual MappingType mapping_type () const =0
 Returns the mapping types that this pool accepts. More...
 
virtual std::unique_ptr< IMemoryPoolduplicate ()=0
 Duplicates the existing memory pool. More...
 

Detailed Description

Memory Pool Inteface.

Definition at line 37 of file IMemoryPool.h.

Constructor & Destructor Documentation

◆ ~IMemoryPool()

virtual ~IMemoryPool ( )
virtualdefault

Default Virtual Destructor.

Member Function Documentation

◆ acquire()

virtual void acquire ( MemoryMappings handles)
pure virtual

Sets occupant to the memory pool.

Parameters
[in]handlesA vector of pairs (handle, index)

Implemented in OffsetMemoryPool, and BlobMemoryPool.

◆ duplicate()

virtual std::unique_ptr<IMemoryPool> duplicate ( )
pure virtual

Duplicates the existing memory pool.

Returns
A duplicate of the existing pool

Implemented in OffsetMemoryPool, and BlobMemoryPool.

◆ mapping_type()

virtual MappingType mapping_type ( ) const
pure virtual

Returns the mapping types that this pool accepts.

Returns
the mapping type of the memory

Implemented in OffsetMemoryPool, and BlobMemoryPool.

◆ release()

virtual void release ( MemoryMappings handles)
pure virtual

Releases a memory block.

Parameters
[in]handlesA vector containing a pair of handles and indices

Implemented in OffsetMemoryPool, and BlobMemoryPool.

Referenced by MemoryGroup::release().


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