#include <cross-thread-persistent.h>

Inheritance diagram for cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >:

[legend]

Collaboration diagram for cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >:

[legend]

Classes
class	UnsafeCtorTag

Public Types
using	PointeeType = T

Public Member Functions
	~BasicCrossThreadPersistent ()

	BasicCrossThreadPersistent (SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (std::nullptr_t, SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (SentinelPointer s, SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (T *raw, SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (UnsafeCtorTag, T *raw, SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (T &raw, SourceLocation loc=SourceLocation::Current())

template<typename U , typename MemberBarrierPolicy , typename MemberWeaknessTag , typename MemberCheckingPolicy , typename MemberStorageType , typename = std::enable_if_t<std::is_base_of_v<T, U>>>
	BasicCrossThreadPersistent (internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType > member, SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (const BasicCrossThreadPersistent &other, SourceLocation loc=SourceLocation::Current())

template<typename U , typename OtherWeaknessPolicy , typename OtherLocationPolicy , typename OtherCheckingPolicy , typename = std::enable_if_t<std::is_base_of_v<T, U>>>
	BasicCrossThreadPersistent (const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > &other, SourceLocation loc=SourceLocation::Current())

	BasicCrossThreadPersistent (BasicCrossThreadPersistent &&other, 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_v<T, U>>>
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_v<T, U>>>
BasicCrossThreadPersistent &	operator= (internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType > member)

BasicCrossThreadPersistent &	operator= (std::nullptr_t)

BasicCrossThreadPersistent &	operator= (SentinelPointer s)

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 = std::enable_if_t<!BasicCrossThreadPersistent< U, WeaknessPolicy>::IsStrongPersistent::value>>
BasicCrossThreadPersistent< U, internal::StrongCrossThreadPersistentPolicy >	Lock () const

Public Member Functions inherited from cppgc::internal::CrossThreadPersistentBase
	CrossThreadPersistentBase ()=default

	CrossThreadPersistentBase (const void *raw)

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 cppgc::internal::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 cppgc::internal::PersistentBase
const void *	raw_ = nullptr

PersistentNode *	node_ = nullptr

Member Typedef Documentation

◆ PointeeType

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

using cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::PointeeType = T

Constructor & Destructor Documentation

◆ ~BasicCrossThreadPersistent()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::~BasicCrossThreadPersistent ( )

inline

Here is the call graph for this function:

◆ BasicCrossThreadPersistent() [1/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent ( SourceLocation loc = SourceLocation::Current() )

inline

◆ BasicCrossThreadPersistent() [2/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	std::nullptr_t	,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

◆ BasicCrossThreadPersistent() [3/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	SentinelPointer	s,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

◆ BasicCrossThreadPersistent() [4/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	T *	raw,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

Here is the call graph for this function:

◆ BasicCrossThreadPersistent() [5/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	UnsafeCtorTag	,
		T *	raw,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

Here is the call graph for this function:

◆ BasicCrossThreadPersistent() [6/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	T &	raw,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

◆ 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_v<T, U>>>

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType >	member,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

◆ BasicCrossThreadPersistent() [8/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	const BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > &	other,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

◆ 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_v<T, U>>>

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > &	other,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inline

◆ BasicCrossThreadPersistent() [10/10]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::BasicCrossThreadPersistent	(	BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > &&	other,
		SourceLocation	loc = `SourceLocation::Current()`
	)

inlinenoexcept

Member Function Documentation

◆ Clear()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

void cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Clear ( )

inline

Clears the stored object.

Here is the caller graph for this function:

◆ Get()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

T * cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Get ( ) const

inline

Returns a pointer to the stored object.

Note: Not thread-safe.

Returns: a pointer to the stored object.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Lock()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

template<typename U = T, typename = std::enable_if_t<!BasicCrossThreadPersistent< U, WeaknessPolicy>::IsStrongPersistent::value>>

BasicCrossThreadPersistent< U, internal::StrongCrossThreadPersistentPolicy > cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Lock ( ) const

inline

◆ operator bool()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator bool ( ) const

inlineexplicit

Conversio to boolean.

Note: Not thread-safe.

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

Here is the call graph for this function:

◆ operator T*()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator T* ( ) const

inline

Conversion to object of type T.

Note: Not thread-safe.

Returns: the object.

Here is the call graph for this function:

◆ operator*()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

T & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator* ( ) const

inline

Here is the call graph for this function:

◆ operator->()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

T * cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator-> ( ) const

inline

Dereferences the stored object.

Note: Not thread-safe.

Here is the call graph for this function:

◆ operator=() [1/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > && other )

inline

Here is the call graph for this function:

◆ operator=() [2/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( const BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy > & other )

inline

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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_v<T, U>>>

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( const BasicCrossThreadPersistent< U, OtherWeaknessPolicy, OtherLocationPolicy, OtherCheckingPolicy > & other )

inline

Here is the call graph for this function:

◆ 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_v<T, U>>>

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( internal::BasicMember< U, MemberBarrierPolicy, MemberWeaknessTag, MemberCheckingPolicy, MemberStorageType > member )

inline

Here is the call graph for this function:

◆ operator=() [5/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( SentinelPointer s )

inline

Assigns the sentinel pointer.

Returns: the handle.

◆ operator=() [6/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( std::nullptr_t )

inline

Assigns a nullptr.

Returns: the handle.

Here is the call graph for this function:

◆ operator=() [7/7]

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

BasicCrossThreadPersistent & cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::operator= ( T * other )

inline

Assigns a raw pointer.

Note: Not thread-safe.

◆ Release()

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

T * cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::Release ( )

inline

Returns a pointer to the stored object and releases it.

Note: Not thread-safe.

Returns: a pointer to the stored object.

Here is the call graph for this function:

◆ 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 > cppgc::internal::BasicCrossThreadPersistent< T, WeaknessPolicy, LocationPolicy, CheckingPolicy >::To ( ) const

inline

Here is the call graph for this function:

Friends And Related Function Documentation

◆ internal::RootVisitor

template<typename T , typename WeaknessPolicy , typename LocationPolicy , typename CheckingPolicy >

friend class internal::RootVisitor

friend

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

include/cppgc/cross-thread-persistent.h

Classes

Public Types

Public Member Functions

Friends

Additional Inherited Members

Member Typedef Documentation

◆ PointeeType

Constructor & Destructor Documentation

◆ ~BasicCrossThreadPersistent()

◆ BasicCrossThreadPersistent() [1/10]

◆ BasicCrossThreadPersistent() [2/10]

◆ BasicCrossThreadPersistent() [3/10]

◆ BasicCrossThreadPersistent() [4/10]

◆ BasicCrossThreadPersistent() [5/10]

◆ BasicCrossThreadPersistent() [6/10]

◆ BasicCrossThreadPersistent() [7/10]

◆ BasicCrossThreadPersistent() [8/10]

◆ BasicCrossThreadPersistent() [9/10]

◆ BasicCrossThreadPersistent() [10/10]

Member Function Documentation

◆ Clear()

◆ Get()

◆ Lock()

◆ operator bool()

◆ operator T*()

◆ operator*()

◆ operator->()

◆ operator=() [1/7]

◆ operator=() [2/7]

◆ operator=() [3/7]

◆ operator=() [4/7]

◆ operator=() [5/7]

◆ operator=() [6/7]

◆ operator=() [7/7]

◆ Release()

◆ To()

Friends And Related Function Documentation

◆ internal::RootVisitor