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

Automic Reference Count. More...

#include <arc.hpp>

Inheritance diagram for mtcore::thread::Arc< T >:

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

Public Member Functions
T *	operator-> ()
	Dereferences an Arc pointer.
const T *	operator-> () const
	Dereferences an Arc pointer.
T &	operator* ()
	Dereferences an Arc pointer.
const T &	operator* () const
	Dereferences an Arc pointer.
bool	operator== (const Arc &o) const
	Checks if an Arc is equivalent to another Arc.
bool	operator== (T *other) const
	Checks if an Arc is equivalent to a pointer (used for nullptr checks)
bool	operator== (const T *other) const
	Checks if an Arc is equivalent to a pointer (used for nullptr checks)
bool	valid () const
	Checks if an Arc is valid (it points to something, and that something still exists)
	operator bool () const
	Checks if an Arc is valid (it points to something, and that something still exists)
template<typename... Args>
Result< void, AllocationError >	init (Allocator &alloc, Args... args)
	Tries to initialize an ARC to point to a new object.
Result< Arc, ArcError >	acquire (Allocator &alloc)
	Acquires a new Arc reference (increments ref count by 1)
void	release (Allocator &alloc)
	Releases an Arc reference (decrements ref count by 1)
void	deinit (Allocator &alloc)
Result< WeakArc< T >, ArcError >	weak ()
	Tries to get a weak pointer.

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

Detailed Description

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

Automic Reference Count.

A thread-safe reference count (basically a shared pointer replacement) Arc holds strong references Unlike std::shared_ptr, you must acquire() and release() manually (use mtdefer)

Template Parameters

T	Type of data pointed to

Definition at line 190 of file arc.hpp.

Member Function Documentation

acquire()

template<typename T>

Result< Arc, ArcError > mtcore::thread::Arc< T >::acquire ( Allocator & alloc )

inlinenodiscard

Acquires a new Arc reference (increments ref count by 1)

Parameters

alloc

Allocator for new pointer allocation

Returns

Resulting Arc or error

Definition at line 308 of file arc.hpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

deinit()

template<typename T>

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

inline

See also

Arc<typename T>::release()

Definition at line 343 of file arc.hpp.

{ release(alloc); }

Here is the call graph for this function:

Here is the caller graph for this function:

init()

template<typename T>

template<typename... Args>

Result< void, AllocationError > mtcore::thread::Arc< T >::init ( Allocator & alloc, Args... args )

inlinenodiscard

Tries to initialize an ARC to point to a new object.

Template Parameters

Args	Constructor argument types

Parameters

alloc	Allocator for memory allocation
args	Constructor arguments

Returns

success or error

Definition at line 282 of file arc.hpp.

                                                                                     {
      if (rc) {
        release(alloc);
      }
      Result<T *, AllocationError> valRes = alloc.create<T>(args...);
      if (valRes.is_error()) {
        return valRes.error();
      }
      T *val = valRes.value();
 
      auto outerRcRes = impl::RefCount<impl::RefCount<T>>::make(alloc);
      if (outerRcRes.is_error()) {
        alloc.destroy(val);
        return outerRcRes.error();
      }
      impl::RefCount<impl::RefCount<T>> *outerRc = outerRcRes.value();
      outerRc->value->value                      = valRes.value();
      rc                                         = outerRc;
      return success();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

operator bool()

template<typename T>

mtcore::thread::Arc< T >::operator bool ( ) const

inlinenodiscard

Checks if an Arc is valid (it points to something, and that something still exists)

Definition at line 272 of file arc.hpp.

{ return valid(); }

Here is the call graph for this function:

operator*() [1/2]

template<typename T>

T & mtcore::thread::Arc< T >::operator* ( )

inlinenodiscard

Dereferences an Arc pointer.

Definition at line 216 of file arc.hpp.

                                 {
      ensure(rc, "Invalid Arc");
      ensure(rc->value, "Invalid Arc");
      ensure(rc->value->value, "Invalid Arc");
      return *rc->value->value;
    }

operator*() [2/2]

template<typename T>

const T & mtcore::thread::Arc< T >::operator* ( ) const

inlinenodiscard

Dereferences an Arc pointer.

Definition at line 226 of file arc.hpp.

                                             {
      ensure(rc, "Invalid Arc");
      ensure(rc->value, "Invalid Arc");
      ensure(rc->value->value, "Invalid Arc");
      return *rc->value->value;
    }

operator->() [1/2]

template<typename T>

T * mtcore::thread::Arc< T >::operator-> ( )

inlinenodiscard

Dereferences an Arc pointer.

Definition at line 196 of file arc.hpp.

                                  {
      ensure(rc, "Invalid Arc");
      ensure(rc->value, "Invalid Arc");
      ensure(rc->value->value, "Invalid Arc");
      return rc->value->value;
    }

operator->() [2/2]

template<typename T>

const T * mtcore::thread::Arc< T >::operator-> ( ) const

inlinenodiscard

Dereferences an Arc pointer.

Definition at line 206 of file arc.hpp.

                                              {
      ensure(rc, "Invalid Arc");
      ensure(rc->value, "Invalid Arc");
      ensure(rc->value->value, "Invalid Arc");
      return rc->value->value;
    }

operator==() [1/3]

template<typename T>

bool mtcore::thread::Arc< T >::operator== ( const Arc< T > & o ) const

inlinenodiscard

Checks if an Arc is equivalent to another Arc.

Definition at line 236 of file arc.hpp.

{ return o.rc == rc; }

operator==() [2/3]

template<typename T>

bool mtcore::thread::Arc< T >::operator== ( const T * other ) const

inlinenodiscard

Checks if an Arc is equivalent to a pointer (used for nullptr checks)

Definition at line 254 of file arc.hpp.

                                                        {
      if (other == nullptr && rc == nullptr) {
        return true;
      }
      ensure(rc, "Invalid Arc");
      ensure(rc->value, "Invalid Arc");
      ensure(rc->value->value, "Invalid Arc");
      return rc->value->value == other;
    }

operator==() [3/3]

template<typename T>

bool mtcore::thread::Arc< T >::operator== ( T * other ) const

inlinenodiscard

Checks if an Arc is equivalent to a pointer (used for nullptr checks)

Definition at line 241 of file arc.hpp.

                                                  {
      if (other == nullptr && rc == nullptr) {
        return true;
      }
      ensure(rc, "Invalid Arc");
      ensure(rc->value, "Invalid Arc");
      ensure(rc->value->value, "Invalid Arc");
      return rc->value->value == other;
    }

release()

template<typename T>

void mtcore::thread::Arc< T >::release ( Allocator & alloc )

inline

Releases an Arc reference (decrements ref count by 1)

Parameters

alloc

Allocator for possible memory reclamation

Definition at line 325 of file arc.hpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

valid()

template<typename T>

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

inlinenodiscard

Checks if an Arc is valid (it points to something, and that something still exists)

Definition at line 267 of file arc.hpp.

{ return rc != nullptr && rc->value != nullptr && rc->value->value; }

Here is the caller graph for this function:

weak()

template<typename T>

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

inline

Tries to get a weak pointer.

Returns

Weak pointer (if successfully made) or error

Definition at line 349 of file arc.hpp.

                                        {
      ensure(rc, "Invalid Arc");
      if (!rc->acquire()) {
        return error(ArcError::CannotAcquire);
      }
      return success(WeakArc<T>{rc});
    }

Here is the call graph for this function:

Member Data Documentation

rc

template<typename T>

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

Definition at line 191 of file arc.hpp.

---

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

• arc.hpp