Skip to content

Add ProfilingBlockDevice API doc #320

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

Merged
merged 5 commits into from
Oct 31, 2017
Merged

Add ProfilingBlockDevice API doc #320

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c77d75
Add ProfilingBlockDevice API doc
kegilbert Oct 30, 2017
d1ab606
Copy edit ProfilingBlockDevice.md
Oct 30, 2017
5fc105f
Clean up phrasing
kegilbert Oct 30, 2017
ffc9e49
Copy edit additional changes
Oct 30, 2017
2e240b9
Rephrase opening line with decorator term
kegilbert Oct 31, 2017
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
13 changes: 13 additions & 0 deletions docs/reference/api/storage/ProfilingBlockDevice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
## ProfilingBlockDevice

The ProfilingBlockDevice class provides a decorator for an existing block device object to log reads, writes and erases.

ProfilingBlockDevices take in a pointer to the block device being profiled as the only configurable parameter. If you want to count a storage operation such as programming, reading or writing to a block device, you should use the ProfilingBlockDevice object as the interface to the storage block rather than the underlying device. The below example highlights this use case.

### ProfilingBlockDevice class reference

[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/class_profiling_block_device.html)

### ProfilingBlockDevice example

Create a ProfilingBlockDevice, perform storage operations and report back the read, write and erase counts.

[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/ProfilingBlockDevice_ex_1/)](https://os.mbed.com/compiler/#nav:/ProfilingBlockDevice_ex_1/main.cpp;)