diff --git a/doc/generated/doxygen/annotated.html b/doc/generated/doxygen/annotated.html index 3e987072..26603caf 100644 --- a/doc/generated/doxygen/annotated.html +++ b/doc/generated/doxygen/annotated.html @@ -315,26 +315,27 @@ $(function() {  CMappedMemoryA memory region mapped from another Mach task  CThreadBasic thread abstraction. Users should derive from this class and implement ThreadMain()  CThreadLogMessagesCaptures log messages produced on the current thread during an object’s lifetime - CThreadSnapshotAn abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot process - CToolSupportCommon functions used by command line tools - CTSimpleAddressRangeBagA bag implementation using a fixed amount of storage, so that it does not perform any dynamic allocations for its operations - CEntryA single entry in the bag - CIteratorAn iterator to traverse all of the active entries in a TSimpleAddressRangeBag - CTSimpleStringDictionaryA map/dictionary collection implementation using a fixed amount of storage, so that it does not perform any dynamic allocations for its operations - CEntryA single entry in the map - CIteratorAn iterator to traverse all of the active entries in a TSimpleStringDictionary - Cuint128_structStores a 128-bit quantity - CUniversalMachExcServerA server interface for the exc and mach_exc Mach subsystems, unified to handle exceptions delivered to either subsystem, and simplified to have only a single interface method needing implementation - CInterfaceAn interface that the different request messages that are a part of the exc and mach_exc Mach subsystems can be dispatched to - CUnloadedModuleSnapshotInformation about an unloaded module that was previously loaded into a snapshot process - CUserMinidumpStreamInformation describing a custom user data stream in a minidump - CUserStreamDataSourceExtensibility interface for embedders who wish to add custom streams to minidumps - CUUIDA universally unique identifier (UUID) - CWeakFileHandleFileReaderA file reader backed by a FileHandle - CWeakFileHandleFileWriterA file writer backed by a FileHandle - CWorkerThreadA WorkerThread executes its Delegate's DoWork method repeatedly on a dedicated thread at a set time interval - CDelegateAn interface for doing work on a WorkerThread - CWritableIoVecA version of iovec with a const iov_base field + CThreadSafeVectorA wrapper for a std::vector<> that can be accessed safely from multiple threads + CThreadSnapshotAn abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot process + CToolSupportCommon functions used by command line tools + CTSimpleAddressRangeBagA bag implementation using a fixed amount of storage, so that it does not perform any dynamic allocations for its operations + CEntryA single entry in the bag + CIteratorAn iterator to traverse all of the active entries in a TSimpleAddressRangeBag + CTSimpleStringDictionaryA map/dictionary collection implementation using a fixed amount of storage, so that it does not perform any dynamic allocations for its operations + CEntryA single entry in the map + CIteratorAn iterator to traverse all of the active entries in a TSimpleStringDictionary + Cuint128_structStores a 128-bit quantity + CUniversalMachExcServerA server interface for the exc and mach_exc Mach subsystems, unified to handle exceptions delivered to either subsystem, and simplified to have only a single interface method needing implementation + CInterfaceAn interface that the different request messages that are a part of the exc and mach_exc Mach subsystems can be dispatched to + CUnloadedModuleSnapshotInformation about an unloaded module that was previously loaded into a snapshot process + CUserMinidumpStreamInformation describing a custom user data stream in a minidump + CUserStreamDataSourceExtensibility interface for embedders who wish to add custom streams to minidumps + CUUIDA universally unique identifier (UUID) + CWeakFileHandleFileReaderA file reader backed by a FileHandle + CWeakFileHandleFileWriterA file writer backed by a FileHandle + CWorkerThreadA WorkerThread executes its Delegate's DoWork method repeatedly on a dedicated thread at a set time interval + CDelegateAn interface for doing work on a WorkerThread + CWritableIoVecA version of iovec with a const iov_base field  Nlogging  CNtstatusLogMessage  CCPU_INFORMATIONInformation about the CPU (or CPUs) that ran the process that the minidump file contains a snapshot of diff --git a/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread-members.html b/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread-members.html index be0292d1..bc5ebcd3 100644 --- a/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread-members.html +++ b/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread-members.html @@ -70,8 +70,8 @@ $(function() {

This is the complete list of members for crashpad::CrashReportUploadThread, including all inherited members.

- - + + diff --git a/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread.html b/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread.html index 5f85dd72..d686f2d1 100644 --- a/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread.html +++ b/doc/generated/doxygen/classcrashpad_1_1CrashReportUploadThread.html @@ -87,26 +87,26 @@ Inheritance diagram for crashpad::CrashReportUploadThread:
CrashReportUploadThread(CrashReportDatabase *database, const std::string &url, bool rate_limit, bool upload_gzip)crashpad::CrashReportUploadThread
ReportPending()crashpad::CrashReportUploadThread
CrashReportUploadThread(CrashReportDatabase *database, const std::string &url, bool watch_pending_reports, bool rate_limit, bool upload_gzip)crashpad::CrashReportUploadThread
ReportPending(const UUID &report_uuid)crashpad::CrashReportUploadThread
Start()crashpad::CrashReportUploadThread
Stop()crashpad::CrashReportUploadThread
~CrashReportUploadThread() (defined in crashpad::CrashReportUploadThread)crashpad::CrashReportUploadThread
- - - + + + - - - + + +

Public Member Functions

 CrashReportUploadThread (CrashReportDatabase *database, const std::string &url, bool rate_limit, bool upload_gzip)
 Constructs a new object. More...
 
 CrashReportUploadThread (CrashReportDatabase *database, const std::string &url, bool watch_pending_reports, bool rate_limit, bool upload_gzip)
 Constructs a new object. More...
 
void Start ()
 Starts a dedicated upload thread, which executes ThreadMain(). More...
 
void Stop ()
 Stops the upload thread. More...
 
void ReportPending ()
 Informs the upload thread that a new pending report has been added to the database. More...
 
void ReportPending (const UUID &report_uuid)
 Informs the upload thread that a new pending report has been added to the database. More...
 

Detailed Description

A thread that processes pending crash reports in a CrashReportDatabase by uploading them or marking them as completed without upload, as desired.

-

A producer of crash reports should notify an object of this class that a new report has been added to the database by calling ReportPending().

-

Independently of being triggered by ReportPending(), objects of this class periodically examine the database for pending reports. This allows failed upload attempts for reports left in the pending state to be retried. It also catches reports that are added without a ReportPending() signal being caught. This may happen if crash reports are added to the database by other processes.

+

A producer of crash reports should notify an object of this class that a new report has been added to the database by calling ReportPending().

+

Independently of being triggered by ReportPending(), objects of this class can periodically examine the database for pending reports. This allows failed upload attempts for reports left in the pending state to be retried. It also catches reports that are added without a ReportPending() signal being caught. This may happen if crash reports are added to the database by other processes.

Constructor & Destructor Documentation

- -

◆ CrashReportUploadThread()

+ +

◆ CrashReportUploadThread()

@@ -123,6 +123,12 @@ Public Member Functions const std::string &  url, + + + + bool  + watch_pending_reports, + @@ -148,6 +154,7 @@ Public Member Functions +
[in]databaseThe database to upload crash reports from.
[in]urlThe URL of the server to upload crash reports to.
[in]watch_pending_reportsWhether to periodically check for new pending reports not already known to exist. When false, only an initial upload attempt will be made for reports known to exist by having been added by the ReportPending() method. No scans for new pending reports will be conducted.
[in]rate_limitWhether uploads should be throttled to a (currently hardcoded) rate.
[in]upload_gzipWhether uploads should use gzip compression.
@@ -157,8 +164,8 @@ Public Member Functions

Member Function Documentation

- -

◆ ReportPending()

+ +

◆ ReportPending()

@@ -166,13 +173,20 @@ Public Member Functions void crashpad::CrashReportUploadThread::ReportPending ( - ) + const UUID &  + report_uuid)

Informs the upload thread that a new pending report has been added to the database.

+
Parameters
+ + +
[in]report_uuidThe unique identifier of the newly added pending report.
+
+

This method may be called from any thread.

diff --git a/doc/generated/doxygen/classcrashpad_1_1MachMessageServer.html b/doc/generated/doxygen/classcrashpad_1_1MachMessageServer.html index 28903ecc..94e08e1d 100644 --- a/doc/generated/doxygen/classcrashpad_1_1MachMessageServer.html +++ b/doc/generated/doxygen/classcrashpad_1_1MachMessageServer.html @@ -226,7 +226,7 @@ Static Public Member Functions -
Returns
On success, MACH_MSG_SUCCESS (when persistent is kOneShot) or MACH_RCV_TIMED_OUT (when persistent is kOneShot and timeout_ms is not kMachMessageTimeoutWaitIndefinitely). This function has no successful return value when persistent is kPersistent and timeout_ms is kMachMessageTimeoutWaitIndefinitely. On failure, returns a value identifying the nature of the error.
+
Returns
On success, MACH_MSG_SUCCESS (when persistent is kOneShot) or MACH_RCV_TIMED_OUT (when persistent is kOneShot and timeout_ms is not kMachMessageTimeoutWaitIndefinitely). This function has no successful return value when persistent is kPersistent and timeout_ms is kMachMessageTimeoutWaitIndefinitely. On failure, returns a value identifying the nature of the error. A request received with a reply port that is (or becomes) a dead name before the reply is sent will result in MACH_SEND_INVALID_DEST as a return value, which may or may not be considered an error from the caller’s perspective.
diff --git a/doc/generated/doxygen/classcrashpad_1_1Semaphore-members.html b/doc/generated/doxygen/classcrashpad_1_1Semaphore-members.html index 0c622ef1..2981cd09 100644 --- a/doc/generated/doxygen/classcrashpad_1_1Semaphore-members.html +++ b/doc/generated/doxygen/classcrashpad_1_1Semaphore-members.html @@ -70,11 +70,12 @@ $(function() {

This is the complete list of members for crashpad::Semaphore, including all inherited members.

- - - - - + + + + + +
Semaphore(int value)crashpad::Semaphoreexplicit
Signal()crashpad::Semaphore
TimedWait(double seconds)crashpad::Semaphore
Wait()crashpad::Semaphore
~Semaphore() (defined in crashpad::Semaphore)crashpad::Semaphore
kIndefiniteWaitcrashpad::Semaphorestatic
Semaphore(int value)crashpad::Semaphoreexplicit
Signal()crashpad::Semaphore
TimedWait(double seconds)crashpad::Semaphore
Wait()crashpad::Semaphore
~Semaphore() (defined in crashpad::Semaphore)crashpad::Semaphore