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 that may cause application termination in the client libraries, focusing on scenarios where exceptions are disabled."],["Unrecoverable errors can occur when calling `StatusOr\u003cT\u003e::value()` or `future\u003cT\u003e::get()` with exceptions disabled and when an error is present, leading to the library's inability to continue."],["While the errors themselves are unrecoverable, the provided functions `SetTerminateHandler`, `GetTerminateHandler`, and `Terminate` allow applications to intercept these errors to log information before termination."],["The default behavior of the client library upon encountering an unrecoverable error is to call `std::abort()`, unless the application sets up their own terminate handler."],["The document references multiple versions of the library with the most recent being version 2.37.0-rc and going as far back as 2.10.1, all having this information."]]],[]]
