V8 API Reference Guide generated from the header files
Public Types | Public Member Functions | Static Public Member Functions
v8::ArrayBuffer::Allocator Class Referenceabstract

#include <v8.h>

Public Types

enum  AllocationMode { kNormal, kReservation }
 

Public Member Functions

virtual void * Allocate (size_t length)=0
 
virtual void * AllocateUninitialized (size_t length)=0
 
virtual void Free (void *data, size_t length)=0
 

Static Public Member Functions

static AllocatorNewDefaultAllocator ()
 

Detailed Description

A thread-safe allocator that V8 uses to allocate |ArrayBuffer|'s memory. The allocator is a global V8 setting. It has to be set via Isolate::CreateParams.

Memory allocated through this allocator by V8 is accounted for as external memory by V8. Note that V8 keeps track of the memory for all internalized |ArrayBuffer|s. Responsibility for tracking external memory (using Isolate::AdjustAmountOfExternalAllocatedMemory) is handed over to the embedder upon externalization and taken over upon internalization (creating an internalized buffer from an existing buffer).

Note that it is unsafe to call back into V8 from any of the allocator functions.

Member Enumeration Documentation

◆ AllocationMode

ArrayBuffer allocation mode. kNormal is a malloc/free style allocation, while kReservation is for larger allocations with the ability to set access permissions.

Member Function Documentation

◆ Allocate()

virtual void* v8::ArrayBuffer::Allocator::Allocate ( size_t  length)
pure virtual

Allocate |length| bytes. Return NULL if allocation is not successful. Memory should be initialized to zeroes.

◆ AllocateUninitialized()

virtual void* v8::ArrayBuffer::Allocator::AllocateUninitialized ( size_t  length)
pure virtual

Allocate |length| bytes. Return NULL if allocation is not successful. Memory does not have to be initialized.

◆ Free()

virtual void v8::ArrayBuffer::Allocator::Free ( void *  data,
size_t  length 
)
pure virtual

Free the memory block of size |length|, pointed to by |data|. That memory is guaranteed to be previously allocated by |Allocate|.

◆ NewDefaultAllocator()

static Allocator* v8::ArrayBuffer::Allocator::NewDefaultAllocator ( )
static

malloc/free based convenience allocator.

Caller takes ownership, i.e. the returned object needs to be freed using |delete allocator| once it is no longer in use.


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