v8  7.4.288(node12.0.0)
V8 is Google's open source JavaScript engine
PersistentValueMapBase< K, V, Traits > Class Template Reference

#include <v8-util.h>

Inheritance diagram for PersistentValueMapBase< K, V, Traits >:

Data Structures

class  PersistentValueReference

Public Member Functions

IsolateGetIsolate ()
size_t Size ()
bool IsWeak ()
Local< VGet (const K &key)
bool Contains (const K &key)
bool SetReturnValue (const K &key, ReturnValue< Value > returnValue)
 V8_DEPRECATE_SOON ("Used TracedGlobal and EmbedderHeapTracer::RegisterEmbedderReference", inline void RegisterExternallyReferencedObject(K &key))
Global< VRemove (const K &key)
void Clear ()
PersistentValueReference GetReference (const K &key)

Protected Member Functions

 PersistentValueMapBase (Isolate *isolate)
 PersistentValueMapBase (Isolate *isolate, const char *label)
 ~PersistentValueMapBase ()
Isolateisolate ()
Traits::Impl * impl ()
void RemoveWeak (const K &key)
void AnnotateStrongRetainer (Global< V > *persistent)

Static Protected Member Functions

static VFromVal (PersistentContainerValue v)
static PersistentContainerValue ClearAndLeak (Global< V > *persistent)
static PersistentContainerValue Leak (Global< V > *persistent)
static Global< VRelease (PersistentContainerValue v)

Detailed Description

template<typename K, typename V, typename Traits>
class v8::PersistentValueMapBase< K, V, Traits >

A map wrapper that allows using Global as a mapped value. C++11 embedders don't need this class, as they can use Global directly in std containers.

The map relies on a backing map, whose type and accessors are described by the Traits class. The backing map will handle values of type PersistentContainerValue, with all conversion into and out of V8 handles being transparently handled by this class.

Definition at line 160 of file v8-util.h.

Constructor & Destructor Documentation

◆ PersistentValueMapBase() [1/2]

PersistentValueMapBase ( Isolate isolate)

Definition at line 287 of file v8-util.h.

◆ PersistentValueMapBase() [2/2]

PersistentValueMapBase ( Isolate isolate,
const char *  label 

Definition at line 289 of file v8-util.h.

◆ ~PersistentValueMapBase()

~PersistentValueMapBase ( )

Definition at line 292 of file v8-util.h.

References PersistentValueMapBase< K, V, Traits >::Clear().

Member Function Documentation

◆ AnnotateStrongRetainer()

void AnnotateStrongRetainer ( Global< V > *  persistent)

◆ Clear()

void Clear ( )

Traverses the map repeatedly, in case side effects of disposal cause insertions.

Definition at line 216 of file v8-util.h.

References PersistentValueMapBase< K, V, Traits >::impl(), and PersistentValueMapBase< K, V, Traits >::Release().

Referenced by PersistentValueMapBase< K, V, Traits >::~PersistentValueMapBase().

◆ ClearAndLeak()

static PersistentContainerValue ClearAndLeak ( Global< V > *  persistent)

◆ Contains()

bool Contains ( const K &  key)

Check whether a value is contained in the map.

Definition at line 184 of file v8-util.h.

◆ FromVal()

◆ Get()

Local<V> Get ( const K &  key)

Get value stored in map.

Definition at line 177 of file v8-util.h.

References PersistentValueMapBase< K, V, Traits >::FromVal(), and Local< T >::New().

◆ GetIsolate()

Isolate* GetIsolate ( )

Definition at line 162 of file v8-util.h.

◆ GetReference()

PersistentValueReference GetReference ( const K &  key)

Get a reference to a map value. This enables fast, repeated access to a value stored in the map while the map remains unchanged.

Careful: This is potentially unsafe, so please use with care. The value will become invalid if the value for this key changes in the underlying map, as a result of Set or Remove for the same key; as a result of the weak callback for the same key; or as a result of calling Clear() or destruction of the map.

Definition at line 282 of file v8-util.h.

◆ impl()

◆ isolate()

◆ IsWeak()

bool IsWeak ( )

Return whether the map holds weak persistents.

Definition at line 172 of file v8-util.h.

References v8::kNotWeak.

◆ Leak()

static PersistentContainerValue Leak ( Global< V > *  persistent)

◆ Release()

static Global<V> Release ( PersistentContainerValue  v)

Return a container value as Global and make sure the weak callback is properly disposed of. All remove functionality should go through this.

Definition at line 316 of file v8-util.h.

References PersistentValueMapBase< K, V, Traits >::FromVal(), PersistentBase< T >::IsWeak(), v8::kNotWeak, and Global< T >::Pass().

Referenced by PersistentValueMapBase< K, V, Traits >::Clear(), PersistentValueMapBase< K, V, Traits >::Remove(), PersistentValueMap< K, V, Traits >::SetUnique(), and GlobalValueMap< K, V, Traits >::SetUnique().

◆ Remove()

Global<V> Remove ( const K &  key)

Return value for key and remove it from the map.

Definition at line 208 of file v8-util.h.

References PersistentValueMapBase< K, V, Traits >::Release().

◆ RemoveWeak()

void RemoveWeak ( const K &  key)

◆ SetReturnValue()

bool SetReturnValue ( const K &  key,
ReturnValue< Value returnValue 

Get value stored in map and set it in returnValue. Return true if a value was found.

Definition at line 192 of file v8-util.h.

◆ Size()

size_t Size ( )

Return size of the map.

Definition at line 167 of file v8-util.h.


V8_DEPRECATE_SOON ( "Used TracedGlobal and EmbedderHeapTracer::RegisterEmbedderReference ,
inline void   RegisterExternallyReferencedObjectK &key 

Call V8::RegisterExternallyReferencedObject with the map value for given key.

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