Remote counter implementation object. More...
#include <worldref.h>
Inheritance diagram for madness::detail::RemoteCounterImpl< T >:
Collaboration diagram for madness::detail::RemoteCounterImpl< T >:
Public Member Functions | |
| RemoteCounterImpl (const std::shared_ptr< T > &p) | |
| virtual | ~RemoteCounterImpl () |
| const std::shared_ptr< T > & | get_shared () const |
| Shared pointer accessor. More... | |
| virtual void * | key () const |
| Counter key accessor. More... | |
 Public Member Functions inherited from madness::detail::RemoteCounterBase | |
| RemoteCounterBase () | |
| virtual | ~RemoteCounterBase () |
| void | add_ref () |
| Increment the reference count. More... | |
| template<typename T > | |
| const std::shared_ptr< T > & | get_shared () const |
| Shared pointer accessor. More... | |
| bool | release () |
| Decrement the reference count. More... | |
| long | use_count () const |
| Remote and local counter accessor. More... | |
Private Attributes | |
| std::shared_ptr< T > | pointer_ |
| pointer that is remotely referenced More... | |
Detailed Description
template<typename T>
class madness::detail::RemoteCounterImpl< T >
Remote counter implementation object.
This class stores a shared pointer in memory to ensure that the referenced object is valid as long as there are outstanding remote references.
- Template Parameters
-
T The type of the referenced shared_ptr object.
- Note
- This class is considered an implementation detail and may change at any time. You should not use this class directly.
Constructor & Destructor Documentation
◆ RemoteCounterImpl()
template<typename T >
|
inlineexplicit |
◆ ~RemoteCounterImpl()
template<typename T >
|
inlinevirtual |
Member Function Documentation
◆ get_shared()
template<typename T >
|
inline |
Shared pointer accessor.
- Returns
- A const reference to the stored shared pointer
References madness::detail::RemoteCounterImpl< T >::pointer_.
◆ key()
template<typename T >
|
inlinevirtual |
Counter key accessor.
The key is the pointer for which the remote counter is counting references.
- Returns
- The pointer that is being counted.
Implements madness::detail::RemoteCounterBase.
References madness::detail::RemoteCounterImpl< T >::pointer_.
Member Data Documentation
◆ pointer_
template<typename T >
|
private |
pointer that is remotely referenced
Referenced by madness::detail::RemoteCounterImpl< T >::get_shared(), and madness::detail::RemoteCounterImpl< T >::key().
The documentation for this class was generated from the following file:
