Skip to content

Document ESP.getMaxFreeBlockSize() != max malloc size #7328

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 2 commits into from
May 26, 2020
Merged

Document ESP.getMaxFreeBlockSize() != max malloc size #7328

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
765d70b
Document ESP.getMaxFreeBlockSize() != max malloc size
earlephilhower May 26, 2020
bfd747b
Merge branch 'master' into docmisc
earlephilhower May 26, 2020
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
2 changes: 1 addition & 1 deletion doc/libraries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Some ESP-specific APIs related to deep sleep, RTC and flash memories are availab

``ESP.getHeapFragmentation()`` returns the fragmentation metric (0% is clean, more than ~50% is not harmless)

``ESP.getMaxFreeBlockSize()`` returns the maximum allocatable ram block regarding heap fragmentation
``ESP.getMaxFreeBlockSize()`` returns the largest contiguous free RAM block in the heap, useful for checking heap fragmentation. **NOTE:** Maximum ``malloc()``able block will be smaller due to memory manager overheads.

``ESP.getChipId()`` returns the ESP8266 chip ID as a 32-bit integer.

Expand Down