%PDF-
%PDF-
Mini Shell
Mini Shell
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Nagios: kvvec.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nagios
 <span id="projectnumber">4.4.3</span>
</div>
<div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> </div>
<div class="headertitle">
<div class="title">kvvec.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Key/value vector library function and type declarations.
<a href="#details">More...</a></p>
<p><a href="kvvec_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkey__value.html">key_value</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">key/value pair One of the two major components of the kvvec api <a href="structkey__value.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkvvec__buf.html">kvvec_buf</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">key/value vector buffer. <a href="structkvvec__buf.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structkvvec.html">kvvec</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">key/value vector struct This is the main component of the kvvec library <a href="structkvvec.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25379acdbaec90e5f9726ebd333494fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25379acdbaec90e5f9726ebd333494fb"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a25379acdbaec90e5f9726ebd333494fb">KVVEC_INITIALIZER</a>   { NULL, 0, 0, 0 }</td></tr>
<tr class="memdesc:a25379acdbaec90e5f9726ebd333494fb"><td class="mdescLeft"> </td><td class="mdescRight">Portable initializer for stack-allocated key/value vectors. <br/></td></tr>
<tr class="separator:a25379acdbaec90e5f9726ebd333494fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d96e7939ce3b76fee38e9393d19165c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a4d96e7939ce3b76fee38e9393d19165c">KVVEC_FREE_KEYS</a>   1</td></tr>
<tr class="memdesc:a4d96e7939ce3b76fee38e9393d19165c"><td class="mdescLeft"> </td><td class="mdescRight">Parameters for <a class="el" href="kvvec_8h.html#ae48257e5e7ca526bb1c446d9df330a30" title="Destroy a key/value vector. ">kvvec_destroy()</a> <a href="#a4d96e7939ce3b76fee38e9393d19165c">More...</a><br/></td></tr>
<tr class="separator:a4d96e7939ce3b76fee38e9393d19165c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b812d4efcf47932fd0a9189a02a78ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b812d4efcf47932fd0a9189a02a78ee"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a7b812d4efcf47932fd0a9189a02a78ee">KVVEC_FREE_VALUES</a>   2</td></tr>
<tr class="memdesc:a7b812d4efcf47932fd0a9189a02a78ee"><td class="mdescLeft"> </td><td class="mdescRight">Free values when destroying a kv vector. <br/></td></tr>
<tr class="separator:a7b812d4efcf47932fd0a9189a02a78ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7095cb5eb6f3ac60f6a29f438ff75eb5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7095cb5eb6f3ac60f6a29f438ff75eb5"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a7095cb5eb6f3ac60f6a29f438ff75eb5">KVVEC_FREE_ALL</a>   (<a class="el" href="kvvec_8h.html#a4d96e7939ce3b76fee38e9393d19165c">KVVEC_FREE_KEYS</a> | <a class="el" href="kvvec_8h.html#a7b812d4efcf47932fd0a9189a02a78ee">KVVEC_FREE_VALUES</a>)</td></tr>
<tr class="memdesc:a7095cb5eb6f3ac60f6a29f438ff75eb5"><td class="mdescLeft"> </td><td class="mdescRight">Free both keys and values when destroying a kv vector. <br/></td></tr>
<tr class="separator:a7095cb5eb6f3ac60f6a29f438ff75eb5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70cbfa0b81235b421f035e2a9b7edf6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70cbfa0b81235b421f035e2a9b7edf6b"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a70cbfa0b81235b421f035e2a9b7edf6b">KVVEC_ASSIGN</a>   0</td></tr>
<tr class="memdesc:a70cbfa0b81235b421f035e2a9b7edf6b"><td class="mdescLeft"> </td><td class="mdescRight">Assign from buf in <a class="el" href="kvvec_8h.html#ae7fcee9d034301690a9e9c1b1fb647b7" title="Parse a buffer into the pre-allocated key/value vector. ">buf2kvvec_prealloc()</a> <br/></td></tr>
<tr class="separator:a70cbfa0b81235b421f035e2a9b7edf6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8536f44789ef8ae5aeb5b2473ed0c917"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8536f44789ef8ae5aeb5b2473ed0c917"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a8536f44789ef8ae5aeb5b2473ed0c917">KVVEC_COPY</a>   1</td></tr>
<tr class="memdesc:a8536f44789ef8ae5aeb5b2473ed0c917"><td class="mdescLeft"> </td><td class="mdescRight">Copy from buf in <a class="el" href="kvvec_8h.html#ae7fcee9d034301690a9e9c1b1fb647b7" title="Parse a buffer into the pre-allocated key/value vector. ">buf2kvvec_prealloc()</a> <br/></td></tr>
<tr class="separator:a8536f44789ef8ae5aeb5b2473ed0c917"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0961be74279b58da41015207766460f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0961be74279b58da41015207766460f"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#aa0961be74279b58da41015207766460f">KVVEC_APPEND</a>   2</td></tr>
<tr class="memdesc:aa0961be74279b58da41015207766460f"><td class="mdescLeft"> </td><td class="mdescRight">Don't reset kvvec in <a class="el" href="kvvec_8h.html#ae7fcee9d034301690a9e9c1b1fb647b7" title="Parse a buffer into the pre-allocated key/value vector. ">buf2kvvec_prealloc()</a> <br/></td></tr>
<tr class="separator:aa0961be74279b58da41015207766460f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2994fc044c72fdfcc863021ebdbb93e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a2994fc044c72fdfcc863021ebdbb93e4">kvvec_addkv</a>(kvv, key, value)   <a class="el" href="kvvec_8h.html#a4bb7a8e7ae51a50712257b417cab1b73">kvvec_addkv_wlen</a>(kvv, key, 0, value, 0)</td></tr>
<tr class="memdesc:a2994fc044c72fdfcc863021ebdbb93e4"><td class="mdescLeft"> </td><td class="mdescRight">Shortcut to <a class="el" href="kvvec_8h.html#a4bb7a8e7ae51a50712257b417cab1b73" title="Add a key/value pair to an existing key/value vector, with lengths of strings already calculated...">kvvec_addkv_wlen()</a> when lengths aren't known. <a href="#a2994fc044c72fdfcc863021ebdbb93e4">More...</a><br/></td></tr>
<tr class="separator:a2994fc044c72fdfcc863021ebdbb93e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a57f190e865c2cbc061f610c8e3f2be"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structkvvec.html">kvvec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a4a57f190e865c2cbc061f610c8e3f2be">kvvec_init</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, int hint)</td></tr>
<tr class="memdesc:a4a57f190e865c2cbc061f610c8e3f2be"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a previously allocated key/value vector. <a href="#a4a57f190e865c2cbc061f610c8e3f2be">More...</a><br/></td></tr>
<tr class="separator:a4a57f190e865c2cbc061f610c8e3f2be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a323a230712dcc699552f4c9f4066cc7b"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structkvvec.html">kvvec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a323a230712dcc699552f4c9f4066cc7b">kvvec_create</a> (int hint)</td></tr>
<tr class="memdesc:a323a230712dcc699552f4c9f4066cc7b"><td class="mdescLeft"> </td><td class="mdescRight">Create a key/value vector. <a href="#a323a230712dcc699552f4c9f4066cc7b">More...</a><br/></td></tr>
<tr class="separator:a323a230712dcc699552f4c9f4066cc7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac34da75473e20794d20d8e783e258c97"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#ac34da75473e20794d20d8e783e258c97">kvvec_resize</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, int size)</td></tr>
<tr class="memdesc:ac34da75473e20794d20d8e783e258c97"><td class="mdescLeft"> </td><td class="mdescRight">Resize a key/value vector Used by <a class="el" href="kvvec_8h.html#ae371eaec3a3ef11ccc4880909470e410" title="Grow a key/value vector. ">kvvec_grow()</a>. <a href="#ac34da75473e20794d20d8e783e258c97">More...</a><br/></td></tr>
<tr class="separator:ac34da75473e20794d20d8e783e258c97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae371eaec3a3ef11ccc4880909470e410"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#ae371eaec3a3ef11ccc4880909470e410">kvvec_grow</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, int hint)</td></tr>
<tr class="memdesc:ae371eaec3a3ef11ccc4880909470e410"><td class="mdescLeft"> </td><td class="mdescRight">Grow a key/value vector. <a href="#ae371eaec3a3ef11ccc4880909470e410">More...</a><br/></td></tr>
<tr class="separator:ae371eaec3a3ef11ccc4880909470e410"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a371ef5a04f6580d9d7b71697e1c993fa"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a371ef5a04f6580d9d7b71697e1c993fa">kvvec_capacity</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv)</td></tr>
<tr class="memdesc:a371ef5a04f6580d9d7b71697e1c993fa"><td class="mdescLeft"> </td><td class="mdescRight">Return remaining storage capacity of key/value vector. <a href="#a371ef5a04f6580d9d7b71697e1c993fa">More...</a><br/></td></tr>
<tr class="separator:a371ef5a04f6580d9d7b71697e1c993fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af18974709de148f303770b2778f48804"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#af18974709de148f303770b2778f48804">kvvec_sort</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv)</td></tr>
<tr class="memdesc:af18974709de148f303770b2778f48804"><td class="mdescLeft"> </td><td class="mdescRight">Sort a key/value vector alphabetically by key name. <a href="#af18974709de148f303770b2778f48804">More...</a><br/></td></tr>
<tr class="separator:af18974709de148f303770b2778f48804"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bb7a8e7ae51a50712257b417cab1b73"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a4bb7a8e7ae51a50712257b417cab1b73">kvvec_addkv_wlen</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, const char *key, int keylen, const char *value, int valuelen)</td></tr>
<tr class="memdesc:a4bb7a8e7ae51a50712257b417cab1b73"><td class="mdescLeft"> </td><td class="mdescRight">Add a key/value pair to an existing key/value vector, with lengths of strings already calculated. <a href="#a4bb7a8e7ae51a50712257b417cab1b73">More...</a><br/></td></tr>
<tr class="separator:a4bb7a8e7ae51a50712257b417cab1b73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaacdeaf527f8891425235a2b77e6055c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#aaacdeaf527f8891425235a2b77e6055c">kvvec_foreach</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, void *arg, int(*callback)(struct <a class="el" href="structkey__value.html">key_value</a> *, void *))</td></tr>
<tr class="memdesc:aaacdeaf527f8891425235a2b77e6055c"><td class="mdescLeft"> </td><td class="mdescRight">Walk each key/value pair in a key/value vector, sending them as arguments to a callback function. <a href="#aaacdeaf527f8891425235a2b77e6055c">More...</a><br/></td></tr>
<tr class="separator:aaacdeaf527f8891425235a2b77e6055c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae48257e5e7ca526bb1c446d9df330a30"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#ae48257e5e7ca526bb1c446d9df330a30">kvvec_destroy</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, int flags)</td></tr>
<tr class="memdesc:ae48257e5e7ca526bb1c446d9df330a30"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a key/value vector. <a href="#ae48257e5e7ca526bb1c446d9df330a30">More...</a><br/></td></tr>
<tr class="separator:ae48257e5e7ca526bb1c446d9df330a30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a334e2ad55304e6775ad22e219361aad2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a334e2ad55304e6775ad22e219361aad2">kvvec_free_kvpairs</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, int flags)</td></tr>
<tr class="memdesc:a334e2ad55304e6775ad22e219361aad2"><td class="mdescLeft"> </td><td class="mdescRight">Free key/value pairs associated with a key/value vector. <a href="#a334e2ad55304e6775ad22e219361aad2">More...</a><br/></td></tr>
<tr class="separator:a334e2ad55304e6775ad22e219361aad2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0908a0556bf1b0a2e7b20cffeb2dc539"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structkvvec__buf.html">kvvec_buf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#a0908a0556bf1b0a2e7b20cffeb2dc539">kvvec2buf</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, char kv_sep, char pair_sep, int overalloc)</td></tr>
<tr class="memdesc:a0908a0556bf1b0a2e7b20cffeb2dc539"><td class="mdescLeft"> </td><td class="mdescRight">Create a linear buffer of all the key/value pairs and return it as a <a class="el" href="structkvvec__buf.html" title="key/value vector buffer. ">kvvec_buf</a>. <a href="#a0908a0556bf1b0a2e7b20cffeb2dc539">More...</a><br/></td></tr>
<tr class="separator:a0908a0556bf1b0a2e7b20cffeb2dc539"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0ab56fb4e52a550dad9ea84c71d06c6"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structkvvec.html">kvvec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#af0ab56fb4e52a550dad9ea84c71d06c6">buf2kvvec</a> (char *str, unsigned int len, const char kvsep, const char pair_sep, int flags)</td></tr>
<tr class="memdesc:af0ab56fb4e52a550dad9ea84c71d06c6"><td class="mdescLeft"> </td><td class="mdescRight">Create a key/value vector from a pre-parsed buffer. <a href="#af0ab56fb4e52a550dad9ea84c71d06c6">More...</a><br/></td></tr>
<tr class="separator:af0ab56fb4e52a550dad9ea84c71d06c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7fcee9d034301690a9e9c1b1fb647b7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="kvvec_8h.html#ae7fcee9d034301690a9e9c1b1fb647b7">buf2kvvec_prealloc</a> (struct <a class="el" href="structkvvec.html">kvvec</a> *kvv, char *str, unsigned int len, const char kvsep, const char pair_sep, int flags)</td></tr>
<tr class="memdesc:ae7fcee9d034301690a9e9c1b1fb647b7"><td class="mdescLeft"> </td><td class="mdescRight">Parse a buffer into the pre-allocated key/value vector. <a href="#ae7fcee9d034301690a9e9c1b1fb647b7">More...</a><br/></td></tr>
<tr class="separator:ae7fcee9d034301690a9e9c1b1fb647b7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Key/value vector library function and type declarations. </p>
<p>The kvvec library is nifty as either a configuration meta-format or for IPC purposes. Take a look at the <a class="el" href="kvvec_8h.html#af0ab56fb4e52a550dad9ea84c71d06c6" title="Create a key/value vector from a pre-parsed buffer. ">buf2kvvec()</a> and <a class="el" href="kvvec_8h.html#a0908a0556bf1b0a2e7b20cffeb2dc539" title="Create a linear buffer of all the key/value pairs and return it as a kvvec_buf. ">kvvec2buf()</a> pair of functions for the latter. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a2994fc044c72fdfcc863021ebdbb93e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define kvvec_addkv</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">kvv, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">key, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">value </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="kvvec_8h.html#a4bb7a8e7ae51a50712257b417cab1b73">kvvec_addkv_wlen</a>(kvv, key, 0, value, 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shortcut to <a class="el" href="kvvec_8h.html#a4bb7a8e7ae51a50712257b417cab1b73" title="Add a key/value pair to an existing key/value vector, with lengths of strings already calculated...">kvvec_addkv_wlen()</a> when lengths aren't known. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to add this key/value pair to </td></tr>
<tr><td class="paramname">key</td><td>The key </td></tr>
<tr><td class="paramname">value</td><td>The value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a4d96e7939ce3b76fee38e9393d19165c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define KVVEC_FREE_KEYS   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters for <a class="el" href="kvvec_8h.html#ae48257e5e7ca526bb1c446d9df330a30" title="Destroy a key/value vector. ">kvvec_destroy()</a> </p>
<p>Free keys when destroying a kv vector </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="af0ab56fb4e52a550dad9ea84c71d06c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structkvvec.html">kvvec</a>* buf2kvvec </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>kvsep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>pair_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a key/value vector from a pre-parsed buffer. </p>
<p>Immensely useful for ipc in combination with <a class="el" href="kvvec_8h.html#a0908a0556bf1b0a2e7b20cffeb2dc539" title="Create a linear buffer of all the key/value pairs and return it as a kvvec_buf. ">kvvec2buf()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>The buffer to convert to a key/value vector </td></tr>
<tr><td class="paramname">len</td><td>Length of buffer to convert </td></tr>
<tr><td class="paramname">kvsep</td><td>Character separating key and value </td></tr>
<tr><td class="paramname">pair_sep</td><td>Character separating key/value pairs </td></tr>
<tr><td class="paramname">flags</td><td>bitmask. See KVVEC_{ASSIGN,COPY,APPEND} for values </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The created key/value vector </dd></dl>
</div>
</div>
<a class="anchor" id="ae7fcee9d034301690a9e9c1b1fb647b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int buf2kvvec_prealloc </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>kvsep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"><em>pair_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse a buffer into the pre-allocated key/value vector. </p>
<p>Immensely useful for ipc in combination with <a class="el" href="kvvec_8h.html#a0908a0556bf1b0a2e7b20cffeb2dc539" title="Create a linear buffer of all the key/value pairs and return it as a kvvec_buf. ">kvvec2buf()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>A pre-allocated key/value vector to populate </td></tr>
<tr><td class="paramname">str</td><td>The buffer to convert to a key/value vector </td></tr>
<tr><td class="paramname">len</td><td>Length of buffer to convert </td></tr>
<tr><td class="paramname">kvsep</td><td>Character separating key and value </td></tr>
<tr><td class="paramname">pair_sep</td><td>Character separating key/value pairs </td></tr>
<tr><td class="paramname">flags</td><td>bitmask. See KVVEC_{ASSIGN,COPY,APPEND} for values </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of pairs in the created key/value vector </dd></dl>
</div>
</div>
<a class="anchor" id="a0908a0556bf1b0a2e7b20cffeb2dc539"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structkvvec__buf.html">kvvec_buf</a>* kvvec2buf </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>kv_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>pair_sep</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>overalloc</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a linear buffer of all the key/value pairs and return it as a <a class="el" href="structkvvec__buf.html" title="key/value vector buffer. ">kvvec_buf</a>. </p>
<p>The caller must free() all pointers in the returned <a class="el" href="structkvvec__buf.html" title="key/value vector buffer. ">kvvec_buf</a> (FIXME: add kvvec_buf_destroy(), or move this and its counterpart out of the kvvec api into a separate one)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to convert </td></tr>
<tr><td class="paramname">kv_sep</td><td>Character separating keys and their values </td></tr>
<tr><td class="paramname">pair_sep</td><td>Character separating key/value pairs </td></tr>
<tr><td class="paramname">overalloc</td><td>Integer determining how much extra data we should allocate. The overallocated memory is filled with nul bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to a newly created <a class="el" href="structkvvec__buf.html" title="key/value vector buffer. ">kvvec_buf</a> structure </dd></dl>
</div>
</div>
<a class="anchor" id="a4bb7a8e7ae51a50712257b417cab1b73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kvvec_addkv_wlen </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>keylen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>valuelen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a key/value pair to an existing key/value vector, with lengths of strings already calculated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to add this key/value pair to </td></tr>
<tr><td class="paramname">key</td><td>The key </td></tr>
<tr><td class="paramname">keylen</td><td>Length of the key </td></tr>
<tr><td class="paramname">value</td><td>The value </td></tr>
<tr><td class="paramname">valuelen</td><td>Length of the value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a371ef5a04f6580d9d7b71697e1c993fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int kvvec_capacity </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return remaining storage capacity of key/value vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">kvv</td><td>The key/value vector to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of key/value pairs that can be stored without growing </dd></dl>
</div>
</div>
<a class="anchor" id="a323a230712dcc699552f4c9f4066cc7b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structkvvec.html">kvvec</a>* kvvec_create </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>hint</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a key/value vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hint</td><td>Number of key/value pairs we expect to store </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a struct kvvec, properly initialized </dd></dl>
</div>
</div>
<a class="anchor" id="ae48257e5e7ca526bb1c446d9df330a30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kvvec_destroy </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a key/value vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to destroy </td></tr>
<tr><td class="paramname">flags</td><td>or'ed combination of KVVEC_FREE_{KEYS,VALUES}, or KVVEC_FREE_ALL </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="aaacdeaf527f8891425235a2b77e6055c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kvvec_foreach </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>arg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(struct <a class="el" href="structkey__value.html">key_value</a> *, void *) </td>
<td class="paramname"><em>callback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Walk each key/value pair in a key/value vector, sending them as arguments to a callback function. </p>
<p>The callback function has no control over the iteration process and must not delete or modify the key/value vector it's operating on. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to walk </td></tr>
<tr><td class="paramname">arg</td><td>Extra argument to the callback function </td></tr>
<tr><td class="paramname">callback</td><td>Callback function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a334e2ad55304e6775ad22e219361aad2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kvvec_free_kvpairs </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free key/value pairs associated with a key/value vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to operate on </td></tr>
<tr><td class="paramname">flags</td><td>flags or'ed combination of KVVEC_FREE_{KEYS,VALUES}, or KVVEC_FREE_ALL </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae371eaec3a3ef11ccc4880909470e410"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kvvec_grow </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>hint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Grow a key/value vector. </p>
<p>Used internally as needed by the kvvec api. If 'hint' is zero, the key/value capacity is increased by a third of the current capacity plus a small constant number. This uses <a class="el" href="kvvec_8h.html#ac34da75473e20794d20d8e783e258c97" title="Resize a key/value vector Used by kvvec_grow(). ">kvvec_resize()</a> internally.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to grow </td></tr>
<tr><td class="paramname">hint</td><td>The amount of key/value slots we should grow by </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a4a57f190e865c2cbc061f610c8e3f2be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structkvvec.html">kvvec</a>* kvvec_init </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>hint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a previously allocated key/value vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to initialize </td></tr>
<tr><td class="paramname">hint</td><td>Number of key/value pairs we expect to store </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a struct kvvec, properly initialized </dd></dl>
</div>
</div>
<a class="anchor" id="ac34da75473e20794d20d8e783e258c97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kvvec_resize </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resize a key/value vector Used by <a class="el" href="kvvec_8h.html#ae371eaec3a3ef11ccc4880909470e410" title="Grow a key/value vector. ">kvvec_grow()</a>. </p>
<p>If size is smaller than the current number of used key/value slots, -1 is returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">kvv</td><td>The key/value vector to resize </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size to grow to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="af18974709de148f303770b2778f48804"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kvvec_sort </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structkvvec.html">kvvec</a> * </td>
<td class="paramname"><em>kvv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sort a key/value vector alphabetically by key name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kvv</td><td>The key/value vector to sort </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Zerion Mini Shell 1.0