[#LockedPageAllocator]
= LockedPageAllocator
:mrdocs:

OS‐dependent allocation and deallocation of locked/pinned memory pages. Abstract base class.

== Synopsis

Declared in `<support/lockedpool.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class LockedPageAllocator;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:LockedPageAllocator/2destructor.adoc[`~LockedPageAllocator`] [.small]#[destructor]# [.small]#[virtual]#
| Destroys the allocator.
| xref:LockedPageAllocator/AllocateLocked.adoc[`AllocateLocked`]  [.small]#[virtual]#
| Allocate and lock memory pages. If len is not a multiple of the system page size, it is rounded up. Returns nullptr in case of allocation failure.
| xref:LockedPageAllocator/FreeLocked.adoc[`FreeLocked`]  [.small]#[virtual]#
| Unlock and free memory pages. Clear the memory before unlocking.
| xref:LockedPageAllocator/GetLimit.adoc[`GetLimit`]  [.small]#[virtual]#
| Get the total limit on the amount of memory that may be locked by this process, in bytes. Return size_t max if there is no limit or the limit is unknown. Return 0 if no memory can be locked at all.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#