Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify behavior of sentry_flush + sentry_close #883

Merged
merged 5 commits into from
Sep 13, 2023
Merged

docs: clarify behavior of sentry_flush + sentry_close #883

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5b98a8c
clarify that sentry_shutdown does not remove any crash handlers
sapphonie Sep 12, 2023
795e9a9
clarify further that sentry_shutdown *does* shutdown the crash handle…
sapphonie Sep 12, 2023
ba033b3
Clarify blocking behavior of sentry_close / sentry_flush
sapphonie Sep 12, 2023
abfcb19
format comments + minor fixes
supervacuus Sep 13, 2023
8d9115a
Update changelog
supervacuus Sep 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions include/sentry.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1267,13 +1267,25 @@ SENTRY_API int sentry_init(sentry_options_t *options);
* The `timeout` parameter is in milliseconds.
*
* Returns 0 on success, or a non-zero return value in case the timeout is hit.
*
* Note that this function will block the thread it was called from until the
* sentry background worker has finished its work or it timed out, whichever
* comes first.
*/
SENTRY_API int sentry_flush(uint64_t timeout);

/**
* Shuts down the sentry client and forces transports to flush out.
*
* Returns 0 on success.
*
* Note that this does not uninstall any crash handler installed by our
* backends, which will still process crashes after `sentry_close()`, except
* when using `crashpad` on Linux or the `inproc` backend.
*
* Further note that this function will block the thread it was called from
* until the sentry background worker has finished its work or it timed out,
* whichever comes first.
*/
SENTRY_API int sentry_close(void);

Expand Down