<!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"/>
<title>libnl: include/netlink/object-api.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libnl <span id="projectnumber">1.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>include/netlink/object-api.h</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * netlink/object-api.c Object API</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * of the License.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (c) 2003-2007 Thomas Graf <tgraf@suug.ch></span>
<a name="l00010"></a>00010 <span class="comment"> */</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef NETLINK_OBJECT_API_H_</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define NETLINK_OBJECT_API_H_</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <netlink/netlink.h></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include <netlink/utils.h></span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00020"></a>00020 <span class="preprocessor">#endif</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment">/**</span>
<a name="l00023"></a>00023 <span class="comment"> * @ingroup object</span>
<a name="l00024"></a>00024 <span class="comment"> * @defgroup object_api Object API</span>
<a name="l00025"></a>00025 <span class="comment"> * @brief</span>
<a name="l00026"></a>00026 <span class="comment"> *</span>
<a name="l00027"></a>00027 <span class="comment"> * @par 1) Object Definition</span>
<a name="l00028"></a>00028 <span class="comment"> * @code</span>
<a name="l00029"></a>00029 <span class="comment"> * // Define your object starting with the common object header</span>
<a name="l00030"></a>00030 <span class="comment"> * struct my_obj {</span>
<a name="l00031"></a>00031 <span class="comment"> * NLHDR_COMMON</span>
<a name="l00032"></a>00032 <span class="comment"> * int my_data;</span>
<a name="l00033"></a>00033 <span class="comment"> * };</span>
<a name="l00034"></a>00034 <span class="comment"> *</span>
<a name="l00035"></a>00035 <span class="comment"> * // Fill out the object operations structure</span>
<a name="l00036"></a>00036 <span class="comment"> * struct nl_object_ops my_ops = {</span>
<a name="l00037"></a>00037 <span class="comment"> * .oo_name = "my_obj",</span>
<a name="l00038"></a>00038 <span class="comment"> * .oo_size = sizeof(struct my_obj),</span>
<a name="l00039"></a>00039 <span class="comment"> * };</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * // At this point the object can be allocated, you may want to provide a</span>
<a name="l00042"></a>00042 <span class="comment"> * // separate _alloc() function to ease allocting objects of this kind.</span>
<a name="l00043"></a>00043 <span class="comment"> * struct nl_object *obj = nl_object_alloc(&my_ops);</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * // And release it again...</span>
<a name="l00046"></a>00046 <span class="comment"> * nl_object_put(obj);</span>
<a name="l00047"></a>00047 <span class="comment"> * @endcode</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * @par 2) Allocating additional data</span>
<a name="l00050"></a>00050 <span class="comment"> * @code</span>
<a name="l00051"></a>00051 <span class="comment"> * // You may require to allocate additional data and store it inside</span>
<a name="l00052"></a>00052 <span class="comment"> * // object, f.e. assuming there is a field `ptr'.</span>
<a name="l00053"></a>00053 <span class="comment"> * struct my_obj {</span>
<a name="l00054"></a>00054 <span class="comment"> * NLHDR_COMMON</span>
<a name="l00055"></a>00055 <span class="comment"> * void * ptr;</span>
<a name="l00056"></a>00056 <span class="comment"> * };</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * // And at some point you may assign allocated data to this field:</span>
<a name="l00059"></a>00059 <span class="comment"> * my_obj->ptr = calloc(1, ...);</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * // In order to not introduce any memory leaks you have to release</span>
<a name="l00062"></a>00062 <span class="comment"> * // this data again when the last reference is given back.</span>
<a name="l00063"></a>00063 <span class="comment"> * static void my_obj_free_data(struct nl_object *obj)</span>
<a name="l00064"></a>00064 <span class="comment"> * {</span>
<a name="l00065"></a>00065 <span class="comment"> * struct my_obj *my_obj = nl_object_priv(obj);</span>
<a name="l00066"></a>00066 <span class="comment"> *</span>
<a name="l00067"></a>00067 <span class="comment"> * free(my_obj->ptr);</span>
<a name="l00068"></a>00068 <span class="comment"> * }</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * // Also when the object is cloned, you must ensure for your pointer</span>
<a name="l00071"></a>00071 <span class="comment"> * // stay valid even if one of the clones is freed by either making</span>
<a name="l00072"></a>00072 <span class="comment"> * // a clone as well or increase the reference count.</span>
<a name="l00073"></a>00073 <span class="comment"> * static int my_obj_clone(struct nl_object *src, struct nl_object *dst)</span>
<a name="l00074"></a>00074 <span class="comment"> * {</span>
<a name="l00075"></a>00075 <span class="comment"> * struct my_obj *my_src = nl_object_priv(src);</span>
<a name="l00076"></a>00076 <span class="comment"> * struct my_obj *my_dst = nl_object_priv(dst);</span>
<a name="l00077"></a>00077 <span class="comment"> *</span>
<a name="l00078"></a>00078 <span class="comment"> * if (src->ptr) {</span>
<a name="l00079"></a>00079 <span class="comment"> * dst->ptr = calloc(1, ...);</span>
<a name="l00080"></a>00080 <span class="comment"> * memcpy(dst->ptr, src->ptr, ...);</span>
<a name="l00081"></a>00081 <span class="comment"> * }</span>
<a name="l00082"></a>00082 <span class="comment"> * }</span>
<a name="l00083"></a>00083 <span class="comment"> *</span>
<a name="l00084"></a>00084 <span class="comment"> * struct nl_object_ops my_ops = {</span>
<a name="l00085"></a>00085 <span class="comment"> * ...</span>
<a name="l00086"></a>00086 <span class="comment"> * .oo_free_data = my_obj_free_data,</span>
<a name="l00087"></a>00087 <span class="comment"> * .oo_clone = my_obj_clone,</span>
<a name="l00088"></a>00088 <span class="comment"> * };</span>
<a name="l00089"></a>00089 <span class="comment"> * @endcode</span>
<a name="l00090"></a>00090 <span class="comment"> *</span>
<a name="l00091"></a>00091 <span class="comment"> * @par 3) Object Dumping</span>
<a name="l00092"></a>00092 <span class="comment"> * @code</span>
<a name="l00093"></a>00093 <span class="comment"> * static int my_obj_dump_detailed(struct nl_object *obj,</span>
<a name="l00094"></a>00094 <span class="comment"> * struct nl_dump_params *params)</span>
<a name="l00095"></a>00095 <span class="comment"> * {</span>
<a name="l00096"></a>00096 <span class="comment"> * struct my_obj *my_obj = nl_object_priv(obj);</span>
<a name="l00097"></a>00097 <span class="comment"> * int line = 1; // We will print at least one line for sure</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * // It is absolutely essential to use nl_dump() when printing</span>
<a name="l00100"></a>00100 <span class="comment"> * // any text to make sure the dumping parameters are respected.</span>
<a name="l00101"></a>00101 <span class="comment"> * nl_dump(params, "Obj Integer: %d\n", my_obj->my_int);</span>
<a name="l00102"></a>00102 <span class="comment"> *</span>
<a name="l00103"></a>00103 <span class="comment"> * // Before we can dump the next line, make sure to prefix</span>
<a name="l00104"></a>00104 <span class="comment"> * // this line correctly.</span>
<a name="l00105"></a>00105 <span class="comment"> * nl_new_line(params, line++);</span>
<a name="l00106"></a>00106 <span class="comment"> *</span>
<a name="l00107"></a>00107 <span class="comment"> * // You may also split a line into multiple nl_dump() calls.</span>
<a name="l00108"></a>00108 <span class="comment"> * nl_dump(params, "String: %s ", my_obj->my_string);</span>
<a name="l00109"></a>00109 <span class="comment"> * nl_dump(params, "String-2: %s\n", my_obj->another_string);</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * // Return the number of lines dumped</span>
<a name="l00112"></a>00112 <span class="comment"> * return line;</span>
<a name="l00113"></a>00113 <span class="comment"> * }</span>
<a name="l00114"></a>00114 <span class="comment"> *</span>
<a name="l00115"></a>00115 <span class="comment"> * struct nl_object_ops my_ops = {</span>
<a name="l00116"></a>00116 <span class="comment"> * ...</span>
<a name="l00117"></a>00117 <span class="comment"> * .oo_dump[NL_DUMP_FULL] = my_obj_dump_detailed,</span>
<a name="l00118"></a>00118 <span class="comment"> * };</span>
<a name="l00119"></a>00119 <span class="comment"> * @endcode</span>
<a name="l00120"></a>00120 <span class="comment"> *</span>
<a name="l00121"></a>00121 <span class="comment"> * @par 4) Object Attributes</span>
<a name="l00122"></a>00122 <span class="comment"> * @code</span>
<a name="l00123"></a>00123 <span class="comment"> * // The concept of object attributes is optional but can ease the typical</span>
<a name="l00124"></a>00124 <span class="comment"> * // case of objects that have optional attributes, e.g. a route may have a</span>
<a name="l00125"></a>00125 <span class="comment"> * // nexthop assigned but it is not required to.</span>
<a name="l00126"></a>00126 <span class="comment"> *</span>
<a name="l00127"></a>00127 <span class="comment"> * // The first step to define your object specific bitmask listing all</span>
<a name="l00128"></a>00128 <span class="comment"> * // attributes</span>
<a name="l00129"></a>00129 <span class="comment"> * #define MY_ATTR_FOO (1<<0)</span>
<a name="l00130"></a>00130 <span class="comment"> * #define MY_ATTR_BAR (1<<1)</span>
<a name="l00131"></a>00131 <span class="comment"> *</span>
<a name="l00132"></a>00132 <span class="comment"> * // When assigning an optional attribute to the object, make sure</span>
<a name="l00133"></a>00133 <span class="comment"> * // to mark its availability.</span>
<a name="l00134"></a>00134 <span class="comment"> * my_obj->foo = 123123;</span>
<a name="l00135"></a>00135 <span class="comment"> * my_obj->ce_mask |= MY_ATTR_FOO;</span>
<a name="l00136"></a>00136 <span class="comment"> *</span>
<a name="l00137"></a>00137 <span class="comment"> * // At any time you may use this mask to check for the availability</span>
<a name="l00138"></a>00138 <span class="comment"> * // of the attribute, e.g. while dumping</span>
<a name="l00139"></a>00139 <span class="comment"> * if (my_obj->ce_mask & MY_ATTR_FOO)</span>
<a name="l00140"></a>00140 <span class="comment"> * nl_dump(params, "foo %d ", my_obj->foo);</span>
<a name="l00141"></a>00141 <span class="comment"> *</span>
<a name="l00142"></a>00142 <span class="comment"> * // One of the big advantages of this concept is that it allows for</span>
<a name="l00143"></a>00143 <span class="comment"> * // standardized comparisons which make it trivial for caches to</span>
<a name="l00144"></a>00144 <span class="comment"> * // identify unique objects by use of unified comparison functions.</span>
<a name="l00145"></a>00145 <span class="comment"> * // In order for it to work, your object implementation must provide</span>
<a name="l00146"></a>00146 <span class="comment"> * // a comparison function and define a list of attributes which</span>
<a name="l00147"></a>00147 <span class="comment"> * // combined together make an object unique.</span>
<a name="l00148"></a>00148 <span class="comment"> *</span>
<a name="l00149"></a>00149 <span class="comment"> * static int my_obj_compare(struct nl_object *_a, struct nl_object *_b,</span>
<a name="l00150"></a>00150 <span class="comment"> * uint32_t attrs, int flags)</span>
<a name="l00151"></a>00151 <span class="comment"> * {</span>
<a name="l00152"></a>00152 <span class="comment"> * struct my_obj *a = nl_object_priv(_a):</span>
<a name="l00153"></a>00153 <span class="comment"> * struct my_obj *b = nl_object_priv(_b):</span>
<a name="l00154"></a>00154 <span class="comment"> * int diff = 0;</span>
<a name="l00155"></a>00155 <span class="comment"> *</span>
<a name="l00156"></a>00156 <span class="comment"> * // We help ourselves in defining our own DIFF macro which will</span>
<a name="l00157"></a>00157 <span class="comment"> * // call ATTR_DIFF() on both objects which will make sure to only</span>
<a name="l00158"></a>00158 <span class="comment"> * // compare the attributes if required.</span>
<a name="l00159"></a>00159 <span class="comment"> * #define MY_DIFF(ATTR, EXPR) ATTR_DIFF(attrs, MY_ATTR_##ATTR, a, b, EXPR)</span>
<a name="l00160"></a>00160 <span class="comment"> *</span>
<a name="l00161"></a>00161 <span class="comment"> * // Call our own diff macro for each attribute to build a bitmask</span>
<a name="l00162"></a>00162 <span class="comment"> * // representing the attributes which mismatch.</span>
<a name="l00163"></a>00163 <span class="comment"> * diff |= MY_DIFF(FOO, a->foo != b->foo)</span>
<a name="l00164"></a>00164 <span class="comment"> * diff |= MY_DIFF(BAR, strcmp(a->bar, b->bar))</span>
<a name="l00165"></a>00165 <span class="comment"> *</span>
<a name="l00166"></a>00166 <span class="comment"> * return diff;</span>
<a name="l00167"></a>00167 <span class="comment"> * }</span>
<a name="l00168"></a>00168 <span class="comment"> *</span>
<a name="l00169"></a>00169 <span class="comment"> * // In order to identify identical objects with differing attributes</span>
<a name="l00170"></a>00170 <span class="comment"> * // you must specify the attributes required to uniquely identify</span>
<a name="l00171"></a>00171 <span class="comment"> * // your object. Make sure to not include too many attributes, this</span>
<a name="l00172"></a>00172 <span class="comment"> * // list is used when caches look for an old version of an object.</span>
<a name="l00173"></a>00173 <span class="comment"> * struct nl_object_ops my_ops = {</span>
<a name="l00174"></a>00174 <span class="comment"> * ...</span>
<a name="l00175"></a>00175 <span class="comment"> * .oo_id_attrs = MY_ATTR_FOO,</span>
<a name="l00176"></a>00176 <span class="comment"> * .oo_compare = my_obj_compare,</span>
<a name="l00177"></a>00177 <span class="comment"> * };</span>
<a name="l00178"></a>00178 <span class="comment"> * @endcode</span>
<a name="l00179"></a>00179 <span class="comment"> * @{</span>
<a name="l00180"></a>00180 <span class="comment"> */</span>
<a name="l00181"></a>00181 <span class="comment"></span>
<a name="l00182"></a>00182 <span class="comment">/**</span>
<a name="l00183"></a>00183 <span class="comment"> * Common Object Header</span>
<a name="l00184"></a>00184 <span class="comment"> *</span>
<a name="l00185"></a>00185 <span class="comment"> * This macro must be included as first member in every object</span>
<a name="l00186"></a>00186 <span class="comment"> * definition to allow objects to be cached.</span>
<a name="l00187"></a>00187 <span class="comment"> */</span>
<a name="l00188"></a><a class="code" href="group__object__api.html#ga0f84d461252a52ed33e307432bd0b3f8">00188</a> <span class="preprocessor">#define NLHDR_COMMON \</span>
<a name="l00189"></a>00189 <span class="preprocessor"> int ce_refcnt; \</span>
<a name="l00190"></a>00190 <span class="preprocessor"> struct nl_object_ops * ce_ops; \</span>
<a name="l00191"></a>00191 <span class="preprocessor"> struct nl_cache * ce_cache; \</span>
<a name="l00192"></a>00192 <span class="preprocessor"> struct nl_list_head ce_list; \</span>
<a name="l00193"></a>00193 <span class="preprocessor"> int ce_msgtype; \</span>
<a name="l00194"></a>00194 <span class="preprocessor"> int ce_flags; \</span>
<a name="l00195"></a>00195 <span class="preprocessor"> uint32_t ce_mask;</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment">/**</span>
<a name="l00198"></a>00198 <span class="comment"> * Return true if attribute is available in both objects</span>
<a name="l00199"></a>00199 <span class="comment"> * @arg A an object</span>
<a name="l00200"></a>00200 <span class="comment"> * @arg B another object</span>
<a name="l00201"></a>00201 <span class="comment"> * @arg ATTR attribute bit</span>
<a name="l00202"></a>00202 <span class="comment"> *</span>
<a name="l00203"></a>00203 <span class="comment"> * @return True if the attribute is available, otherwise false is returned.</span>
<a name="l00204"></a>00204 <span class="comment"> */</span>
<a name="l00205"></a><a class="code" href="group__object__api.html#gaaea44dd0350eb403226ba5edba05ecbc">00205</a> <span class="preprocessor">#define AVAILABLE(A, B, ATTR) (((A)->ce_mask & (B)->ce_mask) & (ATTR))</span>
<a name="l00206"></a>00206 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00207"></a>00207 <span class="comment">/**</span>
<a name="l00208"></a>00208 <span class="comment"> * Return true if attributes mismatch</span>
<a name="l00209"></a>00209 <span class="comment"> * @arg A an object</span>
<a name="l00210"></a>00210 <span class="comment"> * @arg B another object</span>
<a name="l00211"></a>00211 <span class="comment"> * @arg ATTR attribute bit</span>
<a name="l00212"></a>00212 <span class="comment"> * @arg EXPR Comparison expression</span>
<a name="l00213"></a>00213 <span class="comment"> *</span>
<a name="l00214"></a>00214 <span class="comment"> * This function will check if the attribute in question is available</span>
<a name="l00215"></a>00215 <span class="comment"> * in both objects, if not this will count as a mismatch.</span>
<a name="l00216"></a>00216 <span class="comment"> *</span>
<a name="l00217"></a>00217 <span class="comment"> * If available the function will execute the expression which must</span>
<a name="l00218"></a>00218 <span class="comment"> * return true if the attributes mismatch.</span>
<a name="l00219"></a>00219 <span class="comment"> *</span>
<a name="l00220"></a>00220 <span class="comment"> * @return True if the attribute mismatch, or false if they match.</span>
<a name="l00221"></a>00221 <span class="comment"> */</span>
<a name="l00222"></a><a class="code" href="group__object__api.html#gafefec474eb34fd780b5233b6289773e9">00222</a> <span class="preprocessor">#define ATTR_MISMATCH(A, B, ATTR, EXPR) (!AVAILABLE(A, B, ATTR) || (EXPR))</span>
<a name="l00223"></a>00223 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00224"></a>00224 <span class="comment">/**</span>
<a name="l00225"></a>00225 <span class="comment"> * Return attribute bit if attribute does not match</span>
<a name="l00226"></a>00226 <span class="comment"> * @arg LIST list of attributes to be compared</span>
<a name="l00227"></a>00227 <span class="comment"> * @arg ATTR attribute bit</span>
<a name="l00228"></a>00228 <span class="comment"> * @arg A an object</span>
<a name="l00229"></a>00229 <span class="comment"> * @arg B another object</span>
<a name="l00230"></a>00230 <span class="comment"> * @arg EXPR Comparison expression</span>
<a name="l00231"></a>00231 <span class="comment"> *</span>
<a name="l00232"></a>00232 <span class="comment"> * This function will check if the attribute in question is available</span>
<a name="l00233"></a>00233 <span class="comment"> * in both objects, if not this will count as a mismatch.</span>
<a name="l00234"></a>00234 <span class="comment"> *</span>
<a name="l00235"></a>00235 <span class="comment"> * If available the function will execute the expression which must</span>
<a name="l00236"></a>00236 <span class="comment"> * return true if the attributes mismatch.</span>
<a name="l00237"></a>00237 <span class="comment"> *</span>
<a name="l00238"></a>00238 <span class="comment"> * In case the attributes mismatch, the attribute is returned, otherwise</span>
<a name="l00239"></a>00239 <span class="comment"> * 0 is returned.</span>
<a name="l00240"></a>00240 <span class="comment"> *</span>
<a name="l00241"></a>00241 <span class="comment"> * @code</span>
<a name="l00242"></a>00242 <span class="comment"> * diff |= ATTR_DIFF(attrs, MY_ATTR_FOO, a, b, a->foo != b->foo);</span>
<a name="l00243"></a>00243 <span class="comment"> * @endcode</span>
<a name="l00244"></a>00244 <span class="comment"> */</span>
<a name="l00245"></a><a class="code" href="group__object__api.html#ga726810b073cacc182dc6e2ea6cc2f14a">00245</a> <span class="preprocessor">#define ATTR_DIFF(LIST, ATTR, A, B, EXPR) \</span>
<a name="l00246"></a>00246 <span class="preprocessor">({ int diff = 0; \</span>
<a name="l00247"></a>00247 <span class="preprocessor"> if (((LIST) & (ATTR)) && ATTR_MISMATCH(A, B, ATTR, EXPR)) \</span>
<a name="l00248"></a>00248 <span class="preprocessor"> diff = ATTR; \</span>
<a name="l00249"></a>00249 <span class="preprocessor"> diff; })</span>
<a name="l00250"></a>00250 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">/**</span>
<a name="l00252"></a>00252 <span class="comment"> * Object Operations</span>
<a name="l00253"></a>00253 <span class="comment"> */</span>
<a name="l00254"></a><a class="code" href="structnl__object__ops.html">00254</a> <span class="keyword">struct </span><a class="code" href="structnl__object__ops.html" title="Object Operations.">nl_object_ops</a>
<a name="l00255"></a>00255 {<span class="comment"></span>
<a name="l00256"></a>00256 <span class="comment"> /**</span>
<a name="l00257"></a>00257 <span class="comment"> * Unique name of object type</span>
<a name="l00258"></a>00258 <span class="comment"> *</span>
<a name="l00259"></a>00259 <span class="comment"> * Must be in the form family/name, e.g. "route/addr"</span>
<a name="l00260"></a>00260 <span class="comment"> */</span>
<a name="l00261"></a><a class="code" href="structnl__object__ops.html#a5225584343fe711642303e000b036ee9">00261</a> <span class="keywordtype">char</span> * <a class="code" href="structnl__object__ops.html#a5225584343fe711642303e000b036ee9" title="Unique name of object type.">oo_name</a>;
<a name="l00262"></a>00262 <span class="comment"></span>
<a name="l00263"></a>00263 <span class="comment"> /** Size of object including its header */</span>
<a name="l00264"></a><a class="code" href="structnl__object__ops.html#a0fbd42c77db2f0488b8cd72858ece719">00264</a> <span class="keywordtype">size_t</span> <a class="code" href="structnl__object__ops.html#a0fbd42c77db2f0488b8cd72858ece719" title="Size of object including its header.">oo_size</a>;
<a name="l00265"></a>00265
<a name="l00266"></a>00266 <span class="comment">/* List of attributes needed to uniquely identify the object */</span>
<a name="l00267"></a>00267 uint32_t oo_id_attrs;
<a name="l00268"></a>00268 <span class="comment"></span>
<a name="l00269"></a>00269 <span class="comment"> /**</span>
<a name="l00270"></a>00270 <span class="comment"> * Constructor function</span>
<a name="l00271"></a>00271 <span class="comment"> *</span>
<a name="l00272"></a>00272 <span class="comment"> * Will be called when a new object of this type is allocated.</span>
<a name="l00273"></a>00273 <span class="comment"> * Can be used to initialize members such as lists etc.</span>
<a name="l00274"></a>00274 <span class="comment"> */</span>
<a name="l00275"></a><a class="code" href="structnl__object__ops.html#ac15b64a03806850db9493bd2fbfb64b7">00275</a> void (*<a class="code" href="structnl__object__ops.html#ac15b64a03806850db9493bd2fbfb64b7" title="Constructor function.">oo_constructor</a>)(<span class="keyword">struct </span>nl_object *);
<a name="l00276"></a>00276 <span class="comment"></span>
<a name="l00277"></a>00277 <span class="comment"> /**</span>
<a name="l00278"></a>00278 <span class="comment"> * Destructor function</span>
<a name="l00279"></a>00279 <span class="comment"> *</span>
<a name="l00280"></a>00280 <span class="comment"> * Will be called when an object is freed. Must free all</span>
<a name="l00281"></a>00281 <span class="comment"> * resources which may have been allocated as part of this</span>
<a name="l00282"></a>00282 <span class="comment"> * object.</span>
<a name="l00283"></a>00283 <span class="comment"> */</span>
<a name="l00284"></a><a class="code" href="structnl__object__ops.html#a38797e8754a31bb259120ef9101bbb0a">00284</a> void (*<a class="code" href="structnl__object__ops.html#a38797e8754a31bb259120ef9101bbb0a" title="Destructor function.">oo_free_data</a>)(<span class="keyword">struct </span>nl_object *);
<a name="l00285"></a>00285 <span class="comment"></span>
<a name="l00286"></a>00286 <span class="comment"> /**</span>
<a name="l00287"></a>00287 <span class="comment"> * Cloning function</span>
<a name="l00288"></a>00288 <span class="comment"> *</span>
<a name="l00289"></a>00289 <span class="comment"> * Will be called when an object needs to be cloned. Please</span>
<a name="l00290"></a>00290 <span class="comment"> * note that the generic object code will make an exact</span>
<a name="l00291"></a>00291 <span class="comment"> * copy of the object first, therefore you only need to take</span>
<a name="l00292"></a>00292 <span class="comment"> * care of members which require reference counting etc.</span>
<a name="l00293"></a>00293 <span class="comment"> *</span>
<a name="l00294"></a>00294 <span class="comment"> * May return a negative error code to abort cloning.</span>
<a name="l00295"></a>00295 <span class="comment"> */</span>
<a name="l00296"></a><a class="code" href="structnl__object__ops.html#ada92030f50d49c033007952393c8d9b2">00296</a> int (*<a class="code" href="structnl__object__ops.html#ada92030f50d49c033007952393c8d9b2" title="Cloning function.">oo_clone</a>)(<span class="keyword">struct </span>nl_object *, <span class="keyword">struct </span>nl_object *);
<a name="l00297"></a>00297 <span class="comment"></span>
<a name="l00298"></a>00298 <span class="comment"> /**</span>
<a name="l00299"></a>00299 <span class="comment"> * Dumping functions</span>
<a name="l00300"></a>00300 <span class="comment"> *</span>
<a name="l00301"></a>00301 <span class="comment"> * Will be called when an object is dumped. The implementations</span>
<a name="l00302"></a>00302 <span class="comment"> * have to use nl_dump(), nl_dump_line(), and nl_new_line() to</span>
<a name="l00303"></a>00303 <span class="comment"> * dump objects.</span>
<a name="l00304"></a>00304 <span class="comment"> *</span>
<a name="l00305"></a>00305 <span class="comment"> * The functions must return the number of lines printed.</span>
<a name="l00306"></a>00306 <span class="comment"> */</span>
<a name="l00307"></a><a class="code" href="structnl__object__ops.html#a0a3d28af43d7f75cda0b8cbc23ad7432">00307</a> int (*<a class="code" href="structnl__object__ops.html#a0a3d28af43d7f75cda0b8cbc23ad7432" title="Dumping functions.">oo_dump</a>[NL_DUMP_MAX+1])(<span class="keyword">struct </span>nl_object *,
<a name="l00308"></a>00308 <span class="keyword">struct </span><a class="code" href="structnl__dump__params.html" title="Dumping parameters.">nl_dump_params</a> *);
<a name="l00309"></a>00309 <span class="comment"></span>
<a name="l00310"></a>00310 <span class="comment"> /**</span>
<a name="l00311"></a>00311 <span class="comment"> * Comparison function</span>
<a name="l00312"></a>00312 <span class="comment"> *</span>
<a name="l00313"></a>00313 <span class="comment"> * Will be called when two objects of the same type are</span>
<a name="l00314"></a>00314 <span class="comment"> * compared. It takes the two objects in question, an object</span>
<a name="l00315"></a>00315 <span class="comment"> * specific bitmask defining which attributes should be</span>
<a name="l00316"></a>00316 <span class="comment"> * compared and flags to control the behaviour.</span>
<a name="l00317"></a>00317 <span class="comment"> *</span>
<a name="l00318"></a>00318 <span class="comment"> * The function must return a bitmask with the relevant bit</span>
<a name="l00319"></a>00319 <span class="comment"> * set for each attribute that mismatches.</span>
<a name="l00320"></a>00320 <span class="comment"> */</span>
<a name="l00321"></a><a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597">00321</a> int (*<a class="code" href="structnl__object__ops.html#aeabb90e7882be2af2c6e92391cce9597" title="Comparison function.">oo_compare</a>)(<span class="keyword">struct </span>nl_object *, <span class="keyword">struct </span>nl_object *,
<a name="l00322"></a>00322 uint32_t, int);
<a name="l00323"></a>00323
<a name="l00324"></a>00324
<a name="l00325"></a>00325 <span class="keywordtype">char</span> *(*oo_attrs2str)(int, <span class="keywordtype">char</span> *, size_t);
<a name="l00326"></a>00326 };
<a name="l00327"></a>00327 <span class="comment"></span>
<a name="l00328"></a>00328 <span class="comment">/** @} */</span>
<a name="l00329"></a>00329
<a name="l00330"></a>00330 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00331"></a>00331 <span class="preprocessor"></span>}
<a name="l00332"></a>00332 <span class="preprocessor">#endif</span>
<a name="l00333"></a>00333 <span class="preprocessor"></span>
<a name="l00334"></a>00334 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Mar 21 2011 for libnl by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
87b89b73c41f4440bb86afd421c7548f
>
files
>
209
