#include <v8.h>
Public Member Functions | |
| Persistent () | |
| template<class S > | |
| Persistent (Persistent< S > that) | |
| template<class S > | |
| Persistent (S *that) | |
| template<class S > | |
| Persistent (Handle< S > that) | |
| template<class S > | |
| Persistent< S > | As () |
| void | Dispose () |
| void | MakeWeak (void *parameters, WeakReferenceCallback callback) |
| void | ClearWeak () |
| void | MarkIndependent () |
| bool | IsNearDeath () const |
| bool | IsWeak () const |
| void | SetWrapperClassId (uint16_t class_id) |
Static Public Member Functions | |
| template<class S > | |
| static Persistent< T > | Cast (Persistent< S > that) |
| static Persistent< T > | New (Handle< T > that) |
Friends | |
| class | ImplementationUtilities |
| class | ObjectTemplate |
Detailed Description
template<class T>
class v8::Persistent< T >
An object reference that is independent of any handle scope. Where a Local handle only lives as long as the HandleScope in which it was allocated, a Persistent handle remains valid until it is explicitly disposed.
A persistent handle contains a reference to a storage cell within the v8 engine which holds an object value and which is updated by the garbage collector whenever the object is moved. A new storage cell can be created using Persistent::New and existing handles can be disposed using Persistent::Dispose. Since persistent handles are passed by value you may have many persistent handle objects that point to the same storage cell. For instance, if you pass a persistent handle as an argument to a function you will not get two different storage cells but rather two references to the same storage cell.
Constructor & Destructor Documentation
| v8::Persistent< T >::Persistent | ( | ) | [inline] |
Creates an empty persistent handle that doesn't point to any storage cell.
| v8::Persistent< T >::Persistent | ( | Persistent< S > | that | ) | [inline] |
Creates a persistent handle for the same storage cell as the specified handle. This constructor allows you to pass persistent handles as arguments by value and to assign between persistent handles. However, attempting to assign between incompatible persistent handles, for instance from a Persistent<String> to a Persistent<Number> will cause a compile-time error. Assigning between compatible persistent handles, for instance assigning a Persistent<String> to a variable declared as Persistent<Value>, is allowed as String is a subclass of Value.
This check fails when trying to convert between incompatible handles. For example, converting from a Handle<String> to a Handle<Number>.
| v8::Persistent< T >::Persistent | ( | Handle< S > | that | ) | [inline, explicit] |
"Casts" a plain handle which is known to be a persistent handle to a persistent handle.
Member Function Documentation
| void v8::Persistent< T >::ClearWeak | ( | ) | [inline] |
Clears the weak reference to this object.
| void v8::Persistent< T >::Dispose | ( | ) | [inline] |
Releases the storage cell referenced by this persistent handle. Does not remove the reference to the cell from any handles. This handle's reference, and any other references to the storage cell remain and IsEmpty will still return false.
References v8::Handle< T >::IsEmpty().
| bool v8::Persistent< T >::IsNearDeath | ( | ) | const [inline] |
Checks if the handle holds the only reference to an object.
References v8::Handle< T >::IsEmpty().
| bool v8::Persistent< T >::IsWeak | ( | ) | const [inline] |
Returns true if the handle's reference is weak.
References v8::Handle< T >::IsEmpty().
| void v8::Persistent< T >::MakeWeak | ( | void * | parameters, | |
| WeakReferenceCallback | callback | |||
| ) | [inline] |
Make the reference to this object weak. When only weak handles refer to the object, the garbage collector will perform a callback to the given V8::WeakReferenceCallback function, passing it the object reference and the given parameters.
| void v8::Persistent< T >::MarkIndependent | ( | ) | [inline] |
Marks the reference to this object independent. Garbage collector is free to ignore any object groups containing this object. Weak callback for an independent handle should not assume that it will be preceded by a global GC prologue callback or followed by a global GC epilogue callback.
| Persistent< T > v8::Persistent< T >::New | ( | Handle< T > | that | ) | [inline, static] |
Creates a new persistent handle for an existing local or persistent handle.
References v8::Handle< T >::IsEmpty().
| void v8::Persistent< T >::SetWrapperClassId | ( | uint16_t | class_id | ) | [inline] |
Assigns a wrapper class ID to the handle. See RetainedObjectInfo interface description in v8-profiler.h for details.
The documentation for this class was generated from the following file:
- /home/ondras/svn/v8/include/v8.h
Generated on Thu Oct 6 2011 12:01:33 for V8 by
1.7.1