You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/modules/malloc_test/doc/functions.xml

57 lines
1.4 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="malloc_test.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
<revhistory>
<revision>
<revnumber>$Revision$</revnumber>
<date>$Date$</date>
</revision>
</revhistory>
</sectioninfo>
<title>Functions</title>
<section id="malloc_test.mt_mem_alloc">
<title><function>mt_mem_alloc(size)</function></title>
<para>
Allocates size bytes.
</para>
<note><para>This is a debugging function for simulating memory
leaks or stressing the memory allocator. It should not
be used in production setups
</para></note>
<example>
<title><function>men_alloc</function> usage</title>
<programlisting>
...
mem_alloc(1048576); # 1MB
...
</programlisting>
</example>
</section>
<section id="malloc_test.mt_mem_free">
<title><function>mt_mem_free()</function></title>
<para>
Frees all the memory allocated with mem_alloc() up to this
point.
</para>
<note><para>This is a debugging function for simulating memory
leaks or stressing the memory allocator. It should not
be used in production setups
</para></note>
<example>
<title><function>mem_free</function> usage</title>
<programlisting>
...
mem_free();
...
</programlisting>
</example>
</section>
</section>