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
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)
Global< V >	Remove (const K &key)
void	Clear ()
PersistentValueReference	GetReference (const K &key)

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

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

Constructor & Destructor Documentation

PersistentValueMapBase() [1/2]

template<typename K , typename V , typename Traits >

PersistentValueMapBase ( Isolate *  isolate )

inlineexplicitprotected

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

PersistentValueMapBase() [2/2]

template<typename K , typename V , typename Traits >

PersistentValueMapBase ( Isolate *  isolate, const char *  label  )

inlineprotected

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

~PersistentValueMapBase()

template<typename K , typename V , typename Traits >

~PersistentValueMapBase ( )

inlineprotected

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

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

Member Function Documentation

AnnotateStrongRetainer()

template<typename K , typename V , typename Traits >

void AnnotateStrongRetainer ( Global< V > *  persistent )

inlineprotected

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

References PersistentBase< T >::AnnotateStrongRetainer().

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

Clear()

template<typename K , typename V , typename Traits >

void Clear ( )

inline

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

Definition at line 214 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()

template<typename K , typename V , typename Traits >

static PersistentContainerValue ClearAndLeak ( Global< V > *  persistent )

inlinestaticprotected

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

References V.

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

Contains()

template<typename K , typename V , typename Traits >

bool Contains ( const K &  key )

inline

Check whether a value is contained in the map.

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

FromVal()

template<typename K , typename V , typename Traits >

static V * FromVal ( PersistentContainerValue  v )

inlinestaticprotected

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

References V.

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

Get()

template<typename K , typename V , typename Traits >

Local< V > Get ( const K &  key )

inline

Get value stored in map.

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

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

GetIsolate()

template<typename K , typename V , typename Traits >

Isolate * GetIsolate ( )

inline

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

GetReference()

template<typename K , typename V , typename Traits >

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

impl()

template<typename K , typename V , typename Traits >

Traits::Impl * impl ( )

inlineprotected

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

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

isolate()

template<typename K , typename V , typename Traits >

Isolate * isolate ( )

inlineprotected

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

Referenced by PersistentValueMapBase< K, V, Traits >::PersistentValueReference::NewLocal(), PersistentValueMap< K, V, Traits >::Set(), GlobalValueMap< K, V, Traits >::Set(), PersistentValueMap< K, V, Traits >::SetUnique(), and GlobalValueMap< K, V, Traits >::SetUnique().

IsWeak()

template<typename K , typename V , typename Traits >

bool IsWeak ( )

inline

Return whether the map holds weak persistents.

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

References v8::kNotWeak.

Leak()

template<typename K , typename V , typename Traits >

static PersistentContainerValue Leak ( Global< V > *  persistent )

inlinestaticprotected

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

Referenced by PersistentValueMap< K, V, Traits >::Set(), and GlobalValueMap< K, V, Traits >::Set().

Release()

template<typename K , typename V , typename Traits >

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 314 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()

template<typename K , typename V , typename Traits >

Global< V > Remove ( const K &  key )

inline

Return value for key and remove it from the map.

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

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

RemoveWeak()

template<typename K , typename V , typename Traits >

void RemoveWeak ( const K &  key )

inlineprotected

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

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

SetReturnValue()

template<typename K , typename V , typename Traits >

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

Size()

template<typename K , typename V , typename Traits >

size_t Size ( )

inline

Return size of the map.

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

---

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

• include/v8-initialization.h
• include/v8-util.h