Namespaces
Variants
Views
Actions

std::set_new_handler

From cppreference.com
< cpp‎ | memory‎ | new
Revision as of 22:13, 31 May 2013 by P12bot (Talk | contribs)

 
 
 
 
 
Defined in header <new>
std::new_handler set_new_handler(std::new_handler new_p)

Makes new_p the new global new-handler function and returns the previously installed new-handler.

Contents

Notes

The new-handler function is the function called by allocation functions whenever a memory allocation attempt fails. Its intended purpose is one of three things:

1) make more memory available

2) terminate the program (e.g. by calling std::terminate)

3) throw exception of type std::bad_alloc or derived from std::bad_alloc

If new-handler returns, the allocation function repeats the previously-failed allocation attempt and calls the new-handler again if the allocation fails again. To end the loop, new-handler may call std::set_new_handler(nullptr): if, after a failed allocation attempt, allocation function finds that std::get_new_handler returns a null pointer value, it will throw std::bad_alloc.

At program startup, new-handler is a null pointer.

Parameters

new_p - pointer to function of type std::new_handler, or null pointer

Return value

The previously-installed new handler, or a null pointer value if none was installed.

Exceptions

noexcept specification:  
noexcept
  

Example

#include <iostream>
#include <new>
void handler()
{
    std::cout << "Memory allocation failed, terminating\n";
    std::set_new_handler(nullptr);
}
int main()
{
    std::set_new_handler(handler);
    try {
        while(true)
            new int[100000000ul];
    }catch(const std::bad_alloc& e) {
        std::cout << e.what() << '\n';
    }
}

Output:

Memory allocation failed, terminating
std::bad_alloc

See also

allocation functions
(function) [edit]
set_new_handler
registers a new handler
(function) [edit]
function pointer type of the new handler
(typedef) [edit]
exception thrown when memory allocation fails
(class) [edit]