v8 12.4.254 (node 22.4.1)
V8 is Google's open source JavaScript engine
Loading...
Searching...
No Matches
Data Structures | Public Types | Public Member Functions | Friends
BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > Class Template Referencefinal

#include <cross-thread-persistent.h>

Inheritance diagram for BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >:
Inheritance graph
[legend]
Collaboration diagram for BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >:
Collaboration graph
[legend]

Data Structures

class  UnsafeCtorTag
 

Public Types

using PointeeType = T
 

Public Member Functions

 ~BasicCrossThreadPersistent ()
 
 BasicCrossThreadPersistent (const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (std::nullptr_t, const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (SentinelPointer s, const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (T *raw, const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (UnsafeCtorTag, T *raw, const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (T &raw, const SourceLocation &loc=SourceLocation::Current())
 
template<typename U , typename MemberBarrierPolicy , typename MemberWeaknessTag , typename MemberCheckingPolicy , typename MemberStorageType , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
 BasicCrossThreadPersistent (internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType > member, const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (const BasicCrossThreadPersistent &other, const SourceLocation &loc=SourceLocation::Current())
 
template<typename U , typename OtherWeaknessPolicy , typename OtherLocationPolicy , typename OtherCheckingPolicy , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
 BasicCrossThreadPersistent (const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > &other, const SourceLocation &loc=SourceLocation::Current())
 
 BasicCrossThreadPersistent (BasicCrossThreadPersistent &&other, const SourceLocation &loc=SourceLocation::Current()) noexcept
 
BasicCrossThreadPersistent & operator= (const BasicCrossThreadPersistent &other)
 
template<typename U , typename OtherWeaknessPolicy , typename OtherLocationPolicy , typename OtherCheckingPolicy , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
BasicCrossThreadPersistent & operator= (const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > &other)
 
BasicCrossThreadPersistent & operator= (BasicCrossThreadPersistent &&other)
 
BasicCrossThreadPersistent & operator= (T *other)
 
template<typename U , typename MemberBarrierPolicy , typename MemberWeaknessTag , typename MemberCheckingPolicy , typename MemberStorageType , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
BasicCrossThreadPersistent & operator= (internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType > member)
 
BasicCrossThreadPersistent & operator= (std::nullptr_t)
 
BasicCrossThreadPersistent & operator= (SentinelPointer s)
 
 V8_CLANG_NO_SANITIZE ("cfi-unrelated-cast") T *Get() const
 
void Clear ()
 
T * Release ()
 
 operator bool () const
 
 operator T* () const
 
T * operator-> () const
 
T & operator* () const
 
template<typename U , typename OtherWeaknessPolicy = WeaknessPolicy, typename OtherLocationPolicy = LocationPolicy, typename OtherCheckingPolicy = CheckingPolicy>
BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > To () const
 
template<typename U = T, typename = typename std::enable_if<!BasicCrossThreadPersistent< U, WeaknessPolicy>::IsStrongPersistent::value>::type>
BasicCrossThreadPersistent< U, internal::StrongCrossThreadPersistentPolicy > Lock () const
 
- Public Member Functions inherited from CrossThreadPersistentBase
 CrossThreadPersistentBase ()=default
 
 CrossThreadPersistentBase (const void *raw)
 
 V8_CLANG_NO_SANITIZE ("address") const void *GetValueFromGC() const
 
PersistentNode * GetNodeFromGC () const
 
void ClearFromGC () const
 
PersistentNode * GetNodeSafe () const
 
void SetNodeSafe (PersistentNode *value) const
 

Friends

class internal::RootVisitor
 

Additional Inherited Members

- Protected Member Functions inherited from PersistentBase
 PersistentBase ()=default
 
 PersistentBase (const void *raw)
 
const void * GetValue () const
 
void SetValue (const void *value)
 
PersistentNode * GetNode () const
 
void SetNode (PersistentNode *node)
 
void ClearFromGC () const
 
- Protected Attributes inherited from PersistentBase
const void * raw_ = nullptr
 
PersistentNode * node_ = nullptr
 

Detailed Description

template<typename T, typename WeaknessPolicy, typename LocationPolicy, typename CheckingPolicy>
class cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >

Definition at line 71 of file cross-thread-persistent.h.

Member Typedef Documentation

◆ PointeeType

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
using PointeeType = T

Definition at line 77 of file cross-thread-persistent.h.

Constructor & Destructor Documentation

◆ ~BasicCrossThreadPersistent()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
~BasicCrossThreadPersistent ( )
inline

Definition at line 79 of file cross-thread-persistent.h.

References CPPGC_DCHECK, CrossThreadPersistentRegion::FreeNode(), PersistentBase::GetNode(), CrossThreadPersistentBase::GetNodeSafe(), PersistentBase::GetValue(), and PersistentBase::SetNode().

◆ BasicCrossThreadPersistent() [1/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( const SourceLocation &  loc = SourceLocation::Current())
inline

Definition at line 105 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [2/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( std::nullptr_t  ,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 109 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [3/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( SentinelPointer  s,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 113 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [4/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( T *  raw,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 117 of file cross-thread-persistent.h.

References CrossThreadPersistentRegion::AllocateNode(), and PersistentBase::SetNode().

◆ BasicCrossThreadPersistent() [5/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( UnsafeCtorTag  ,
T *  raw,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 135 of file cross-thread-persistent.h.

References CrossThreadPersistentRegion::AllocateNode(), and PersistentBase::SetNode().

◆ BasicCrossThreadPersistent() [6/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( T &  raw,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 145 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [7/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
template<typename U , typename MemberBarrierPolicy , typename MemberWeaknessTag , typename MemberCheckingPolicy , typename MemberStorageType , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
BasicCrossThreadPersistent ( internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType >  member,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 153 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [8/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( const BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > &  other,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 160 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [9/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
template<typename U , typename OtherWeaknessPolicy , typename OtherLocationPolicy , typename OtherCheckingPolicy , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
BasicCrossThreadPersistent ( const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > &  other,
const SourceLocation &  loc = SourceLocation::Current() 
)
inline

Definition at line 172 of file cross-thread-persistent.h.

◆ BasicCrossThreadPersistent() [10/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent ( BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > &&  other,
const SourceLocation &  loc = SourceLocation::Current() 
)
inlinenoexcept

Definition at line 181 of file cross-thread-persistent.h.

Member Function Documentation

◆ Clear()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
void Clear ( )
inline

Clears the stored object.

Definition at line 281 of file cross-thread-persistent.h.

Referenced by BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator=(), BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator=(), and BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Release().

◆ Lock()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
template<typename U = T, typename = typename std::enable_if<!BasicCrossThreadPersistent< U, WeaknessPolicy>::IsStrongPersistent::value>::type>
BasicCrossThreadPersistent< U, internal::StrongCrossThreadPersistentPolicy > Lock ( ) const
inline

Definition at line 344 of file cross-thread-persistent.h.

◆ operator bool()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
operator bool ( ) const
inlineexplicit

Conversio to boolean.

Note: Not thread-safe.

Returns
true if an actual object has been stored and false otherwise.

Definition at line 306 of file cross-thread-persistent.h.

◆ operator T*()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
operator T* ( ) const
inline

Conversion to object of type T.

Note: Not thread-safe.

Returns
the object.

Definition at line 315 of file cross-thread-persistent.h.

◆ operator*()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
T & operator* ( ) const
inline

Definition at line 323 of file cross-thread-persistent.h.

◆ operator->()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
T * operator-> ( ) const
inline

Dereferences the stored object.

Note: Not thread-safe.

Definition at line 322 of file cross-thread-persistent.h.

◆ operator=() [1/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent & operator= ( BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > &&  other)
inline

Definition at line 207 of file cross-thread-persistent.h.

References BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Clear(), PersistentBase::GetNode(), PersistentBase::GetValue(), PersistentBase::SetNode(), PersistentBase::SetValue(), and PersistentNode::UpdateOwner().

◆ operator=() [2/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent & operator= ( const BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > &  other)
inline

Definition at line 188 of file cross-thread-persistent.h.

Referenced by BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator=().

◆ operator=() [3/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
template<typename U , typename OtherWeaknessPolicy , typename OtherLocationPolicy , typename OtherCheckingPolicy , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
BasicCrossThreadPersistent & operator= ( const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > &  other)
inline

Definition at line 198 of file cross-thread-persistent.h.

◆ operator=() [4/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
template<typename U , typename MemberBarrierPolicy , typename MemberWeaknessTag , typename MemberCheckingPolicy , typename MemberStorageType , typename = std::enable_if_t<std::is_base_of<T, U>::value>>
BasicCrossThreadPersistent & operator= ( internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType >  member)
inline

Definition at line 236 of file cross-thread-persistent.h.

References BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator=().

◆ operator=() [5/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent & operator= ( SentinelPointer  s)
inline

Assigns the sentinel pointer.

Returns
the handle.

Definition at line 258 of file cross-thread-persistent.h.

◆ operator=() [6/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent & operator= ( std::nullptr_t  )
inline

Assigns a nullptr.

Returns
the handle.

Definition at line 248 of file cross-thread-persistent.h.

References BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Clear().

◆ operator=() [7/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
BasicCrossThreadPersistent & operator= ( T *  other)
inline

Assigns a raw pointer.

Note: Not thread-safe.

Definition at line 226 of file cross-thread-persistent.h.

◆ Release()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
T * Release ( )
inline

Returns a pointer to the stored object and releases it.

Note: Not thread-safe.

Returns
a pointer to the stored object.

Definition at line 293 of file cross-thread-persistent.h.

References BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Clear().

◆ To()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
template<typename U , typename OtherWeaknessPolicy = WeaknessPolicy, typename OtherLocationPolicy = LocationPolicy, typename OtherCheckingPolicy = CheckingPolicy>
BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > To ( ) const
inline

Definition at line 330 of file cross-thread-persistent.h.

◆ V8_CLANG_NO_SANITIZE()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
V8_CLANG_NO_SANITIZE ( "cfi-unrelated-cast"  ) const
inline

Returns a pointer to the stored object.

Note: Not thread-safe.

Returns
a pointer to the stored object.

Definition at line 274 of file cross-thread-persistent.h.

References PersistentBase::GetValue().

Friends And Related Symbol Documentation

◆ internal::RootVisitor

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >
friend class internal::RootVisitor
friend

Definition at line 420 of file cross-thread-persistent.h.

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