Files
kumomta/docs/reference/kumo/set_memory_hard_limit.md
T
Wez Furlong 42bf5c5e61 docs: adjust reference to improve search terms
We've been hoping that mkdocs-material will ship the much anticipated
search enhancements for some time, but it's time to recognize that
we need to do something to improve the search results with how
things work right now.

This is a big commit that changes the titles of the various pages
from the code-annotated synopsis to just the name of the function.

This makes it much easier now to match things like `kumo.reject`
directly, but `reject` remains awkward to find.

I think this is the best that we can do at this time.

A few functions have been annotated with the `status: deprecated` to
show as deprecated in the toc/nav (shows with a little trash can next
to the name).
2025-05-16 14:02:19 -07:00

595 B

tags
tags
memory

kumo.set_memory_hard_limit

kumo.set_memory_hard_limit(LIMIT)

{{since('2025.03.19-1d3f1f67')}}

Set the hard limit for memory utilization. This defaults to the amount of physical RAM in the system.

You typically do not need to modify this value.

See Memory Management for a discussion on how kumomta manages memory usage.

It is recommend to set this during the pre_init event.

The LIMIT is expressed as an integer number of bytes.

kumo.on('pre_init', function()
  kumo.set_memory_hard_limit(2 * 1024 * 1024 * 1024)
end)