Public Member Functions | List of all members
rapidsmpf::reservation_error Class Reference

Exception thrown when a memory reservation fails in RapidsMPF. More...

#include <error.hpp>

Inheritance diagram for rapidsmpf::reservation_error:
rapidsmpf::bad_alloc

Public Member Functions

 reservation_error (char const *msg)
 Construct a reservation_error with an error message. More...
 
 reservation_error (std::string const &msg)
 Construct a reservation_error with an error message. More...
 
- Public Member Functions inherited from rapidsmpf::bad_alloc
 bad_alloc (char const *msg)
 Construct a bad_alloc with the error message. More...
 
 bad_alloc (std::string const &msg)
 Construct a bad_alloc with the error message. More...
 
char const * what () const noexcept override
 Return the explanatory string. More...
 

Detailed Description

Exception thrown when a memory reservation fails in RapidsMPF.

This exception is thrown when attempting to reserve memory fails, or when an existing reservation is insufficient for a requested allocation. It does not necessarily indicate that the system is out of physical memory, only that the reservation contract could not be satisfied.

Definition at line 100 of file error.hpp.

Constructor & Destructor Documentation

◆ reservation_error() [1/2]

rapidsmpf::reservation_error::reservation_error ( char const *  msg)
inlineexplicit

Construct a reservation_error with an error message.

Parameters
msgMessage to be associated with the exception.

Definition at line 107 of file error.hpp.

◆ reservation_error() [2/2]

rapidsmpf::reservation_error::reservation_error ( std::string const &  msg)
inlineexplicit

Construct a reservation_error with an error message.

Parameters
msgMessage to be associated with the exception.

Definition at line 115 of file error.hpp.


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