Namespaces
Variants
Views
Actions

std::declare_reachable

From cppreference.com
< cpp‎ | memory
 
 
Utilities library
General utilities
Relational operators (deprecated in C++20)
 
Dynamic memory management
Uninitialized memory algorithms
(C++17)
(C++17)
(C++20)
(C++17)
Constrained uninitialized
memory algorithms
C Library

Allocators
Memory resources
Garbage collection support
declare_reachable
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
(C++11)(until C++23)
Uninitialized storage
(until C++20*)
(until C++20*)
Explicit lifetime management
 
Defined in header <memory>
void declare_reachable( void* p );
(since C++11)
(removed in C++23)

Declares the object referenced by the pointer p reachable. Reachable objects will not be deleted by the garbage collector or considered to be a leak by a leak detector even if all pointers to it are destroyed. An object may be declared reachable multiple times, in which case multiple calls to std::undeclare_reachable would be needed to remove this property. For example, a XOR linked list needs to declare its nodes reachable if the implementation has garbage collection enabled.

Contents

[edit] Parameters

p - a safely-derived pointer or a null pointer

[edit] Return value

(none)

[edit] Exceptions

May throw std::bad_alloc if the system cannot allocate memory required to track reachable objects.

[edit] See also

(C++11)(removed in C++23)
declares that an object can be recycled
(function template) [edit]