xref: /netbsd-src/external/mit/libcbor/dist/docs/doxygen/allocators_8c.html (revision 5dd36a3bc8bf2a9dec29ceb6349550414570c447)
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.12"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>libcbor: src/allocators.c File Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="search/search.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="search/searchdata.js"></script>
14<script type="text/javascript" src="search/search.js"></script>
15<link href="doxygen.css" rel="stylesheet" type="text/css" />
16<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
17</head>
18<body>
19<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20<div id="titlearea">
21<table cellspacing="0" cellpadding="0">
22 <tbody>
23 <tr style="height: 56px;">
24  <td id="projectalign" style="padding-left: 0.5em;">
25   <div id="projectname">libcbor
26   &#160;<span id="projectnumber">0.5.0</span>
27   </div>
28   <div id="projectbrief">libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.</div>
29  </td>
30 </tr>
31 </tbody>
32</table>
33</div>
34<!-- end header part -->
35<!-- Generated by Doxygen 1.8.12 -->
36<script type="text/javascript">
37var searchBox = new SearchBox("searchBox", "search",false,'Search');
38</script>
39<script type="text/javascript" src="menudata.js"></script>
40<script type="text/javascript" src="menu.js"></script>
41<script type="text/javascript">
42$(function() {
43  initMenu('',true,false,'search.php','Search');
44  $(document).ready(function() { init_search(); });
45});
46</script>
47<div id="main-nav"></div>
48<!-- window showing the filter options -->
49<div id="MSearchSelectWindow"
50     onmouseover="return searchBox.OnSearchSelectShow()"
51     onmouseout="return searchBox.OnSearchSelectHide()"
52     onkeydown="return searchBox.OnSearchSelectKey(event)">
53</div>
54
55<!-- iframe showing the search results (closed by default) -->
56<div id="MSearchResultsWindow">
57<iframe src="javascript:void(0)" frameborder="0"
58        name="MSearchResults" id="MSearchResults">
59</iframe>
60</div>
61
62<div id="nav-path" class="navpath">
63  <ul>
64<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
65</div>
66</div><!-- top -->
67<div class="header">
68  <div class="summary">
69<a href="#func-members">Functions</a> &#124;
70<a href="#var-members">Variables</a>  </div>
71  <div class="headertitle">
72<div class="title">allocators.c File Reference</div>  </div>
73</div><!--header-->
74<div class="contents">
75<div class="textblock"><code>#include &quot;<a class="el" href="common_8h_source.html">cbor/common.h</a>&quot;</code><br />
76</div>
77<p><a href="allocators_8c_source.html">Go to the source code of this file.</a></p>
78<table class="memberdecls">
79<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
80Functions</h2></td></tr>
81<tr class="memitem:a3f9f1d527374dbb4b48ef3fafa92e0bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocators_8c.html#a3f9f1d527374dbb4b48ef3fafa92e0bf">cbor_set_allocs</a> (<a class="el" href="common_8h.html#ad89d15c2e3f18e8914fcdffe4d725d42">_cbor_malloc_t</a> custom_malloc, <a class="el" href="common_8h.html#a5b52369a95930104d33301d12faabe75">_cbor_realloc_t</a> custom_realloc, <a class="el" href="common_8h.html#af05bb33f6d22cdac535576c8edaf208c">_cbor_free_t</a> custom_free)</td></tr>
82<tr class="memdesc:a3f9f1d527374dbb4b48ef3fafa92e0bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the memory management routines to use.  <a href="#a3f9f1d527374dbb4b48ef3fafa92e0bf">More...</a><br /></td></tr>
83<tr class="separator:a3f9f1d527374dbb4b48ef3fafa92e0bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
84</table><table class="memberdecls">
85<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
86Variables</h2></td></tr>
87<tr class="memitem:a3218c24af00a3efeaecb1716c8f5a289"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#ad89d15c2e3f18e8914fcdffe4d725d42">_cbor_malloc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocators_8c.html#a3218c24af00a3efeaecb1716c8f5a289">_cbor_malloc</a> = malloc</td></tr>
88<tr class="separator:a3218c24af00a3efeaecb1716c8f5a289"><td class="memSeparator" colspan="2">&#160;</td></tr>
89<tr class="memitem:a84ecc1fc92c3812ab6ced693f2c6254c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a5b52369a95930104d33301d12faabe75">_cbor_realloc_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocators_8c.html#a84ecc1fc92c3812ab6ced693f2c6254c">_cbor_realloc</a> = realloc</td></tr>
90<tr class="separator:a84ecc1fc92c3812ab6ced693f2c6254c"><td class="memSeparator" colspan="2">&#160;</td></tr>
91<tr class="memitem:a994f4145360ef0bfa3c48e59a5ca7186"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#af05bb33f6d22cdac535576c8edaf208c">_cbor_free_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="allocators_8c.html#a994f4145360ef0bfa3c48e59a5ca7186">_cbor_free</a> = free</td></tr>
92<tr class="separator:a994f4145360ef0bfa3c48e59a5ca7186"><td class="memSeparator" colspan="2">&#160;</td></tr>
93</table>
94<h2 class="groupheader">Function Documentation</h2>
95<a id="a3f9f1d527374dbb4b48ef3fafa92e0bf"></a>
96<h2 class="memtitle"><span class="permalink"><a href="#a3f9f1d527374dbb4b48ef3fafa92e0bf">&sect;&nbsp;</a></span>cbor_set_allocs()</h2>
97
98<div class="memitem">
99<div class="memproto">
100      <table class="memname">
101        <tr>
102          <td class="memname">void cbor_set_allocs </td>
103          <td>(</td>
104          <td class="paramtype"><a class="el" href="common_8h.html#ad89d15c2e3f18e8914fcdffe4d725d42">_cbor_malloc_t</a>&#160;</td>
105          <td class="paramname"><em>custom_malloc</em>, </td>
106        </tr>
107        <tr>
108          <td class="paramkey"></td>
109          <td></td>
110          <td class="paramtype"><a class="el" href="common_8h.html#a5b52369a95930104d33301d12faabe75">_cbor_realloc_t</a>&#160;</td>
111          <td class="paramname"><em>custom_realloc</em>, </td>
112        </tr>
113        <tr>
114          <td class="paramkey"></td>
115          <td></td>
116          <td class="paramtype"><a class="el" href="common_8h.html#af05bb33f6d22cdac535576c8edaf208c">_cbor_free_t</a>&#160;</td>
117          <td class="paramname"><em>custom_free</em>&#160;</td>
118        </tr>
119        <tr>
120          <td></td>
121          <td>)</td>
122          <td></td><td></td>
123        </tr>
124      </table>
125</div><div class="memdoc">
126
127<p>Sets the memory management routines to use. </p>
128<p>Only available when CBOR_CUSTOM_ALLOC is truthy</p>
129<pre class="fragment">embed:rst:leading-asterisk
130* .. warning:: This function modifies the global state and should therefore be used accordingly. Changing the memory handlers while allocated items exist will result in a ``free``/``malloc`` mismatch. This function is not thread safe with respect to both itself and all the other *libcbor* functions that work with the heap.
131* .. note:: `realloc` implementation must correctly support `NULL` reallocation
132* </pre><dl class="params"><dt>Parameters</dt><dd>
133  <table class="params">
134    <tr><td class="paramname">custom_malloc</td><td>malloc implementation </td></tr>
135    <tr><td class="paramname">custom_realloc</td><td>realloc implementation </td></tr>
136    <tr><td class="paramname">custom_free</td><td>free implementation </td></tr>
137  </table>
138  </dd>
139</dl>
140
141<p>Definition at line <a class="el" href="allocators_8c_source.html#l00014">14</a> of file <a class="el" href="allocators_8c_source.html">allocators.c</a>.</p>
142
143</div>
144</div>
145<h2 class="groupheader">Variable Documentation</h2>
146<a id="a994f4145360ef0bfa3c48e59a5ca7186"></a>
147<h2 class="memtitle"><span class="permalink"><a href="#a994f4145360ef0bfa3c48e59a5ca7186">&sect;&nbsp;</a></span>_cbor_free</h2>
148
149<div class="memitem">
150<div class="memproto">
151      <table class="memname">
152        <tr>
153          <td class="memname"><a class="el" href="common_8h.html#af05bb33f6d22cdac535576c8edaf208c">_cbor_free_t</a> _cbor_free = free</td>
154        </tr>
155      </table>
156</div><div class="memdoc">
157
158<p>Definition at line <a class="el" href="allocators_8c_source.html#l00012">12</a> of file <a class="el" href="allocators_8c_source.html">allocators.c</a>.</p>
159
160</div>
161</div>
162<a id="a3218c24af00a3efeaecb1716c8f5a289"></a>
163<h2 class="memtitle"><span class="permalink"><a href="#a3218c24af00a3efeaecb1716c8f5a289">&sect;&nbsp;</a></span>_cbor_malloc</h2>
164
165<div class="memitem">
166<div class="memproto">
167      <table class="memname">
168        <tr>
169          <td class="memname"><a class="el" href="common_8h.html#ad89d15c2e3f18e8914fcdffe4d725d42">_cbor_malloc_t</a> _cbor_malloc = malloc</td>
170        </tr>
171      </table>
172</div><div class="memdoc">
173
174<p>Definition at line <a class="el" href="allocators_8c_source.html#l00010">10</a> of file <a class="el" href="allocators_8c_source.html">allocators.c</a>.</p>
175
176</div>
177</div>
178<a id="a84ecc1fc92c3812ab6ced693f2c6254c"></a>
179<h2 class="memtitle"><span class="permalink"><a href="#a84ecc1fc92c3812ab6ced693f2c6254c">&sect;&nbsp;</a></span>_cbor_realloc</h2>
180
181<div class="memitem">
182<div class="memproto">
183      <table class="memname">
184        <tr>
185          <td class="memname"><a class="el" href="common_8h.html#a5b52369a95930104d33301d12faabe75">_cbor_realloc_t</a> _cbor_realloc = realloc</td>
186        </tr>
187      </table>
188</div><div class="memdoc">
189
190<p>Definition at line <a class="el" href="allocators_8c_source.html#l00011">11</a> of file <a class="el" href="allocators_8c_source.html">allocators.c</a>.</p>
191
192</div>
193</div>
194</div><!-- contents -->
195<!-- start footer part -->
196<hr class="footer"/><address class="footer"><small>
197Generated on Mon Feb 6 2017 00:26:19 for libcbor by &#160;<a href="http://www.doxygen.org/index.html">
198<img class="footer" src="doxygen.png" alt="doxygen"/>
199</a> 1.8.12
200</small></address>
201</body>
202</html>
203