v8  7.0.276 (node 11.14.0)
V8 is Google's open source JavaScript engine
Data Structures | Public Member Functions | Protected Member Functions | Static Protected Member Functions
PersistentValueMapBase< K, V, Traits > Class Template Reference

#include <v8-util.h>

Inheritance diagram for PersistentValueMapBase< K, V, Traits >:
Inheritance graph
[legend]

Data Structures

class  PersistentValueReference
 

Public Member Functions

Isolate * GetIsolate ()
 
size_t Size ()
 
bool IsWeak ()
 
Local< V > Get (const K &key)
 
bool Contains (const K &key)
 
bool SetReturnValue (const K &key, ReturnValue< Value > returnValue)
 
void RegisterExternallyReferencedObject (K &key)
 
Global< V > Remove (const K &key)
 
void Clear ()
 
PersistentValueReference GetReference (const K &key)
 

Protected Member Functions

 PersistentValueMapBase (Isolate *isolate)
 
 ~PersistentValueMapBase ()
 
Isolate * isolate ()
 
Traits::Impl * impl ()
 
void RemoveWeak (const K &key)
 

Static Protected Member Functions

static V * FromVal (PersistentContainerValue v)
 
static PersistentContainerValue ClearAndLeak (Global< V > *persistent)
 
static PersistentContainerValue Leak (Global< V > *persistent)
 
static Global< V > Release (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 162 of file v8-util.h.

Constructor & Destructor Documentation

◆ PersistentValueMapBase()

PersistentValueMapBase ( Isolate *  isolate)
inlineexplicitprotected

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

◆ ~PersistentValueMapBase()

~PersistentValueMapBase ( )
inlineprotected

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

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

Member Function Documentation

◆ Clear()

void Clear ( )
inline

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

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

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

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

◆ ClearAndLeak()

static PersistentContainerValue ClearAndLeak ( Global< V > *  persistent)
inlinestaticprotected

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

◆ Contains()

bool Contains ( const K &  key)
inline

Check whether a value is contained in the map.

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

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

◆ FromVal()

static V* FromVal ( PersistentContainerValue  v)
inlinestaticprotected

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

Referenced by PersistentValueMapBase< K, V, Traits >::Get(), PersistentValueMapBase< K, V, Traits >::PersistentValueReference::NewLocal(), PersistentValueMapBase< K, V, Traits >::RegisterExternallyReferencedObject(), PersistentValueMapBase< K, V, Traits >::Release(), and PersistentValueMapBase< K, V, Traits >::RemoveWeak().

◆ Get()

Local<V> Get ( const K &  key)
inline

Get value stored in map.

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

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

◆ GetIsolate()

Isolate* GetIsolate ( )
inline

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

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

◆ GetReference()

PersistentValueReference GetReference ( const K &  key)
inline

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 287 of file v8-util.h.

◆ impl()

Traits::Impl* impl ( )
inlineprotected

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

◆ isolate()

Isolate* isolate ( )
inlineprotected

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

◆ IsWeak()

bool IsWeak ( )
inline

Return whether the map holds weak persistents.

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

References v8::kNotWeak.

◆ Leak()

static PersistentContainerValue Leak ( Global< V > *  persistent)
inlinestaticprotected

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

◆ RegisterExternallyReferencedObject()

void RegisterExternallyReferencedObject ( K &  key)
inline

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

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

References PersistentValueMapBase< K, V, Traits >::Contains(), PersistentValueMapBase< K, V, Traits >::FromVal(), and PersistentValueMapBase< K, V, Traits >::GetIsolate().

◆ Release()

static Global<V> Release ( PersistentContainerValue  v)
inlinestaticprotected

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 318 of file v8-util.h.

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

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

◆ Remove()

Global<V> Remove ( const K &  key)
inline

Return value for key and remove it from the map.

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

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

◆ RemoveWeak()

void RemoveWeak ( const K &  key)
inlineprotected

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

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

◆ SetReturnValue()

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

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

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

◆ Size()

size_t Size ( )
inline

Return size of the map.

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

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