#include <v8-util.h>

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

[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	SetReference (const K &key, const Persistent< Object > &parent)

void	RegisterExternallyReferencedObject (K &key)

void	RegisterExternallyReferencedObject (EmbedderReachableReferenceReporter *reporter, 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 161 of file v8-util.h.

Constructor & Destructor Documentation

◆ PersistentValueMapBase()

PersistentValueMapBase ( Isolate * isolate )

inlineexplicitprotected

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

◆ ~PersistentValueMapBase()

~PersistentValueMapBase ( )

inlineprotected

Definition at line 308 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 235 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 317 of file v8-util.h.

◆ Contains()

bool Contains ( const K & key )

inline

Check whether a value is contained in the map.

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

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

◆ FromVal()

static V* FromVal ( PersistentContainerValue v )

inlinestaticprotected

Definition at line 313 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(), PersistentValueMapBase< K, V, Traits >::RemoveWeak(), and PersistentValueMapBase< K, V, Traits >::SetReference().

◆ Get()

Local<V> Get ( const K & key )

inline

Get value stored in map.

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

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

◆ GetIsolate()

Isolate* GetIsolate ( )

inline

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

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

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

◆ impl()

Traits::Impl* impl ( )

inlineprotected

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

◆ isolate()

Isolate* isolate ( )

inlineprotected

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

◆ IsWeak()

bool IsWeak ( )

inline

Return whether the map holds weak persistents.

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

References v8::kNotWeak.

◆ Leak()

static PersistentContainerValue Leak ( Global< V > * persistent )

inlinestaticprotected

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

◆ RegisterExternallyReferencedObject() [1/2]

void RegisterExternallyReferencedObject	(	EmbedderReachableReferenceReporter *	reporter,
		K &	key
	)

inline

Use EmbedderReachableReferenceReporter with the map value for given key.

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

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

◆ RegisterExternallyReferencedObject() [2/2]

void RegisterExternallyReferencedObject ( K & key )

inline

Deprecated. Call V8::RegisterExternallyReferencedObject with the map value for given key. TODO(hlopko) Remove once migration to reporter is finished.

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

◆ 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 332 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 227 of file v8-util.h.

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

◆ RemoveWeak()

void RemoveWeak ( const K & key )

inlineprotected

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

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

◆ SetReference()

void SetReference	(	const K &	key,
		const Persistent< Object > &	parent
	)

inline

Call Isolate::SetReference with the given parent and the map value.

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

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

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

◆ Size()

size_t Size ( )

inline

Return size of the map.

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

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

include/v8-util.h

Data Structures

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ PersistentValueMapBase()

◆ ~PersistentValueMapBase()

Member Function Documentation

◆ Clear()

◆ ClearAndLeak()

◆ Contains()

◆ FromVal()

◆ Get()

◆ GetIsolate()

◆ GetReference()

◆ impl()

◆ isolate()

◆ IsWeak()

◆ Leak()

◆ RegisterExternallyReferencedObject() [1/2]

◆ RegisterExternallyReferencedObject() [2/2]

◆ Release()

◆ Remove()

◆ RemoveWeak()

◆ SetReference()

◆ SetReturnValue()

◆ Size()

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