The srecord::memory_walker class is used to represent an abstract handler for the action to perform when walking a memory image. More...
#include <walker.h>
Public Types | |
| typedef std::shared_ptr< memory_walker > | pointer |
Public Member Functions | |
| virtual | ~memory_walker () |
| The destructor. More... | |
| virtual void | observe (unsigned long address, const void *data, int data_size)=0 |
| The observe method is used by the memory walker to provide data. More... | |
| virtual void | observe_end (void) |
| The observe_end method is called once all of the data blocks have been passed to the observer via the observe() method. More... | |
| virtual void | notify_upper_bound (unsigned long address) |
| The notify_upper_bound method is used to notify the walker of the upper bound (highest address plus one) of the observe calls to come. More... | |
| virtual void | observe_header (const record *rec=0) |
| The observe_header method is used to inform the walker of the header record. More... | |
| virtual void | observe_start_address (const record *rec=0) |
| The observe_start_address method is used to inform the walker of the execution start address record. More... | |
Protected Member Functions | |
| memory_walker () | |
| The default constructor. More... | |
Detailed Description
The srecord::memory_walker class is used to represent an abstract handler for the action to perform when walking a memory image.
Member Typedef Documentation
◆ pointer
| typedef std::shared_ptr<memory_walker> srecord::memory_walker::pointer |
Constructor & Destructor Documentation
◆ ~memory_walker()
|
virtual |
The destructor.
◆ memory_walker()
|
protected |
The default constructor.
May only be called by derived classes.
Member Function Documentation
◆ observe()
|
pure virtual |
The observe method is used by the memory walker to provide data.
Derived classes are required to impliment this method, and do something with the data.
- Parameters
-
address The base address of this chunk of memory. data The base address of this chunk of memory in memory. data_size The size, in bytes, of this chunk of memory.
Implemented in srecord::memory_walker_writer, srecord::memory_walker_stm32, srecord::memory_walker_gcrypt, srecord::memory_walker_fletcher32, srecord::memory_walker_crc32, srecord::memory_walker_crc16, srecord::memory_walker_continuity, srecord::memory_walker_compare, srecord::memory_walker_alignment, srecord::memory_walker_adler32, srecord::memory_walker_adler16, and srecord::memory_walker_fletcher16.
◆ observe_end()
|
virtual |
The observe_end method is called once all of the data blocks have been passed to the observer via the observe() method.
Reimplemented in srecord::memory_walker_alignment.
◆ notify_upper_bound()
|
virtual |
The notify_upper_bound method is used to notify the walker of the upper bound (highest address plus one) of the observe calls to come.
Shall be called before the any observe calls are made. By default, nothing happens.
- Parameters
-
address The address of the byte immediately beyond the used memory.
◆ observe_header()
|
virtual |
The observe_header method is used to inform the walker of the header record.
The default does nothing.
- Parameters
-
rec The record to be processed.
Reimplemented in srecord::memory_walker_writer.
◆ observe_start_address()
|
virtual |
The observe_start_address method is used to inform the walker of the execution start address record.
The default does nothing.
- Parameters
-
rec The record to be processed.
Reimplemented in srecord::memory_walker_writer.
The documentation for this class was generated from the following file:
- memory/walker.h
