In some rare cases, the client libraries may need to terminate the application because it encounters an unrecoverable error. For example:
If the application calls StatusOr<T>::value(), and the library was compiled with exceptions disabled, and the StatusOr<T> contains an error, then the function throws an exception to report the error as the function cannot return a valid value. Applications that disable exceptions should query the StatusOr<T> status (using .ok() or .status()) and avoid calling .value() if the StatusOr<T> is holding an error.
If the application calls future<T>::get(), the library was compiled with exceptions disabled, and (somehow) the future is satisfied with an exception. Note that the library APIs typically return future<StatusOr<T>> to avoid this problem, but the application may have created future<T> and promise<T> pairs in their own code.
In these cases there is no mechanism to return the error. The library cannot continue working correctly and must terminate the program. The application may want to intercept these errors, before the application crashes, and log or otherwise capture additional information to help with debugging or troubleshooting. The functions in this module can be used to do so.
By their nature, there is no mechanism to "handle" and "recover" from unrecoverable errors. All the application can do is log additional information before the program terminates.
Note that the libraries do not use functions that can trigger unrecoverable errors (if they do we consider that a library bug).
The default behavior in the client library is to call std::abort() when an unrecoverable error occurs.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["This document details how to handle unrecoverable errors in client libraries, which may lead to application termination due to issues like calling `.value()` on a `StatusOr\u003cT\u003e` with an error when exceptions are disabled, or when a future is satisfied with an exception."],["In these error scenarios, the library's behavior defaults to calling `std::abort()`, as there's no way to recover or return from such errors, only a mechanism to add additional information before the termination occurs."],["The primary purpose of this documentation is to present how applications can intercept and log additional information about these unrecoverable errors using functions such as `SetTerminateHandler(TerminateHandler)`, `GetTerminateHandler()`, and `Terminate(char const *)`."],["The document list the various versions available for the library, ranging from version 2.10.1 to 2.37.0-rc."],["When handling these situations, there is no mechanism for recovery; the program will still terminate, however it does allow additional logs to be recorded before the termination takes place."]]],[]]
