#include <v8-array-buffer.h>

Inheritance diagram for SharedArrayBuffer:

[legend]

Collaboration diagram for SharedArrayBuffer:

[legend]

Public Member Functions
size_t	ByteLength () const

size_t	MaxByteLength () const

std::shared_ptr< BackingStore >	GetBackingStore ()

void *	Data () const

Public Member Functions inherited from Object
V8_WARN_UNUSED_RESULT Maybe< bool >	Set (Local< Context > context, Local< Value > key, Local< Value > value)

V8_WARN_UNUSED_RESULT Maybe< bool >	Set (Local< Context > context, Local< Value > key, Local< Value > value, MaybeLocal< Object > receiver)

V8_WARN_UNUSED_RESULT Maybe< bool >	Set (Local< Context > context, uint32_t index, Local< Value > value)

V8_WARN_UNUSED_RESULT Maybe< bool >	CreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)

V8_WARN_UNUSED_RESULT Maybe< bool >	CreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)

V8_WARN_UNUSED_RESULT Maybe< bool >	DefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)

V8_WARN_UNUSED_RESULT Maybe< bool >	DefineProperty (Local< Context > context, Local< Name > key, PropertyDescriptor &descriptor)

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	Get (Local< Context > context, Local< Value > key)

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	Get (Local< Context > context, Local< Value > key, MaybeLocal< Object > receiver)

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	Get (Local< Context > context, uint32_t index)

V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute >	GetPropertyAttributes (Local< Context > context, Local< Value > key)

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	GetOwnPropertyDescriptor (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT Maybe< bool >	Has (Local< Context > context, Local< Value > key)

V8_WARN_UNUSED_RESULT Maybe< bool >	Delete (Local< Context > context, Local< Value > key)

V8_WARN_UNUSED_RESULT Maybe< bool >	Has (Local< Context > context, uint32_t index)

V8_WARN_UNUSED_RESULT Maybe< bool >	Delete (Local< Context > context, uint32_t index)

void	SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attributes=None)

V8_WARN_UNUSED_RESULT Maybe< bool >	SetNativeDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)

V8_WARN_UNUSED_RESULT Maybe< bool >	SetLazyDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)

Maybe< bool >	HasPrivate (Local< Context > context, Local< Private > key)

Maybe< bool >	SetPrivate (Local< Context > context, Local< Private > key, Local< Value > value)

Maybe< bool >	DeletePrivate (Local< Context > context, Local< Private > key)

MaybeLocal< Value >	GetPrivate (Local< Context > context, Local< Private > key)

V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetPropertyNames (Local< Context > context)

V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)

V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context)

V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context, PropertyFilter filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)

	V8_DEPRECATE_SOON ("V8 will stop providing access to hidden prototype (i.e. " "JSGlobalObject). Use GetPrototypeV2() instead. " "See http://crbug.com/333672197.") Local< Value > GetPrototype()

Local< Value >	GetPrototypeV2 ()

	V8_DEPRECATE_SOON ("V8 will stop providing access to hidden prototype (i.e. " "JSGlobalObject). Use SetPrototypeV2() instead. " "See http://crbug.com/333672197.") V8_WARN_UNUSED_RESULT Maybe< bool > SetPrototype(Local< Context > context

V8_WARN_UNUSED_RESULT Maybe< bool >	SetPrototypeV2 (Local< Context > context, Local< Value > prototype)

Local< Object >	FindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)

V8_WARN_UNUSED_RESULT MaybeLocal< String >	ObjectProtoToString (Local< Context > context)

Local< String >	GetConstructorName ()

Maybe< bool >	SetIntegrityLevel (Local< Context > context, IntegrityLevel level)

int	InternalFieldCount () const

V8_INLINE Local< Data >	GetInternalField (int index)

void	SetInternalField (int index, Local< Data > data)

V8_INLINE void *	GetAlignedPointerFromInternalField (int index)

V8_INLINE void *	GetAlignedPointerFromInternalField (v8::Isolate *isolate, int index)

void	SetAlignedPointerInInternalField (int index, void *value)

void	SetAlignedPointerInInternalFields (int argc, int indices[], void *values[])

V8_WARN_UNUSED_RESULT Maybe< bool >	HasOwnProperty (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT Maybe< bool >	HasOwnProperty (Local< Context > context, uint32_t index)

V8_WARN_UNUSED_RESULT Maybe< bool >	HasRealNamedProperty (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT Maybe< bool >	HasRealIndexedProperty (Local< Context > context, uint32_t index)

V8_WARN_UNUSED_RESULT Maybe< bool >	HasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	GetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute >	GetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	GetRealNamedProperty (Local< Context > context, Local< Name > key)

V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute >	GetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)

bool	HasNamedLookupInterceptor () const

bool	HasIndexedLookupInterceptor () const

int	GetIdentityHash ()

Local< Object >	Clone (v8::Isolate *isolate)

Local< Object >	Clone ()

MaybeLocal< Context >	GetCreationContext (v8::Isolate *isolate)

MaybeLocal< Context >	GetCreationContext ()

Local< Context >	GetCreationContextChecked (v8::Isolate *isolate)

Local< Context >	GetCreationContextChecked ()

void *	GetAlignedPointerFromEmbedderDataInCreationContext (v8::Isolate *isolate, int index)

void *	GetAlignedPointerFromEmbedderDataInCreationContext (int index)

bool	IsCallable () const

bool	IsConstructor () const

bool	IsApiWrapper () const

bool	IsUndetectable () const

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	CallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])

V8_WARN_UNUSED_RESULT MaybeLocal< Value >	CallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])

Isolate *	GetIsolate ()

MaybeLocal< Array >	PreviewEntries (bool *is_key_value)

bool	IsCodeLike (Isolate *isolate) const

template<CppHeapPointerTag tag, typename T>
T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper)

template<CppHeapPointerTag tag, typename T>
T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper)

template<CppHeapPointerTag tag, typename T>
T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper)

template<typename T>
T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T>
T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T>
T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<CppHeapPointerTag tag>
void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, void wrappable)

template<CppHeapPointerTag tag>
void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, void wrappable)

template<CppHeapPointerTag tag>
void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, void wrappable)

Public Member Functions inherited from Value
V8_INLINE bool	IsUndefined () const

V8_INLINE bool	IsNull () const

V8_INLINE bool	IsNullOrUndefined () const

V8_INLINE bool	IsTrue () const

V8_INLINE bool	IsFalse () const

bool	IsName () const

V8_INLINE bool	IsString () const

bool	IsSymbol () const

bool	IsFunction () const

bool	IsArray () const

bool	IsObject () const

bool	IsBigInt () const

bool	IsBoolean () const

bool	IsNumber () const

bool	IsExternal () const

bool	IsInt32 () const

bool	IsUint32 () const

bool	IsDate () const

bool	IsArgumentsObject () const

bool	IsBigIntObject () const

bool	IsBooleanObject () const

bool	IsNumberObject () const

bool	IsStringObject () const

bool	IsSymbolObject () const

bool	IsNativeError () const

bool	IsRegExp () const

bool	IsAsyncFunction () const

bool	IsGeneratorFunction () const

bool	IsGeneratorObject () const

bool	IsPromise () const

bool	IsMap () const

bool	IsSet () const

bool	IsMapIterator () const

bool	IsSetIterator () const

bool	IsWeakMap () const

bool	IsWeakSet () const

bool	IsWeakRef () const

bool	IsArrayBuffer () const

bool	IsArrayBufferView () const

bool	IsTypedArray () const

bool	IsUint8Array () const

bool	IsUint8ClampedArray () const

bool	IsInt8Array () const

bool	IsUint16Array () const

bool	IsInt16Array () const

bool	IsUint32Array () const

bool	IsInt32Array () const

bool	IsFloat16Array () const

bool	IsFloat32Array () const

bool	IsFloat64Array () const

bool	IsBigInt64Array () const

bool	IsBigUint64Array () const

bool	IsDataView () const

bool	IsSharedArrayBuffer () const

bool	IsProxy () const

bool	IsWasmMemoryObject () const

bool	IsWasmMemoryMapDescriptor () const

bool	IsWasmModuleObject () const

bool	IsWasmNull () const

bool	IsModuleNamespaceObject () const

bool	IsPrimitive () const

V8_WARN_UNUSED_RESULT MaybeLocal< Primitive >	ToPrimitive (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< Numeric >	ToNumeric (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< BigInt >	ToBigInt (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< Number >	ToNumber (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< String >	ToString (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< String >	ToDetailString (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< Object >	ToObject (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< Integer >	ToInteger (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< Uint32 >	ToUint32 (Local< Context > context) const

V8_WARN_UNUSED_RESULT MaybeLocal< Int32 >	ToInt32 (Local< Context > context) const

Local< Boolean >	ToBoolean (Isolate *isolate) const

V8_WARN_UNUSED_RESULT MaybeLocal< Uint32 >	ToArrayIndex (Local< Context > context) const

bool	BooleanValue (Isolate *isolate) const

V8_WARN_UNUSED_RESULT Maybe< double >	NumberValue (Local< Context > context) const

V8_WARN_UNUSED_RESULT Maybe< int64_t >	IntegerValue (Local< Context > context) const

V8_WARN_UNUSED_RESULT Maybe< uint32_t >	Uint32Value (Local< Context > context) const

V8_WARN_UNUSED_RESULT Maybe< int32_t >	Int32Value (Local< Context > context) const

V8_WARN_UNUSED_RESULT Maybe< bool >	Equals (Local< Context > context, Local< Value > that) const

bool	StrictEquals (Local< Value > that) const

bool	SameValue (Local< Value > that) const

Local< String >	TypeOf (Isolate *)

Maybe< bool >	InstanceOf (Local< Context > context, Local< Object > object)

uint32_t	GetHash ()

template<>
V8_INLINE Value *	Cast (Data *value)

Public Member Functions inherited from Data
bool	IsValue () const

bool	IsModule () const

bool	IsModuleRequest () const

bool	IsFixedArray () const

bool	IsPrivate () const

bool	IsObjectTemplate () const

bool	IsFunctionTemplate () const

bool	IsContext () const

Static Public Member Functions
static Local< SharedArrayBuffer >	New (Isolate *isolate, size_t byte_length, BackingStoreInitializationMode initialization_mode=BackingStoreInitializationMode::kZeroInitialized)

static MaybeLocal< SharedArrayBuffer >	MaybeNew (Isolate *isolate, size_t byte_length, BackingStoreInitializationMode initialization_mode=BackingStoreInitializationMode::kZeroInitialized)

static Local< SharedArrayBuffer >	New (Isolate *isolate, std::shared_ptr< BackingStore > backing_store)

static std::unique_ptr< BackingStore >	NewBackingStore (Isolate *isolate, size_t byte_length, BackingStoreInitializationMode initialization_mode=BackingStoreInitializationMode::kZeroInitialized, BackingStoreOnFailureMode on_failure=BackingStoreOnFailureMode::kOutOfMemory)

static std::unique_ptr< BackingStore >	NewBackingStore (void data, size_t byte_length, v8::BackingStore::DeleterCallback deleter, void deleter_data)

static V8_INLINE SharedArrayBuffer *	Cast (Value *value)

Static Public Member Functions inherited from Object
static V8_INLINE int	InternalFieldCount (const PersistentBase< Object > &object)

static V8_INLINE int	InternalFieldCount (const BasicTracedReference< Object > &object)

static V8_INLINE void *	GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index)

static V8_INLINE void *	GetAlignedPointerFromInternalField (const BasicTracedReference< Object > &object, int index)

template<CppHeapPointerTag tag, typename T = void>
static V8_INLINE T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper)

template<CppHeapPointerTag tag, typename T = void>
static V8_INLINE T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper)

template<CppHeapPointerTag tag, typename T = void>
static V8_INLINE T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper)

template<typename T = void>
static V8_INLINE T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T = void>
static V8_INLINE T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T = void>
static V8_INLINE T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<CppHeapPointerTag tag>
static V8_INLINE void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, void wrappable)

template<CppHeapPointerTag tag>
static V8_INLINE void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, void wrappable)

template<CppHeapPointerTag tag>
static V8_INLINE void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, void wrappable)

static V8_INLINE void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, void wrappable, CppHeapPointerTag tag)

static V8_INLINE void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, void wrappable, CppHeapPointerTag tag)

static V8_INLINE void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, void wrappable, CppHeapPointerTag tag)

static V8_INLINE MaybeLocal< Context >	GetCreationContext (v8::Isolate *isolate, const PersistentBase< Object > &object)

static V8_INLINE MaybeLocal< Context >	GetCreationContext (const PersistentBase< Object > &object)

static V8_INLINE Isolate *	GetIsolate (const TracedReference< Object > &handle)

static Local< Object >	New (Isolate *isolate)

static Local< Object >	New (Isolate isolate, Local< Value > prototype_or_null, Local< Name > names, Local< Value > *values, size_t length)

static V8_INLINE Object *	Cast (Value *obj)

Static Public Member Functions inherited from Value
template<class T>
static V8_INLINE Value *	Cast (T *value)

Static Public Attributes
static constexpr int	kInternalFieldCount

Additional Inherited Members
Data Fields inherited from Object
Local< Value >	prototype

Detailed Description

An instance of the built-in SharedArrayBuffer constructor.

Definition at line 499 of file v8-array-buffer.h.

Member Function Documentation

◆ ByteLength()

size_t ByteLength ( ) const

Data length in bytes.

◆ Cast()

static V8_INLINE SharedArrayBuffer * Cast ( Value * value )

inlinestatic

Definition at line 598 of file v8-array-buffer.h.

References V8_INLINE.

◆ Data()

void * Data ( ) const

More efficient shortcut for GetBackingStore()->Data(). The returned pointer is valid as long as the ArrayBuffer is alive.

◆ GetBackingStore()

std::shared_ptr< BackingStore > GetBackingStore ( )

Get a shared pointer to the backing store of this array buffer. This pointer coordinates the lifetime management of the internal storage with any live ArrayBuffers on the heap, even across isolates. The embedder should not attempt to manage lifetime of the storage through other means.

◆ MaxByteLength()

size_t MaxByteLength ( ) const

Maximum length in bytes.

◆ MaybeNew()

static MaybeLocal< SharedArrayBuffer > MaybeNew	(	Isolate *	isolate,
		size_t	byte_length,
		BackingStoreInitializationMode	initialization_mode = BackingStoreInitializationMode::kZeroInitialized )

static

Create a new SharedArrayBuffer. Allocate |byte_length| bytes, which are either zero-initialized or uninitialized. Allocated memory will be owned by a created SharedArrayBuffer and will be deallocated when it is garbage-collected, unless the object is externalized. If allocation fails, the Maybe returned will be empty.

References v8::kZeroInitialized.

◆ New() [1/2]

static Local< SharedArrayBuffer > New	(	Isolate *	isolate,
		size_t	byte_length,
		BackingStoreInitializationMode	initialization_mode = BackingStoreInitializationMode::kZeroInitialized )

static

Create a new SharedArrayBuffer. Allocate |byte_length| bytes, which are either zero-initialized or uninitialized. Allocated memory will be owned by a created SharedArrayBuffer and will be deallocated when it is garbage-collected, unless the object is externalized.

References v8::kZeroInitialized.

◆ New() [2/2]

static Local< SharedArrayBuffer > New	(	Isolate *	isolate,
		std::shared_ptr< BackingStore >	backing_store )

static

Create a new SharedArrayBuffer with an existing backing store. The created array keeps a reference to the backing store until the array is garbage collected. Note that the IsExternal bit does not affect this reference from the array to the backing store.

In future IsExternal bit will be removed. Until then the bit is set as follows. If the backing store does not own the underlying buffer, then the array is created in externalized state. Otherwise, the array is created in internalized state. In the latter case the array can be transitioned to the externalized state using Externalize(backing_store).

◆ NewBackingStore() [1/2]

static std::unique_ptr< BackingStore > NewBackingStore	(	Isolate *	isolate,
		size_t	byte_length,
		BackingStoreInitializationMode	initialization_mode = BackingStoreInitializationMode::kZeroInitialized,
		BackingStoreOnFailureMode	on_failure = BackingStoreOnFailureMode::kOutOfMemory )

static

Returns a new standalone BackingStore that is allocated using the array buffer allocator of the isolate. The allocation can either be zero initialized, or uninitialized. The result can be later passed to SharedArrayBuffer::New.

If the allocator returns nullptr, then the function may cause GCs in the given isolate and re-try the allocation.

If on_failure is kOutOfMemory and GCs do not help, then the function will crash with an out-of-memory error.

Otherwise, if on_failure is kReturnNull and GCs do not help (or the byte_length is so large that the allocation cannot succeed), then a null result is returned.

References v8::kOutOfMemory, and v8::kZeroInitialized.

◆ NewBackingStore() [2/2]

static std::unique_ptr< BackingStore > NewBackingStore	(	void *	data,
		size_t	byte_length,
		v8::BackingStore::DeleterCallback	deleter,
		void *	deleter_data )

static

Returns a new standalone BackingStore that takes over the ownership of the given buffer. The destructor of the BackingStore invokes the given deleter callback.

The result can be later passed to SharedArrayBuffer::New. The raw pointer to the buffer must not be passed again to any V8 functions.

Field Documentation

◆ kInternalFieldCount

int kInternalFieldCount

staticconstexpr

Initial value:

=

V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT

#define V8_ARRAY_BUFFER_INTERNAL_FIELD_COUNT

Definition v8-array-buffer.h:29

Definition at line 605 of file v8-array-buffer.h.

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

include/v8-array-buffer.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ByteLength()

◆ Cast()

◆ Data()

◆ GetBackingStore()

◆ MaxByteLength()

◆ MaybeNew()

◆ New() [1/2]

◆ New() [2/2]

◆ NewBackingStore() [1/2]

◆ NewBackingStore() [2/2]

Field Documentation

◆ kInternalFieldCount