Index: client/crashpad_client.h |
diff --git a/client/crashpad_client.h b/client/crashpad_client.h |
index c33112cadb72cf18c3e322638d545b4cd4047954..7b0f8996e5f0660713eda1e3f9251478ce8ffc5f 100644 |
--- a/client/crashpad_client.h |
+++ b/client/crashpad_client.h |
@@ -49,6 +49,9 @@ class CrashpadClient { |
//! send right corresponding to a receive right held by the handler process. |
//! The handler process runs an exception server on this port. |
//! |
+ //! On Windows, SetHandler() is normally used instead since the handler is |
+ //! started by other means. |
+ //! |
//! \param[in] handler The path to a Crashpad handler executable. |
//! \param[in] database The path to a Crashpad database. The handler will be |
//! started with this path as its `--database` argument. |
@@ -69,9 +72,25 @@ class CrashpadClient { |
const std::map<std::string, std::string>& annotations, |
const std::vector<std::string>& arguments); |
+ //! \brief Sets the IPC port of a presumably running Crashpad handler process |
Mark Mentovai
2015/04/28 17:53:04
presumably-running
|
+ //! which was started with StartHandler() or by other compatible means |
+ //! and does an IPC message exchange to register this process with the |
+ //! handler. However, just like StartHandler() crashes are not serviced |
Mark Mentovai
2015/04/28 17:53:05
comma after StartHandler()
|
+ //! until UseHandler() is called. |
+ //! |
+ //! The IPC port name (somehow) encodes enough information so that |
scottmg
2015/04/24 04:55:06
Maybe make the "enough information" explicit param
cpu_(ooo_6.6-7.5)
2015/04/24 19:40:11
The "encodes" is misleading, I think the pipe name
|
+ //! registration is done with a crash handler using the appropiate database |
+ //! and upload server. |
+ //! |
+ //! \param[in] the full name of the crash handler IPC port. |
scottmg
2015/04/24 04:55:06
I think this should be
\param[in] ipc_port the
Mark Mentovai
2015/04/28 17:53:05
scottmg wrote:
cpu_(ooo_6.6-7.5)
2015/04/29 01:34:17
Acknowledged.
|
+ //! |
+ //! \return 'true' on success `false` on failure. |
scottmg
2015/04/24 04:55:06
`true` instead of 'true'
Mark Mentovai
2015/04/28 17:53:04
and a comma or an “and” in between the true and fa
cpu_(ooo_6.6-7.5)
2015/04/29 01:34:17
Acknowledged.
|
+ bool SetHandler(const std::string& ipc_port); |
scottmg
2015/04/24 04:55:06
Probably just make this #if WIN and remove from th
Mark Mentovai
2015/04/28 17:53:04
scottmg wrote:
cpu_(ooo_6.6-7.5)
2015/04/29 01:34:17
Acknowledged.
|
+ |
//! \brief Configures the process to direct its crashes to a Crashpad handler. |
//! |
- //! The Crashpad handler must previously have been started by StartHandler(). |
+ //! The Crashpad handler must previously have been started by StartHandler() |
+ //! or contacted by SetHandler(). |
Mark Mentovai
2015/04/28 17:53:05
SetHandler() may not need to contact the handler,
cpu_(ooo_6.6-7.5)
2015/04/29 01:34:17
Acknowledged.
|
//! |
//! On Mac OS X, this method sets the task’s exception port for `EXC_CRASH`, |
//! `EXC_RESOURCE`, and `EXC_GUARD` exceptions to the Mach send right obtained |
@@ -85,6 +104,10 @@ class CrashpadClient { |
//! have inherited it as their exception handler even after the process that |
//! called StartHandler() exits. |
//! |
+ //! On Windows, this method sets the unhandled exception handler to a local |
+ //! function that when reached it will "signal and wait" for the crash |
+ //! handler process to create the dump. |
+ //! |
//! \return `true` on success, `false` on failure with a message logged. |
bool UseHandler(); |