| Current File : //usr/share/doc/net-snmp/html/container_8h_source.html |
<!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"/>
<title>net-snmp: container.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">net-snmp
 <span id="projectnumber">5.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<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="modules.html"><span>Modules</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><a href="examples.html"><span>Examples</span></a></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>
</div>
<div class="header">
<div class="headertitle">
<div class="title">container.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef NETSNMP_CONTAINER_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define NETSNMP_CONTAINER_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004 <span class="comment">/*</span>
<a name="l00005"></a>00005 <span class="comment"> * $Id: container.h 13803 2005-12-04 18:43:04Z rstory $</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * WARNING: This is a recently created file, and all of it's contents are</span>
<a name="l00008"></a>00008 <span class="comment"> * subject to change at any time.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * A basic container template. A generic way for code to store and</span>
<a name="l00011"></a>00011 <span class="comment"> * retrieve data. Allows for interchangable storage algorithms.</span>
<a name="l00012"></a>00012 <span class="comment"> */</span>
<a name="l00013"></a>00013 <span class="preprocessor">#ifndef NET_SNMP_CONFIG_H</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#error "Please include <net-snmp/net-snmp-config.h> before this file"</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <net-snmp/types.h></span>
<a name="l00018"></a>00018 <span class="preprocessor">#include <net-snmp/library/factory.h></span>
<a name="l00019"></a>00019 <span class="preprocessor">#include <net-snmp/library/snmp_logging.h></span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment">/*************************************************************************</span>
<a name="l00026"></a>00026 <span class="comment"> *</span>
<a name="l00027"></a>00027 <span class="comment"> * function pointer definitions</span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> *************************************************************************/</span>
<a name="l00030"></a>00030 <span class="keyword">struct </span><a class="code" href="structnetsnmp__iterator__s.html">netsnmp_iterator_s</a>;
<a name="l00031"></a>00031 <span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a>;
<a name="l00033"></a>00033 <span class="comment">/*</span>
<a name="l00034"></a>00034 <span class="comment"> * function for performing an operation on a container which</span>
<a name="l00035"></a>00035 <span class="comment"> * returns (maybe the same) container.</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a>* (netsnmp_container_mod_op)
<a name="l00039"></a>00039 (<span class="keyword">struct</span> <a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *, <span class="keywordtype">void</span> *context, u_int flags);
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">/*</span>
<a name="l00042"></a>00042 <span class="comment"> * function for setting an option on a container</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044 <span class="keyword">typedef</span> int (netsnmp_container_option)(<span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *,
<a name="l00045"></a>00045 <span class="keywordtype">int</span> <span class="keyword">set</span>, u_int flags);
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">/*</span>
<a name="l00048"></a>00048 <span class="comment"> * function returning an int for an operation on a container</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="keyword">typedef</span> int (netsnmp_container_rc)(<span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *);
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">/*</span>
<a name="l00053"></a>00053 <span class="comment"> * function returning an iterator for a container</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structnetsnmp__iterator__s.html">netsnmp_iterator_s</a> * (netsnmp_container_it)
<a name="l00056"></a>00056 (<span class="keyword">struct</span> <a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *);
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">/*</span>
<a name="l00059"></a>00059 <span class="comment"> * function returning a size_t for an operation on a container</span>
<a name="l00060"></a>00060 <span class="comment"> */</span>
<a name="l00061"></a>00061 <span class="keyword">typedef</span> size_t (netsnmp_container_size)(<span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">/*</span>
<a name="l00064"></a>00064 <span class="comment"> * function returning an int for an operation on an object and</span>
<a name="l00065"></a>00065 <span class="comment"> * a container</span>
<a name="l00066"></a>00066 <span class="comment"> */</span>
<a name="l00067"></a>00067 <span class="keyword">typedef</span> int (netsnmp_container_op)(<span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *,
<a name="l00068"></a>00068 <span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">/*</span>
<a name="l00071"></a>00071 <span class="comment"> * function returning an oject for an operation on an object and a</span>
<a name="l00072"></a>00072 <span class="comment"> * container</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (netsnmp_container_rtn)(<span class="keyword">struct</span> <a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *,
<a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="comment">/*</span>
<a name="l00078"></a>00078 <span class="comment"> * function with no return which acts on an object</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <span class="keyword">typedef</span> void (netsnmp_container_obj_func)(<span class="keywordtype">void</span> *data, <span class="keywordtype">void</span> *context);
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">/*</span>
<a name="l00083"></a>00083 <span class="comment"> * function with no return which calls a function on an object</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085 <span class="keyword">typedef</span> void (netsnmp_container_func)(<span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *,
<a name="l00086"></a>00086 netsnmp_container_obj_func *,
<a name="l00087"></a>00087 <span class="keywordtype">void</span> *context);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="comment">/*</span>
<a name="l00090"></a>00090 <span class="comment"> * function returning an array of objects for an operation on an</span>
<a name="l00091"></a>00091 <span class="comment"> * ojbect and a container</span>
<a name="l00092"></a>00092 <span class="comment"> */</span>
<a name="l00093"></a>00093 <span class="keyword">typedef</span> <a class="code" href="structnetsnmp__void__array__s.html">netsnmp_void_array</a> * (netsnmp_container_set)
<a name="l00094"></a>00094 (<span class="keyword">struct</span> <a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *, <span class="keywordtype">void</span> *data);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">/*</span>
<a name="l00097"></a>00097 <span class="comment"> * function returning an int for a comparison between two objects</span>
<a name="l00098"></a>00098 <span class="comment"> */</span>
<a name="l00099"></a>00099 <span class="keyword">typedef</span> int (netsnmp_container_compare)(<span class="keyword">const</span> <span class="keywordtype">void</span> *lhs,
<a name="l00100"></a>00100 <span class="keyword">const</span> <span class="keywordtype">void</span> *rhs);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="comment">/*************************************************************************</span>
<a name="l00103"></a>00103 <span class="comment"> *</span>
<a name="l00104"></a>00104 <span class="comment"> * Basic container</span>
<a name="l00105"></a>00105 <span class="comment"> *</span>
<a name="l00106"></a>00106 <span class="comment"> *************************************************************************/</span>
<a name="l00107"></a><a class="code" href="structnetsnmp__container__s.html">00107</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> {
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">/*</span>
<a name="l00110"></a>00110 <span class="comment"> * pointer for container implementation</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112 <span class="keywordtype">void</span> * container_data;
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">/*</span>
<a name="l00115"></a>00115 <span class="comment"> * returns the number of items in a container</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 netsnmp_container_size *get_size;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="comment">/*</span>
<a name="l00120"></a>00120 <span class="comment"> * initialize a container</span>
<a name="l00121"></a>00121 <span class="comment"> */</span>
<a name="l00122"></a>00122 netsnmp_container_rc *init;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">/*</span>
<a name="l00125"></a>00125 <span class="comment"> * release memory used by a container.</span>
<a name="l00126"></a>00126 <span class="comment"> *</span>
<a name="l00127"></a>00127 <span class="comment"> * Note: if your data structures contained allocated</span>
<a name="l00128"></a>00128 <span class="comment"> * memory, you are responsible for releasing that</span>
<a name="l00129"></a>00129 <span class="comment"> * memory before calling this function!</span>
<a name="l00130"></a>00130 <span class="comment"> */</span>
<a name="l00131"></a>00131 netsnmp_container_rc *cfree;
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="comment">/*</span>
<a name="l00134"></a>00134 <span class="comment"> * add an entry to the container</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a>00136 netsnmp_container_op *insert;
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">/*</span>
<a name="l00139"></a>00139 <span class="comment"> * remove an entry from the container</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 netsnmp_container_op *<span class="keyword">remove</span>;
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="comment">/*</span>
<a name="l00144"></a>00144 <span class="comment"> * release memory for an entry from the container</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 netsnmp_container_op *release;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">/*</span>
<a name="l00149"></a>00149 <span class="comment"> * Note: do not change the key! If you need to</span>
<a name="l00150"></a>00150 <span class="comment"> * change a key, remove the entry, change the key,</span>
<a name="l00151"></a>00151 <span class="comment"> * and the re-add the entry.</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">/*</span>
<a name="l00155"></a>00155 <span class="comment"> * find the entry in the container with the same key</span>
<a name="l00156"></a>00156 <span class="comment"> *</span>
<a name="l00157"></a>00157 <span class="comment"> */</span>
<a name="l00158"></a>00158 netsnmp_container_rtn *find;
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="comment">/*</span>
<a name="l00161"></a>00161 <span class="comment"> * find the entry in the container with the next highest key</span>
<a name="l00162"></a>00162 <span class="comment"> *</span>
<a name="l00163"></a>00163 <span class="comment"> * If the key is NULL, return the first item in the container.</span>
<a name="l00164"></a>00164 <span class="comment"> */</span>
<a name="l00165"></a>00165 netsnmp_container_rtn *find_next;
<a name="l00166"></a>00166
<a name="l00167"></a>00167 <span class="comment">/*</span>
<a name="l00168"></a>00168 <span class="comment"> * find all entries in the container which match the partial key</span>
<a name="l00169"></a>00169 <span class="comment"> * returns allocated memory (netsnmp_void_array). User is responsible</span>
<a name="l00170"></a>00170 <span class="comment"> * for releasing this memory (free(array->array), free(array)).</span>
<a name="l00171"></a>00171 <span class="comment"> * DO NOT FREE ELEMENTS OF THE ARRAY, because they are the same pointers</span>
<a name="l00172"></a>00172 <span class="comment"> * stored in the container.</span>
<a name="l00173"></a>00173 <span class="comment"> */</span>
<a name="l00174"></a>00174 netsnmp_container_set *get_subset;
<a name="l00175"></a>00175
<a name="l00176"></a>00176 <span class="comment">/*</span>
<a name="l00177"></a>00177 <span class="comment"> * function to return an iterator for the container</span>
<a name="l00178"></a>00178 <span class="comment"> */</span>
<a name="l00179"></a>00179 netsnmp_container_it *get_iterator;
<a name="l00180"></a>00180
<a name="l00181"></a>00181 <span class="comment">/*</span>
<a name="l00182"></a>00182 <span class="comment"> * function to call another function for each object in the container</span>
<a name="l00183"></a>00183 <span class="comment"> */</span>
<a name="l00184"></a>00184 netsnmp_container_func *for_each;
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="comment">/*</span>
<a name="l00187"></a>00187 <span class="comment"> * specialized version of for_each used to optimize cleanup.</span>
<a name="l00188"></a>00188 <span class="comment"> * clear the container, optionally calling a function for each item.</span>
<a name="l00189"></a>00189 <span class="comment"> */</span>
<a name="l00190"></a>00190 netsnmp_container_func *clear;
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="comment">/*</span>
<a name="l00193"></a>00193 <span class="comment"> * OPTIONAL function to filter inserts to the container</span>
<a name="l00194"></a>00194 <span class="comment"> * (intended for a secondary container, which only wants</span>
<a name="l00195"></a>00195 <span class="comment"> * a sub-set of the objects in the primary/parent container)</span>
<a name="l00196"></a>00196 <span class="comment"> * Returns:</span>
<a name="l00197"></a>00197 <span class="comment"> * 1 : filter matched (don't insert)</span>
<a name="l00198"></a>00198 <span class="comment"> * 0 : no match (insert)</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a>00200 netsnmp_container_op *insert_filter;
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="comment">/*</span>
<a name="l00203"></a>00203 <span class="comment"> * OPTIONAL function to duplicate a container. Defaults to a shallow</span>
<a name="l00204"></a>00204 <span class="comment"> * copy. Only the specified container is copied (i.e. sub-containers</span>
<a name="l00205"></a>00205 <span class="comment"> * not included).</span>
<a name="l00206"></a>00206 <span class="comment"> */</span>
<a name="l00207"></a>00207
<a name="l00208"></a>00208 netsnmp_container_mod_op *duplicate;
<a name="l00209"></a>00209
<a name="l00210"></a>00210 <span class="comment">/*</span>
<a name="l00211"></a>00211 <span class="comment"> * function to compare two object stored in the container.</span>
<a name="l00212"></a>00212 <span class="comment"> *</span>
<a name="l00213"></a>00213 <span class="comment"> * Returns:</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> * -1 LHS < RHS</span>
<a name="l00216"></a>00216 <span class="comment"> * 0 LHS = RHS</span>
<a name="l00217"></a>00217 <span class="comment"> * 1 LHS > RHS</span>
<a name="l00218"></a>00218 <span class="comment"> */</span>
<a name="l00219"></a>00219 netsnmp_container_compare *compare;
<a name="l00220"></a>00220
<a name="l00221"></a>00221 <span class="comment">/*</span>
<a name="l00222"></a>00222 <span class="comment"> * same as compare, but RHS will be a partial key</span>
<a name="l00223"></a>00223 <span class="comment"> */</span>
<a name="l00224"></a>00224 netsnmp_container_compare *ncompare;
<a name="l00225"></a>00225
<a name="l00226"></a>00226 <span class="comment">/*</span>
<a name="l00227"></a>00227 <span class="comment"> * function to set container options</span>
<a name="l00228"></a>00228 <span class="comment"> */</span>
<a name="l00229"></a>00229 netsnmp_container_option *options;
<a name="l00230"></a>00230
<a name="l00231"></a>00231 <span class="comment">/*</span>
<a name="l00232"></a>00232 <span class="comment"> * unique name for finding a particular container in a list</span>
<a name="l00233"></a>00233 <span class="comment"> */</span>
<a name="l00234"></a>00234 <span class="keywordtype">char</span> *container_name;
<a name="l00235"></a>00235
<a name="l00236"></a>00236 <span class="comment">/*</span>
<a name="l00237"></a>00237 <span class="comment"> * sort count, for iterators to track (insert/delete</span>
<a name="l00238"></a>00238 <span class="comment"> * bumps counter, invalidates iterator)</span>
<a name="l00239"></a>00239 <span class="comment"> */</span>
<a name="l00240"></a>00240 u_long sync;
<a name="l00241"></a>00241
<a name="l00242"></a>00242 <span class="comment">/*</span>
<a name="l00243"></a>00243 <span class="comment"> * flags</span>
<a name="l00244"></a>00244 <span class="comment"> */</span>
<a name="l00245"></a>00245 u_int flags;
<a name="l00246"></a>00246
<a name="l00247"></a>00247 <span class="comment">/*</span>
<a name="l00248"></a>00248 <span class="comment"> * containers can contain other containers (additional indexes)</span>
<a name="l00249"></a>00249 <span class="comment"> */</span>
<a name="l00250"></a>00250 <span class="keyword">struct </span><a class="code" href="structnetsnmp__container__s.html">netsnmp_container_s</a> *next, *prev;
<a name="l00251"></a>00251
<a name="l00252"></a>00252 } <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a>;
<a name="l00253"></a>00253
<a name="l00254"></a>00254 <span class="comment">/*</span>
<a name="l00255"></a>00255 <span class="comment"> * initialize/free a container of container factories. used by</span>
<a name="l00256"></a>00256 <span class="comment"> * netsnmp_container_find* functions.</span>
<a name="l00257"></a>00257 <span class="comment"> */</span>
<a name="l00258"></a>00258 <span class="keywordtype">void</span> netsnmp_container_init_list(<span class="keywordtype">void</span>);
<a name="l00259"></a>00259 <span class="keywordtype">void</span> netsnmp_container_free_list(<span class="keywordtype">void</span>);
<a name="l00260"></a>00260
<a name="l00261"></a>00261 <span class="comment">/*</span>
<a name="l00262"></a>00262 <span class="comment"> * register a new container factory</span>
<a name="l00263"></a>00263 <span class="comment"> */</span>
<a name="l00264"></a>00264 <span class="keywordtype">int</span> netsnmp_container_register_with_compare(<span class="keyword">const</span> <span class="keywordtype">char</span>* name,
<a name="l00265"></a>00265 <a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory</a> *f,
<a name="l00266"></a>00266 netsnmp_container_compare *c);
<a name="l00267"></a>00267 <span class="keywordtype">int</span> netsnmp_container_register(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory</a> *f);
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="comment">/*</span>
<a name="l00270"></a>00270 <span class="comment"> * search for and create a container from a list of types or a</span>
<a name="l00271"></a>00271 <span class="comment"> * specific type.</span>
<a name="l00272"></a>00272 <span class="comment"> */</span>
<a name="l00273"></a>00273 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> * netsnmp_container_find(<span class="keyword">const</span> <span class="keywordtype">char</span> *type_list);
<a name="l00274"></a>00274 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> * netsnmp_container_get(<span class="keyword">const</span> <span class="keywordtype">char</span> *type);
<a name="l00275"></a>00275
<a name="l00276"></a>00276 <span class="comment">/*</span>
<a name="l00277"></a>00277 <span class="comment"> * utility routines</span>
<a name="l00278"></a>00278 <span class="comment"> */</span>
<a name="l00279"></a>00279 <span class="keywordtype">void</span> netsnmp_container_add_index(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *primary,
<a name="l00280"></a>00280 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *new_index);
<a name="l00281"></a>00281
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory</a> *netsnmp_container_get_factory(<span class="keyword">const</span> <span class="keywordtype">char</span> *type);
<a name="l00284"></a>00284
<a name="l00285"></a>00285 <span class="comment">/*</span>
<a name="l00286"></a>00286 <span class="comment"> * common comparison routines</span>
<a name="l00287"></a>00287 <span class="comment"> */</span>
<a name="l00289"></a>00289 <span class="keywordtype">int</span> netsnmp_compare_netsnmp_index(<span class="keyword">const</span> <span class="keywordtype">void</span> *lhs, <span class="keyword">const</span> <span class="keywordtype">void</span> *rhs);
<a name="l00290"></a>00290 <span class="keywordtype">int</span> netsnmp_ncompare_netsnmp_index(<span class="keyword">const</span> <span class="keywordtype">void</span> *lhs, <span class="keyword">const</span> <span class="keywordtype">void</span> *rhs);
<a name="l00291"></a>00291
<a name="l00293"></a>00293 <span class="keywordtype">int</span> netsnmp_compare_cstring(<span class="keyword">const</span> <span class="keywordtype">void</span> * lhs, <span class="keyword">const</span> <span class="keywordtype">void</span> * rhs);
<a name="l00294"></a>00294 <span class="keywordtype">int</span> netsnmp_ncompare_cstring(<span class="keyword">const</span> <span class="keywordtype">void</span> * lhs, <span class="keyword">const</span> <span class="keywordtype">void</span> * rhs);
<a name="l00295"></a>00295
<a name="l00297"></a>00297 <span class="keywordtype">int</span> netsnmp_compare_mem(<span class="keyword">const</span> <span class="keywordtype">char</span> * lhs, <span class="keywordtype">size_t</span> lhs_len,
<a name="l00298"></a>00298 <span class="keyword">const</span> <span class="keywordtype">char</span> * rhs, <span class="keywordtype">size_t</span> rhs_len);
<a name="l00299"></a>00299
<a name="l00301"></a>00301 <span class="keywordtype">void</span> netsnmp_container_simple_free(<span class="keywordtype">void</span> *data, <span class="keywordtype">void</span> *context);
<a name="l00302"></a>00302
<a name="l00303"></a>00303 <span class="comment">/*</span>
<a name="l00304"></a>00304 <span class="comment"> * container optionflags</span>
<a name="l00305"></a>00305 <span class="comment"> */</span>
<a name="l00306"></a>00306 <span class="preprocessor">#define CONTAINER_KEY_ALLOW_DUPLICATES 0x00000001</span>
<a name="l00307"></a>00307 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_KEY_UNSORTED 0x00000002</span>
<a name="l00308"></a>00308 <span class="preprocessor"></span>
<a name="l00309"></a>00309 <span class="preprocessor">#define CONTAINER_SET_OPTIONS(x,o,rc) do { \</span>
<a name="l00310"></a>00310 <span class="preprocessor"> if (NULL==(x)->options) \</span>
<a name="l00311"></a>00311 <span class="preprocessor"> rc = -1; \</span>
<a name="l00312"></a>00312 <span class="preprocessor"> else { \</span>
<a name="l00313"></a>00313 <span class="preprocessor"> rc = (x)->options(x, 1, o); \</span>
<a name="l00314"></a>00314 <span class="preprocessor"> if (rc != -1 ) \</span>
<a name="l00315"></a>00315 <span class="preprocessor"> (x)->flags |= o; \</span>
<a name="l00316"></a>00316 <span class="preprocessor"> } \</span>
<a name="l00317"></a>00317 <span class="preprocessor"> } while(0)</span>
<a name="l00318"></a>00318 <span class="preprocessor"></span>
<a name="l00319"></a>00319 <span class="preprocessor">#define CONTAINER_CHECK_OPTION(x,o,rc) do { \</span>
<a name="l00320"></a>00320 <span class="preprocessor"> rc = x->flags & 0; \</span>
<a name="l00321"></a>00321 <span class="preprocessor"> } while(0)</span>
<a name="l00322"></a>00322 <span class="preprocessor"></span>
<a name="l00323"></a>00323
<a name="l00324"></a>00324 <span class="comment">/*</span>
<a name="l00325"></a>00325 <span class="comment"> * useful macros (x = container; k = key; c = user context)</span>
<a name="l00326"></a>00326 <span class="comment"> */</span>
<a name="l00327"></a>00327 <span class="preprocessor">#define CONTAINER_FIRST(x) (x)->find_next(x,NULL)</span>
<a name="l00328"></a>00328 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_FIND(x,k) (x)->find(x,k)</span>
<a name="l00329"></a>00329 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_NEXT(x,k) (x)->find_next(x,k)</span>
<a name="l00330"></a>00330 <span class="preprocessor"></span><span class="comment">/*</span>
<a name="l00331"></a>00331 <span class="comment"> * GET_SUBSET returns allocated memory (netsnmp_void_array). User is responsible</span>
<a name="l00332"></a>00332 <span class="comment"> * for releasing this memory (free(array->array), free(array)).</span>
<a name="l00333"></a>00333 <span class="comment"> * DO NOT FREE ELEMENTS OF THE ARRAY, because they are the same pointers</span>
<a name="l00334"></a>00334 <span class="comment"> * stored in the container.</span>
<a name="l00335"></a>00335 <span class="comment"> */</span>
<a name="l00336"></a>00336 <span class="preprocessor">#define CONTAINER_GET_SUBSET(x,k) (x)->get_subset(x,k)</span>
<a name="l00337"></a>00337 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_SIZE(x) (x)->get_size(x)</span>
<a name="l00338"></a>00338 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_ITERATOR(x) (x)->get_iterator(x)</span>
<a name="l00339"></a>00339 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_COMPARE(x,l,r) (x)->compare(l,r)</span>
<a name="l00340"></a>00340 <span class="preprocessor"></span><span class="preprocessor">#define CONTAINER_FOR_EACH(x,f,c) (x)->for_each(x,f,c)</span>
<a name="l00341"></a>00341 <span class="preprocessor"></span>
<a name="l00342"></a>00342 <span class="comment">/*</span>
<a name="l00343"></a>00343 <span class="comment"> * if you are getting multiple definitions of these three</span>
<a name="l00344"></a>00344 <span class="comment"> * inline functions, you most likely have optimizations turned off.</span>
<a name="l00345"></a>00345 <span class="comment"> * Either turn them back on, or define NETSNMP_NO_INLINE</span>
<a name="l00346"></a>00346 <span class="comment"> */</span>
<a name="l00347"></a>00347 <span class="preprocessor">#ifndef NETSNMP_USE_INLINE </span><span class="comment">/* default is to inline */</span>
<a name="l00348"></a>00348 <span class="comment">/*</span>
<a name="l00349"></a>00349 <span class="comment"> * insert k into all containers</span>
<a name="l00350"></a>00350 <span class="comment"> */</span>
<a name="l00351"></a>00351 <span class="keywordtype">int</span> CONTAINER_INSERT(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, <span class="keyword">const</span> <span class="keywordtype">void</span> *k);
<a name="l00352"></a>00352
<a name="l00353"></a>00353 <span class="comment">/*</span>
<a name="l00354"></a>00354 <span class="comment"> * remove k from all containers</span>
<a name="l00355"></a>00355 <span class="comment"> */</span>
<a name="l00356"></a>00356 <span class="keywordtype">int</span> CONTAINER_REMOVE(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, <span class="keyword">const</span> <span class="keywordtype">void</span> *k);
<a name="l00357"></a>00357
<a name="l00358"></a>00358 <span class="comment">/*</span>
<a name="l00359"></a>00359 <span class="comment"> * duplicate container</span>
<a name="l00360"></a>00360 <span class="comment"> */</span>
<a name="l00361"></a>00361 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *CONTAINER_DUP(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, <span class="keywordtype">void</span> *ctx,
<a name="l00362"></a>00362 u_int flags);
<a name="l00363"></a>00363
<a name="l00364"></a>00364 <span class="comment">/*</span>
<a name="l00365"></a>00365 <span class="comment"> * clear all containers. When clearing the *first* container, and</span>
<a name="l00366"></a>00366 <span class="comment"> * *only* the first container, call the function f for each item.</span>
<a name="l00367"></a>00367 <span class="comment"> * After calling this function, all containers should be empty.</span>
<a name="l00368"></a>00368 <span class="comment"> */</span>
<a name="l00369"></a>00369 <span class="keywordtype">void</span> CONTAINER_CLEAR(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, netsnmp_container_obj_func *f,
<a name="l00370"></a>00370 <span class="keywordtype">void</span> *c);
<a name="l00371"></a>00371 <span class="comment">/*</span>
<a name="l00372"></a>00372 <span class="comment"> * free all containers</span>
<a name="l00373"></a>00373 <span class="comment"> */</span>
<a name="l00374"></a>00374 <span class="keywordtype">int</span> CONTAINER_FREE(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x);
<a name="l00375"></a>00375 <span class="preprocessor">#else</span>
<a name="l00376"></a>00376 <span class="preprocessor"></span> <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00377"></a>00377 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00378"></a>00378 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00379"></a>00379 <span class="comment"> */</span>
<a name="l00380"></a>00380 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00381"></a>00381 <span class="keywordtype">int</span> CONTAINER_INSERT_HELPER(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a>* x, <span class="keyword">const</span> <span class="keywordtype">void</span>* k)
<a name="l00382"></a>00382 {
<a name="l00383"></a>00383 <span class="keywordflow">while</span>(x && x->insert_filter && x->insert_filter(x,k) == 1)
<a name="l00384"></a>00384 x = x->next;
<a name="l00385"></a>00385 <span class="keywordflow">if</span>(x) {
<a name="l00386"></a>00386 <span class="keywordtype">int</span> rc = x->insert(x,k);
<a name="l00387"></a>00387 <span class="keywordflow">if</span>(rc)
<a name="l00388"></a>00388 <a class="code" href="group__snmp__logging.html#ga9ba905368ea1c551b969af44b13e37c2" title="This snmp logging function allows variable argument list given the specified format and priority...">snmp_log</a>(LOG_ERR,<span class="stringliteral">"error on subcontainer '%s' insert (%d)\n"</span>,
<a name="l00389"></a>00389 x->container_name ? x->container_name : <span class="stringliteral">""</span>, rc);
<a name="l00390"></a>00390 <span class="keywordflow">else</span> {
<a name="l00391"></a>00391 rc = CONTAINER_INSERT_HELPER(x->next, k);
<a name="l00392"></a>00392 <span class="keywordflow">if</span>(rc)
<a name="l00393"></a>00393 x->remove(x,k);
<a name="l00394"></a>00394 }
<a name="l00395"></a>00395 <span class="keywordflow">return</span> rc;
<a name="l00396"></a>00396 }
<a name="l00397"></a>00397 <span class="keywordflow">return</span> 0;
<a name="l00398"></a>00398 }
<a name="l00399"></a>00399
<a name="l00400"></a>00400 <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00401"></a>00401 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00402"></a>00402 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00403"></a>00403 <span class="comment"> */</span>
<a name="l00404"></a>00404 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00405"></a>00405 <span class="keywordtype">int</span> CONTAINER_INSERT(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a>* x, <span class="keyword">const</span> <span class="keywordtype">void</span>* k)
<a name="l00406"></a>00406 {
<a name="l00408"></a>00408 <span class="keywordflow">while</span>(x->prev)
<a name="l00409"></a>00409 x = x->prev;
<a name="l00410"></a>00410 <span class="keywordflow">return</span> CONTAINER_INSERT_HELPER(x, k);
<a name="l00411"></a>00411 }
<a name="l00412"></a>00412
<a name="l00413"></a>00413 <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00414"></a>00414 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00415"></a>00415 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00416"></a>00416 <span class="comment"> */</span>
<a name="l00417"></a>00417 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00418"></a>00418 <span class="keywordtype">int</span> CONTAINER_REMOVE(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, <span class="keyword">const</span> <span class="keywordtype">void</span> *k)
<a name="l00419"></a>00419 {
<a name="l00420"></a>00420 <span class="keywordtype">int</span> rc2, rc = 0;
<a name="l00421"></a>00421
<a name="l00423"></a>00423 <span class="keywordflow">while</span>(x->next)
<a name="l00424"></a>00424 x = x->next;
<a name="l00425"></a>00425 <span class="keywordflow">while</span>(x) {
<a name="l00426"></a>00426 rc2 = x->remove(x,k);
<a name="l00428"></a>00428 <span class="keywordflow">if</span> ((rc2) && (NULL == x->insert_filter)) {
<a name="l00429"></a>00429 <a class="code" href="group__snmp__logging.html#ga9ba905368ea1c551b969af44b13e37c2" title="This snmp logging function allows variable argument list given the specified format and priority...">snmp_log</a>(LOG_ERR,<span class="stringliteral">"error on subcontainer remove (%d)\n"</span>, rc2);
<a name="l00430"></a>00430 rc = rc2;
<a name="l00431"></a>00431 }
<a name="l00432"></a>00432 x = x->prev;
<a name="l00433"></a>00433
<a name="l00434"></a>00434 }
<a name="l00435"></a>00435 <span class="keywordflow">return</span> rc;
<a name="l00436"></a>00436 }
<a name="l00437"></a>00437
<a name="l00438"></a>00438 <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00439"></a>00439 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00440"></a>00440 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00441"></a>00441 <span class="comment"> */</span>
<a name="l00442"></a>00442 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00443"></a>00443 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *CONTAINER_DUP(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, <span class="keywordtype">void</span> *ctx,
<a name="l00444"></a>00444 u_int flags)
<a name="l00445"></a>00445 {
<a name="l00446"></a>00446 <span class="keywordflow">if</span> (NULL == x->duplicate) {
<a name="l00447"></a>00447 <a class="code" href="group__snmp__logging.html#ga9ba905368ea1c551b969af44b13e37c2" title="This snmp logging function allows variable argument list given the specified format and priority...">snmp_log</a>(LOG_ERR, <span class="stringliteral">"container '%s' does not support duplicate\n"</span>,
<a name="l00448"></a>00448 x->container_name ? x->container_name : <span class="stringliteral">""</span>);
<a name="l00449"></a>00449 <span class="keywordflow">return</span> NULL;
<a name="l00450"></a>00450 }
<a name="l00451"></a>00451 <span class="keywordflow">return</span> x->duplicate(x, ctx, flags);
<a name="l00452"></a>00452 }
<a name="l00453"></a>00453
<a name="l00454"></a>00454 <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00455"></a>00455 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00456"></a>00456 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00457"></a>00457 <span class="comment"> */</span>
<a name="l00458"></a>00458 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00459"></a>00459 <span class="keywordtype">int</span> CONTAINER_FREE(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x)
<a name="l00460"></a>00460 {
<a name="l00461"></a>00461 <span class="keywordtype">int</span> rc2, rc = 0;
<a name="l00462"></a>00462
<a name="l00464"></a>00464 <span class="keywordflow">while</span>(x->next)
<a name="l00465"></a>00465 x = x->next;
<a name="l00466"></a>00466 <span class="keywordflow">while</span>(x) {
<a name="l00467"></a>00467 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *tmp;
<a name="l00468"></a>00468 tmp = x->prev;
<a name="l00469"></a>00469 <span class="keywordflow">if</span> (NULL != x->container_name)
<a name="l00470"></a>00470 <a class="code" href="group__util.html#ga951e93edb6f0ea941e26155e3f8912a6" title="Frees a pointer only if it is !NULL and sets its value to NULL.">SNMP_FREE</a>(x->container_name);
<a name="l00471"></a>00471 rc2 = x->cfree(x);
<a name="l00472"></a>00472 <span class="keywordflow">if</span> (rc2) {
<a name="l00473"></a>00473 <a class="code" href="group__snmp__logging.html#ga9ba905368ea1c551b969af44b13e37c2" title="This snmp logging function allows variable argument list given the specified format and priority...">snmp_log</a>(LOG_ERR,<span class="stringliteral">"error on subcontainer cfree (%d)\n"</span>, rc2);
<a name="l00474"></a>00474 rc = rc2;
<a name="l00475"></a>00475 }
<a name="l00476"></a>00476 x = tmp;
<a name="l00477"></a>00477 }
<a name="l00478"></a>00478 <span class="keywordflow">return</span> rc;
<a name="l00479"></a>00479 }
<a name="l00480"></a>00480
<a name="l00481"></a>00481 <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00482"></a>00482 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00483"></a>00483 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00484"></a>00484 <span class="comment"> */</span>
<a name="l00485"></a>00485 <span class="comment">/*</span>
<a name="l00486"></a>00486 <span class="comment"> * clear all containers. When clearing the *first* container, and</span>
<a name="l00487"></a>00487 <span class="comment"> * *only* the first container, call the function f for each item.</span>
<a name="l00488"></a>00488 <span class="comment"> * After calling this function, all containers should be empty.</span>
<a name="l00489"></a>00489 <span class="comment"> */</span>
<a name="l00490"></a>00490 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00491"></a>00491 <span class="keywordtype">void</span> CONTAINER_CLEAR(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x, netsnmp_container_obj_func *f,
<a name="l00492"></a>00492 <span class="keywordtype">void</span> *c)
<a name="l00493"></a>00493 {
<a name="l00495"></a>00495 <span class="keywordflow">while</span>(x->next)
<a name="l00496"></a>00496 x = x->next;
<a name="l00497"></a>00497 <span class="keywordflow">while</span>(x->prev) {
<a name="l00498"></a>00498 x->clear(x, NULL, c);
<a name="l00499"></a>00499 x = x->prev;
<a name="l00500"></a>00500 }
<a name="l00501"></a>00501 x->clear(x, f, c);
<a name="l00502"></a>00502 }
<a name="l00503"></a>00503
<a name="l00504"></a>00504 <span class="comment">/*------------------------------------------------------------------</span>
<a name="l00505"></a>00505 <span class="comment"> * These functions should EXACTLY match the function version in</span>
<a name="l00506"></a>00506 <span class="comment"> * container.c. If you change one, change them both.</span>
<a name="l00507"></a>00507 <span class="comment"> */</span>
<a name="l00508"></a>00508 <span class="comment">/*</span>
<a name="l00509"></a>00509 <span class="comment"> * Find a sub-container with the given name</span>
<a name="l00510"></a>00510 <span class="comment"> */</span>
<a name="l00511"></a>00511 NETSNMP_STATIC_INLINE <span class="comment">/* gcc docs recommend static w/inline */</span>
<a name="l00512"></a>00512 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *SUBCONTAINER_FIND(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *x,
<a name="l00513"></a>00513 <span class="keyword">const</span> <span class="keywordtype">char</span>* name)
<a name="l00514"></a>00514 {
<a name="l00515"></a>00515 <span class="keywordflow">if</span> ((NULL == x) || (NULL == name))
<a name="l00516"></a>00516 <span class="keywordflow">return</span> NULL;
<a name="l00517"></a>00517
<a name="l00519"></a>00519 <span class="keywordflow">while</span>(x->prev)
<a name="l00520"></a>00520 x = x->prev;
<a name="l00521"></a>00521 <span class="keywordflow">while</span>(x) {
<a name="l00522"></a>00522 <span class="keywordflow">if</span> ((NULL != x->container_name) &&
<a name="l00523"></a>00523 (0 == strcmp(name,x->container_name)))
<a name="l00524"></a>00524 <span class="keywordflow">break</span>;
<a name="l00525"></a>00525 x = x->next;
<a name="l00526"></a>00526 }
<a name="l00527"></a>00527 <span class="keywordflow">return</span> x;
<a name="l00528"></a>00528 }
<a name="l00529"></a>00529
<a name="l00530"></a>00530 <span class="preprocessor">#endif</span>
<a name="l00531"></a>00531 <span class="preprocessor"></span>
<a name="l00533"></a>00533 <span class="keywordtype">int</span> netsnmp_container_data_dup(<a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *dup,
<a name="l00534"></a>00534 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *c);
<a name="l00535"></a>00535
<a name="l00536"></a>00536 <span class="comment">/*************************************************************************</span>
<a name="l00537"></a>00537 <span class="comment"> *</span>
<a name="l00538"></a>00538 <span class="comment"> * container iterator</span>
<a name="l00539"></a>00539 <span class="comment"> *</span>
<a name="l00540"></a>00540 <span class="comment"> *************************************************************************/</span>
<a name="l00541"></a>00541 <span class="comment">/*</span>
<a name="l00542"></a>00542 <span class="comment"> * function returning an int for an operation on an iterator</span>
<a name="l00543"></a>00543 <span class="comment"> */</span>
<a name="l00544"></a>00544 <span class="keyword">typedef</span> int (netsnmp_iterator_rc)(<span class="keyword">struct </span><a class="code" href="structnetsnmp__iterator__s.html">netsnmp_iterator_s</a> *);
<a name="l00545"></a>00545
<a name="l00546"></a>00546 <span class="comment">/*</span>
<a name="l00547"></a>00547 <span class="comment"> * function returning an oject for an operation on an iterator</span>
<a name="l00548"></a>00548 <span class="comment"> */</span>
<a name="l00549"></a>00549 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (netsnmp_iterator_rtn)(<span class="keyword">struct</span> <a class="code" href="structnetsnmp__iterator__s.html">netsnmp_iterator_s</a> *);
<a name="l00550"></a>00550
<a name="l00551"></a>00551
<a name="l00552"></a>00552 <span class="comment">/*</span>
<a name="l00553"></a>00553 <span class="comment"> * iterator structure</span>
<a name="l00554"></a>00554 <span class="comment"> */</span>
<a name="l00555"></a><a class="code" href="structnetsnmp__iterator__s.html">00555</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structnetsnmp__iterator__s.html">netsnmp_iterator_s</a> {
<a name="l00556"></a>00556
<a name="l00557"></a>00557 <a class="code" href="structnetsnmp__container__s.html">netsnmp_container</a> *container;
<a name="l00558"></a>00558
<a name="l00559"></a>00559 <span class="comment">/*</span>
<a name="l00560"></a>00560 <span class="comment"> * sync from container when iterator created. used to invalidate</span>
<a name="l00561"></a>00561 <span class="comment"> * the iterator when the container changes.</span>
<a name="l00562"></a>00562 <span class="comment"> */</span>
<a name="l00563"></a>00563 u_long sync;
<a name="l00564"></a>00564
<a name="l00565"></a>00565 <span class="comment">/*</span>
<a name="l00566"></a>00566 <span class="comment"> * reset iterator position to beginning of container.</span>
<a name="l00567"></a>00567 <span class="comment"> */</span>
<a name="l00568"></a>00568 netsnmp_iterator_rc *reset;
<a name="l00569"></a>00569
<a name="l00570"></a>00570 <span class="comment">/*</span>
<a name="l00571"></a>00571 <span class="comment"> * release iterator and memory it uses</span>
<a name="l00572"></a>00572 <span class="comment"> */</span>
<a name="l00573"></a>00573 netsnmp_iterator_rc *release;
<a name="l00574"></a>00574
<a name="l00575"></a>00575 <span class="comment">/*</span>
<a name="l00576"></a>00576 <span class="comment"> * first, last and current DO NOT advance the iterator</span>
<a name="l00577"></a>00577 <span class="comment"> */</span>
<a name="l00578"></a>00578 netsnmp_iterator_rtn *first;
<a name="l00579"></a>00579 netsnmp_iterator_rtn *curr;
<a name="l00580"></a>00580 netsnmp_iterator_rtn *last;
<a name="l00581"></a>00581
<a name="l00582"></a>00582 netsnmp_iterator_rtn *next;
<a name="l00583"></a>00583
<a name="l00584"></a>00584 } <a class="code" href="structnetsnmp__iterator__s.html">netsnmp_iterator</a>;
<a name="l00585"></a>00585
<a name="l00586"></a>00586
<a name="l00587"></a>00587 <span class="preprocessor">#define ITERATOR_FIRST(x) x->first(x)</span>
<a name="l00588"></a>00588 <span class="preprocessor"></span><span class="preprocessor">#define ITERATOR_NEXT(x) x->next(x)</span>
<a name="l00589"></a>00589 <span class="preprocessor"></span><span class="preprocessor">#define ITERATOR_LAST(x) x->last(x)</span>
<a name="l00590"></a>00590 <span class="preprocessor"></span><span class="preprocessor">#define ITERATOR_RELEASE(x) do { x->release(x); x = NULL; } while(0)</span>
<a name="l00591"></a>00591 <span class="preprocessor"></span>
<a name="l00592"></a>00592 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00593"></a>00593 <span class="preprocessor"></span>}
<a name="l00594"></a>00594 <span class="preprocessor">#endif</span>
<a name="l00595"></a>00595 <span class="preprocessor"></span>
<a name="l00596"></a>00596 <span class="preprocessor">#endif </span>
</pre></div></div><!-- contents -->
<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.7.6.1
</small></address>
</body>
</html>