v8  5.5.372(node7.10.1)
V8 is Google's open source JavaScript engine
Local< T > Class Template Reference

#include <v8.h>

Public Member Functions

V8_INLINE Local ()
 
template<class S >
V8_INLINE Local (Local< S > that)
 
V8_INLINE bool IsEmpty () const
 
V8_INLINE void Clear ()
 
V8_INLINE T * operator-> () const
 
V8_INLINE T * operator* () const
 
template<class S >
V8_INLINE bool operator== (const Local< S > &that) const
 
template<class S >
V8_INLINE bool operator== (const PersistentBase< S > &that) const
 
template<class S >
V8_INLINE bool operator!= (const Local< S > &that) const
 
template<class S >
V8_INLINE bool operator!= (const Persistent< S > &that) const
 
template<class S >
V8_INLINE Local< S > As () const
 

Static Public Member Functions

template<class S >
static V8_INLINE Local< T > Cast (Local< S > that)
 
static V8_INLINE Local< T > New (Isolate *isolate, Local< T > that)
 
static V8_INLINE Local< T > New (Isolate *isolate, const PersistentBase< T > &that)
 

Friends

class Utils
 
template<class F >
class Eternal
 
template<class F >
class PersistentBase
 
template<class F , class M >
class Persistent
 
template<class F >
class Local
 
template<class F >
class MaybeLocal
 
template<class F >
class FunctionCallbackInfo
 
template<class F >
class PropertyCallbackInfo
 
class String
 
class Object
 
class Context
 
class Private
 
template<class F >
class internal::CustomArguments
 
class HandleScope
 
class EscapableHandleScope
 
template<class F1 , class F2 , class F3 >
class PersistentValueMapBase
 
template<class F1 , class F2 >
class PersistentValueVector
 
template<class F >
class ReturnValue
 
Local< PrimitiveUndefined (Isolate *isolate)
 
Local< PrimitiveNull (Isolate *isolate)
 
Local< BooleanTrue (Isolate *isolate)
 
Local< BooleanFalse (Isolate *isolate)
 

Detailed Description

template<class T>
class v8::Local< T >

An object reference managed by the v8 garbage collector.

All objects returned from v8 have to be tracked by the garbage collector so that it knows that the objects are still alive. Also, because the garbage collector may move objects, it is unsafe to point directly to an object. Instead, all objects are stored in handles which are known by the garbage collector and updated whenever an object moves. Handles should always be passed by value (except in cases like out-parameters) and they should never be allocated on the heap.

There are two types of handles: local and persistent handles. Local handles are light-weight and transient and typically used in local operations. They are managed by HandleScopes. Persistent handles can be used when storing objects across several independent operations and have to be explicitly deallocated when they're no longer used.

It is safe to extract the object stored in the handle by dereferencing the handle (for instance, to extract the Object* from a Local<Object>); the value will still be governed by a handle behind the scenes and the same rules apply to these values as to their handles.

Definition at line 116 of file v8.h.

Constructor & Destructor Documentation

V8_INLINE Local ( )
inline
V8_INLINE Local ( Local< S >  that)
inline

This check fails when trying to convert between incompatible handles. For example, converting from a Local<String> to a Local<Number>.

Definition at line 225 of file v8.h.

Member Function Documentation

V8_INLINE Local<S> As ( ) const
inline

Definition at line 299 of file v8.h.

static V8_INLINE Local<T> Cast ( Local< S >  that)
inlinestatic

Definition at line 289 of file v8.h.

V8_INLINE void Clear ( )
inline

Sets the handle to be empty. IsEmpty() will then return true.

Definition at line 243 of file v8.h.

V8_INLINE bool IsEmpty ( ) const
inline

Returns true if the handle is empty.

Definition at line 238 of file v8.h.

Referenced by ScriptOrigin::ScriptOrigin().

Local< T > New ( Isolate isolate,
Local< T >  that 
)
static

Create a local handle for the content of another handle. The referee is kept alive by the local handle even when the original handle is destroyed/disposed.

Definition at line 8414 of file v8.h.

Local< T > New ( Isolate isolate,
const PersistentBase< T > &  that 
)
static

Definition at line 8419 of file v8.h.

V8_INLINE bool operator!= ( const Local< S > &  that) const
inline

Checks whether two handles are different. Returns true if only one of the handles is empty, or if the objects to which they refer are different. The handles' references are not checked.

Definition at line 280 of file v8.h.

V8_INLINE bool operator!= ( const Persistent< S > &  that) const
inline

Definition at line 284 of file v8.h.

V8_INLINE T* operator* ( ) const
inline

Definition at line 247 of file v8.h.

V8_INLINE T* operator-> ( ) const
inline

Definition at line 245 of file v8.h.

Referenced by Context::Scope::Scope(), ScriptOrigin::ScriptOrigin(), and Context::Scope::~Scope().

V8_INLINE bool operator== ( const Local< S > &  that) const
inline

Checks whether two handles are the same. Returns true if both are empty, or if the objects to which they refer are identical. The handles' references are not checked.

Definition at line 256 of file v8.h.

V8_INLINE bool operator== ( const PersistentBase< S > &  that) const
inline

Definition at line 264 of file v8.h.

Friends And Related Function Documentation

friend class Context
friend

Definition at line 324 of file v8.h.

friend class EscapableHandleScope
friend

Definition at line 332 of file v8.h.

friend class Eternal
friend

Definition at line 314 of file v8.h.

Local<Boolean> False ( Isolate isolate)
friend

Definition at line 9450 of file v8.h.

friend class FunctionCallbackInfo
friend

Definition at line 320 of file v8.h.

friend class HandleScope
friend

Definition at line 331 of file v8.h.

friend class internal::CustomArguments
friend

Definition at line 326 of file v8.h.

friend class Local
friend

Definition at line 317 of file v8.h.

friend class MaybeLocal
friend

Definition at line 319 of file v8.h.

Local<Primitive> Null ( Isolate isolate)
friend

Definition at line 9432 of file v8.h.

friend class Object
friend

Definition at line 323 of file v8.h.

friend class Persistent
friend

Definition at line 316 of file v8.h.

friend class PersistentBase
friend

Definition at line 315 of file v8.h.

friend class PersistentValueMapBase
friend

Definition at line 334 of file v8.h.

friend class PersistentValueVector
friend

Definition at line 335 of file v8.h.

friend class Private
friend

Definition at line 325 of file v8.h.

friend class PropertyCallbackInfo
friend

Definition at line 321 of file v8.h.

friend class ReturnValue
friend

Definition at line 337 of file v8.h.

friend class String
friend

Definition at line 322 of file v8.h.

Local<Boolean> True ( Isolate isolate)
friend

Definition at line 9441 of file v8.h.

Local<Primitive> Undefined ( Isolate isolate)
friend

Definition at line 9423 of file v8.h.

friend class Utils
friend

Definition at line 313 of file v8.h.


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