mtcore::WeakRc< T > Struct Template Reference

Thread-local weak reference counted pointer Not thread safe, don't share Does not hold lifetime. More...

#include <rc.hpp>

Public Member Functions
Result< Rc< T >, RcError >	obtain (Allocator &alloc)
	Tries to obtain a strong reference May error if could not obtain (e.g.
void	deinit (Allocator &alloc)
	Deinitializes a weak pointer Will decrement weak count and may clean up counter.
bool	valid () const
	Checks if weak reference is valid.
	operator bool () const
	Checks if weak reference is valid.
Result< WeakRc, RcError >	copy ()
	Tries to copy a weak reference.

Public Attributes
impl::ThreadLocalRefCount< T > *	rc = nullptr

Detailed Description

template<typename T>
struct mtcore::WeakRc< T >

Thread-local weak reference counted pointer Not thread safe, don't share Does not hold lifetime.

May try to obtain lifetime with "obtain(alloc)"

Template Parameters

T	Type pointed to

Definition at line 106 of file rc.hpp.

Member Function Documentation

copy()

template<typename T>

Result< WeakRc, RcError > mtcore::WeakRc< T >::copy ( )

inline

Tries to copy a weak reference.

Definition at line 145 of file rc.hpp.

                                   {
      ensure(rc, "Rc is invalid");
      if (!rc->acquireWeak()) {
        return error(RcError::CANNOT_ACQUIRE);
      }
      return *this;
    }

Here is the call graph for this function:

deinit()

template<typename T>

void mtcore::WeakRc< T >::deinit ( Allocator & alloc )

inline

Deinitializes a weak pointer Will decrement weak count and may clean up counter.

Parameters

alloc

Allocator for cleanup

Definition at line 121 of file rc.hpp.

                                  {
      if (!rc) {
        return;
      }
 
      ensure(rc, "Rc is invalid");
      if (rc->releaseWeak()) {
        alloc.destroy(rc);
      }
    }

Here is the call graph for this function:

obtain()

template<typename T>

Result< Rc< T >, RcError > mtcore::WeakRc< T >::obtain

(

Allocator &

alloc

)

Tries to obtain a strong reference May error if could not obtain (e.g.

already cleaned up)

Parameters

alloc

Allocator to use to obtain reference

Definition at line 296 of file rc.hpp.

                                                           {
    ensure(rc, "arc is invalid");
    if (!rc->acquireStrong()) {
      return error(RcError::CANNOT_ACQUIRE);
    }
    return Rc<T>{rc};
  }

Here is the call graph for this function:

operator bool()

template<typename T>

mtcore::WeakRc< T >::operator bool ( ) const

inlinenodiscard

Checks if weak reference is valid.

Definition at line 140 of file rc.hpp.

{ return valid(); }

Here is the call graph for this function:

valid()

template<typename T>

bool mtcore::WeakRc< T >::valid ( ) const

inlinenodiscard

Checks if weak reference is valid.

Definition at line 135 of file rc.hpp.

{ return rc != nullptr; }

Here is the caller graph for this function:

Member Data Documentation

rc

template<typename T>

impl::ThreadLocalRefCount<T>* mtcore::WeakRc< T >::rc = nullptr

Definition at line 107 of file rc.hpp.

---

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

• rc.hpp