mtcore::thread::WeakArc< T > Struct Template Reference

Weak Automic Reference Count. More...

#include <arc.hpp>

Collaboration diagram for mtcore::thread::WeakArc< T >:

Public Member Functions
Result< Arc< T >, ArcError >	obtain (Allocator &alloc)
	Tries to obtain a strong reference to what's pointed at.
void	deinit (Allocator &alloc)
	Deinitializes a weak pointer (may Result in memory cleanup if last weak counter)
bool	valid () const
	Checks if a weak pointer is "valid" as in it's set to point to something Does NOT check if the referenced object is still alive (use obtain for that)
Result< WeakArc, ArcError >	copy ()
	Tries to copy a weak reference.

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

Detailed Description

template<typename T>
struct mtcore::thread::WeakArc< T >

Weak Automic Reference Count.

A thread-safe weak reference count (basically a shared pointer replacement) WeakArc holds weak references. References must be upgraded to strong references before dereferencing Unlike std::weak_ptr, you must copy() and denit() manually (use mtdefer)

Template Parameters

T	Type of data pointed to

Definition at line 141 of file arc.hpp.

Member Function Documentation

copy()

template<typename T>

Result< WeakArc, ArcError > mtcore::thread::WeakArc< T >::copy ( )

inline

Tries to copy a weak reference.

Returns

Another weak reference (if can obtain)

Definition at line 180 of file arc.hpp.

                                     {
      ensure(rc, "Arc is invalid");
      if (rc->acquire()) {
        return *this;
      }
      return error(ArcError::CannotAcquire);
    }

Here is the call graph for this function:

deinit()

template<typename T>

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

inline

Deinitializes a weak pointer (may Result in memory cleanup if last weak counter)

Parameters

alloc

Allocator for cleanup

Definition at line 155 of file arc.hpp.

                                  {
      if (!rc) {
        return;
      }
      ensure(rc, "Arc is invalid");
      ensure(rc->value, "Arc is invalid");
      if (rc->release(alloc)) {
        alloc.destroy(rc->value);
        rc->value = nullptr;
        alloc.destroy(rc);
      }
      rc = nullptr;
    }

Here is the call graph for this function:

obtain()

template<typename T>

Result< Arc< T >, ArcError > mtcore::thread::WeakArc< T >::obtain

(

Allocator &

alloc

)

Tries to obtain a strong reference to what's pointed at.

Parameters

alloc

Allocator to use for memory allocation/deallocation

Returns

Result with strong reference (if possible) or error

Definition at line 359 of file arc.hpp.

                                                              {
    ensure(rc, "Arc is invalid");
    if (!rc->acquire()) {
      return error(ArcError::CannotAcquire);
    }
 
    if (!rc->value->acquire()) {
      rc->release(alloc);
      return error(ArcError::CannotAcquire);
    }
    return Arc<T>{rc};
  }

Here is the call graph for this function:

valid()

template<typename T>

bool mtcore::thread::WeakArc< T >::valid ( ) const

inlinenodiscard

Checks if a weak pointer is "valid" as in it's set to point to something Does NOT check if the referenced object is still alive (use obtain for that)

Returns

bool if RC is valid

Definition at line 174 of file arc.hpp.

{ return rc != nullptr; }

Member Data Documentation

rc

template<typename T>

impl::RefCount<impl::RefCount<T> >* mtcore::thread::WeakArc< T >::rc = nullptr

Definition at line 142 of file arc.hpp.

---

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

• arc.hpp