Crashpad
 
Loading...
Searching...
No Matches
crashpad::MinidumpThreadNameWriter Class Referencefinal

The writer for a MINIDUMP_THREAD_NAME object in a minidump file. More...

#include "minidump/minidump_thread_name_list_writer.h"

Inheritance diagram for crashpad::MinidumpThreadNameWriter:
[legend]
Collaboration diagram for crashpad::MinidumpThreadNameWriter:
[legend]

Public Member Functions

 MinidumpThreadNameWriter (const MinidumpThreadNameWriter &)=delete
 
MinidumpThreadNameWriteroperator= (const MinidumpThreadNameWriter &)=delete
 
void InitializeFromSnapshot (const ThreadSnapshot *thread_snapshot, const MinidumpThreadIDMap &thread_id_map)
 Initializes the MINIDUMP_THREAD_NAME based on thread_snapshot.
 
void SetThreadId (uint32_t thread_id)
 Sets the ThreadId for MINIDUMP_THREAD_NAME::ThreadId.
 
uint32_t ThreadId () const
 Gets the ThreadId for MINIDUMP_THREAD_NAME::ThreadId.
 
void SetThreadName (const std::string &thread_name)
 Sets MINIDUMP_THREAD_NAME::RvaOfThreadName.
 
RVA64 RvaOfThreadName () const
 Returns an RVA64 which has been updated with the relative address of the thread name.
 
- Public Member Functions inherited from crashpad::internal::MinidumpWritable
 MinidumpWritable (const MinidumpWritable &)=delete
 
MinidumpWritableoperator= (const MinidumpWritable &)=delete
 
virtual bool WriteEverything (FileWriterInterface *file_writer)
 Writes an object and all of its children to a minidump file.
 
void RegisterRVA (RVA *rva)
 Registers a file offset pointer as one that should point to the object on which this method is called.
 
void RegisterRVA (RVA64 *rva)
 
void RegisterLocationDescriptor (MINIDUMP_LOCATION_DESCRIPTOR *location_descriptor)
 Registers a location descriptor as one that should point to the object on which this method is called.
 
void RegisterLocationDescriptor (MINIDUMP_LOCATION_DESCRIPTOR64 *location_descriptor64)
 

Additional Inherited Members

- Protected Types inherited from crashpad::internal::MinidumpWritable
enum  State
 Identifies the state of an object. More...
 
enum  Phase
 Identifies the phase during which an object will be written to a minidump file. More...
 
- Protected Member Functions inherited from crashpad::internal::MinidumpWritable
State state () const
 The state of the object.
 
virtual size_t Alignment ()
 Returns the object’s desired byte-boundary alignment.
 
virtual Phase WritePhase ()
 Returns the object’s desired write phase.
 
size_t WillWriteAtOffset (Phase phase, FileOffset *offset, std::vector< MinidumpWritable * > *write_sequence)
 Prepares the object to be written at a known file offset, transitioning it from kStateFrozen to kStateWritable.
 
virtual bool WillWriteAtOffsetImpl (FileOffset offset)
 Called once an object’s writable file offset is determined, as it transitions into kStateWritable.
 
bool WritePaddingAndObject (FileWriterInterface *file_writer)
 Writes the object, transitioning it from kStateWritable to kStateWritten.
 
- Static Protected Attributes inherited from crashpad::internal::MinidumpWritable
static constexpr size_t kInvalidSize = std::numeric_limits<size_t>::max()
 A size value used to signal failure by methods that return size_t.
 

Detailed Description

The writer for a MINIDUMP_THREAD_NAME object in a minidump file.

Because MINIDUMP_THREAD_NAME objects only appear as elements of MINIDUMP_THREAD_NAME_LIST objects, this class does not write any data on its own. It makes its MINIDUMP_THREAD_NAME data available to its MinidumpThreadNameListWriter parent, which writes it as part of a MINIDUMP_THREAD_NAME_LIST.

Member Function Documentation

◆ InitializeFromSnapshot()

void crashpad::MinidumpThreadNameWriter::InitializeFromSnapshot ( const ThreadSnapshot * thread_snapshot,
const MinidumpThreadIDMap & thread_id_map )

Initializes the MINIDUMP_THREAD_NAME based on thread_snapshot.

Parameters
[in]thread_snapshotThe thread snapshot to use as source data.
[in]thread_id_mapA MinidumpThreadIDMap to be consulted to determine the 32-bit minidump thread ID to use for thread_snapshot.
Note
Valid in kStateMutable.

◆ RvaOfThreadName()

RVA64 crashpad::MinidumpThreadNameWriter::RvaOfThreadName ( ) const

Returns an RVA64 which has been updated with the relative address of the thread name.

This method is expected to be called by a MinidumpThreadNameListWriter in order to obtain the RVA64 of the thread name.

Note
Valid in kStateWritable.

◆ ThreadId()

uint32_t crashpad::MinidumpThreadNameWriter::ThreadId ( ) const

Gets the ThreadId for MINIDUMP_THREAD_NAME::ThreadId.

Note
Valid in kStateWritable.

The documentation for this class was generated from the following files: