<!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/handlers.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/handlers.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/handlers.c default netlink message handlers</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-2006 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_HANDLERS_H_</span> <a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define NETLINK_HANDLERS_H_</span> <a name="l00014"></a>00014 <span class="preprocessor"></span> <a name="l00015"></a>00015 <span class="preprocessor">#include <stdio.h></span> <a name="l00016"></a>00016 <span class="preprocessor">#include <stdint.h></span> <a name="l00017"></a>00017 <span class="preprocessor">#include <sys/types.h></span> <a name="l00018"></a>00018 <span class="preprocessor">#include <netlink/netlink-compat.h></span> <a name="l00019"></a>00019 <span class="preprocessor">#include <netlink/netlink-kernel.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="keyword">struct </span>nl_cb; <a name="l00026"></a>00026 <span class="keyword">struct </span>nl_handle; <a name="l00027"></a>00027 <span class="keyword">struct </span>nl_msg; <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="comment"> * @name Callback Typedefs</span> <a name="l00031"></a>00031 <span class="comment"> * @{</span> <a name="l00032"></a>00032 <span class="comment"> */</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"> * nl_recvmsgs() callback for message processing customization</span> <a name="l00036"></a>00036 <span class="comment"> * @ingroup cb</span> <a name="l00037"></a>00037 <span class="comment"> * @arg msg netlink message being processed</span> <a name="l00038"></a>00038 <span class="comment"> * @arg arg argument passwd on through caller</span> <a name="l00039"></a>00039 <span class="comment"> */</span> <a name="l00040"></a><a class="code" href="group__cb.html#ga1bf04ce17ab1b5867017556a6b4ba729">00040</a> <span class="keyword">typedef</span> int (*<a class="code" href="group__cb.html#ga1bf04ce17ab1b5867017556a6b4ba729" title="nl_recvmsgs() callback for message processing customization">nl_recvmsg_msg_cb_t</a>)(<span class="keyword">struct </span>nl_msg *msg, <span class="keywordtype">void</span> *arg); <a name="l00041"></a>00041 <span class="comment"></span> <a name="l00042"></a>00042 <span class="comment">/**</span> <a name="l00043"></a>00043 <span class="comment"> * nl_recvmsgs() callback for error message processing customization</span> <a name="l00044"></a>00044 <span class="comment"> * @ingroup cb</span> <a name="l00045"></a>00045 <span class="comment"> * @arg nla netlink address of the peer</span> <a name="l00046"></a>00046 <span class="comment"> * @arg nlerr netlink error message being processed</span> <a name="l00047"></a>00047 <span class="comment"> * @arg arg argument passed on through caller</span> <a name="l00048"></a>00048 <span class="comment"> */</span> <a name="l00049"></a><a class="code" href="group__cb.html#ga2eb817b53fffe9103030c692c73b94df">00049</a> <span class="keyword">typedef</span> int (*<a class="code" href="group__cb.html#ga2eb817b53fffe9103030c692c73b94df" title="nl_recvmsgs() callback for error message processing customization">nl_recvmsg_err_cb_t</a>)(<span class="keyword">struct </span><a class="code" href="structsockaddr__nl.html" title="Netlink socket address.">sockaddr_nl</a> *nla, <a name="l00050"></a>00050 <span class="keyword">struct </span><a class="code" href="structnlmsgerr.html" title="Netlink error message.">nlmsgerr</a> *nlerr, <span class="keywordtype">void</span> *arg); <a name="l00051"></a>00051 <span class="comment"></span> <a name="l00052"></a>00052 <span class="comment">/** @} */</span> <a name="l00053"></a>00053 <span class="comment"></span> <a name="l00054"></a>00054 <span class="comment">/**</span> <a name="l00055"></a>00055 <span class="comment"> * Callback actions</span> <a name="l00056"></a>00056 <span class="comment"> * @ingroup cb</span> <a name="l00057"></a>00057 <span class="comment"> */</span> <a name="l00058"></a><a class="code" href="group__cb.html#ga0c50cb29c507b3d7e8bc7d76c74675f8">00058</a> <span class="keyword">enum</span> <a class="code" href="group__cb.html#ga0c50cb29c507b3d7e8bc7d76c74675f8" title="Callback actions.">nl_cb_action</a> {<span class="comment"></span> <a name="l00059"></a>00059 <span class="comment"> /** Proceed with wathever would come next */</span> <a name="l00060"></a><a class="code" href="group__cb.html#gga0c50cb29c507b3d7e8bc7d76c74675f8abce22d25ef3e2fed30f22f8bc27fc8f0">00060</a> <a class="code" href="group__cb.html#gga0c50cb29c507b3d7e8bc7d76c74675f8abce22d25ef3e2fed30f22f8bc27fc8f0" title="Proceed with wathever would come next.">NL_OK</a>,<span class="comment"></span> <a name="l00061"></a>00061 <span class="comment"> /** Skip this message */</span> <a name="l00062"></a><a class="code" href="group__cb.html#gga0c50cb29c507b3d7e8bc7d76c74675f8af77d78aac004c6d4bee57741d3a295ae">00062</a> <a class="code" href="group__cb.html#gga0c50cb29c507b3d7e8bc7d76c74675f8af77d78aac004c6d4bee57741d3a295ae" title="Skip this message.">NL_SKIP</a>,<span class="comment"></span> <a name="l00063"></a>00063 <span class="comment"> /** Stop parsing altogether and discard remaining messages */</span> <a name="l00064"></a><a class="code" href="group__cb.html#gga0c50cb29c507b3d7e8bc7d76c74675f8aa87c4bfa1b41e2e06286a412dc2bc17b">00064</a> <a class="code" href="group__cb.html#gga0c50cb29c507b3d7e8bc7d76c74675f8aa87c4bfa1b41e2e06286a412dc2bc17b" title="Stop parsing altogether and discard remaining messages.">NL_STOP</a>, <a name="l00065"></a>00065 }; <a name="l00066"></a>00066 <a name="l00067"></a>00067 <span class="comment">/* backwards compatibility */</span> <a name="l00068"></a>00068 <span class="preprocessor">#define NL_PROCEED NL_OK</span> <a name="l00069"></a>00069 <span class="preprocessor"></span><span class="preprocessor">#define NL_EXIT NL_STOP</span> <a name="l00070"></a>00070 <span class="preprocessor"></span><span class="comment"></span> <a name="l00071"></a>00071 <span class="comment">/**</span> <a name="l00072"></a>00072 <span class="comment"> * Callback kinds</span> <a name="l00073"></a>00073 <span class="comment"> * @ingroup cb</span> <a name="l00074"></a>00074 <span class="comment"> */</span> <a name="l00075"></a><a class="code" href="group__cb.html#gaba3fabad0c62db483941101e1a18d14d">00075</a> <span class="keyword">enum</span> <a class="code" href="group__cb.html#gaba3fabad0c62db483941101e1a18d14d" title="Callback kinds.">nl_cb_kind</a> {<span class="comment"></span> <a name="l00076"></a>00076 <span class="comment"> /** Default handlers (quiet) */</span> <a name="l00077"></a><a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14da07baae9c246d899cffd1ad49d7c001ce">00077</a> <a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14da07baae9c246d899cffd1ad49d7c001ce" title="Default handlers (quiet)">NL_CB_DEFAULT</a>,<span class="comment"></span> <a name="l00078"></a>00078 <span class="comment"> /** Verbose default handlers (error messages printed) */</span> <a name="l00079"></a><a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14dab2756e6194ec2c53efe5d111093b4375">00079</a> <a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14dab2756e6194ec2c53efe5d111093b4375" title="Verbose default handlers (error messages printed)">NL_CB_VERBOSE</a>,<span class="comment"></span> <a name="l00080"></a>00080 <span class="comment"> /** Debug handlers for debugging */</span> <a name="l00081"></a><a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14dad2ef3f2dbf45519610f72b3747eacd18">00081</a> <a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14dad2ef3f2dbf45519610f72b3747eacd18" title="Debug handlers for debugging.">NL_CB_DEBUG</a>,<span class="comment"></span> <a name="l00082"></a>00082 <span class="comment"> /** Customized handler specified by the user */</span> <a name="l00083"></a><a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14da22448271a402b4c4a55733ef4884c038">00083</a> <a class="code" href="group__cb.html#ggaba3fabad0c62db483941101e1a18d14da22448271a402b4c4a55733ef4884c038" title="Customized handler specified by the user.">NL_CB_CUSTOM</a>, <a name="l00084"></a>00084 __NL_CB_KIND_MAX, <a name="l00085"></a>00085 }; <a name="l00086"></a>00086 <a name="l00087"></a>00087 <span class="preprocessor">#define NL_CB_KIND_MAX (__NL_CB_KIND_MAX - 1)</span> <a name="l00088"></a>00088 <span class="preprocessor"></span><span class="comment"></span> <a name="l00089"></a>00089 <span class="comment">/**</span> <a name="l00090"></a>00090 <span class="comment"> * Callback types</span> <a name="l00091"></a>00091 <span class="comment"> * @ingroup cb</span> <a name="l00092"></a>00092 <span class="comment"> */</span> <a name="l00093"></a><a class="code" href="group__cb.html#ga3f60f4515ada826d2bf16395ee722363">00093</a> <span class="keyword">enum</span> <a class="code" href="group__cb.html#ga3f60f4515ada826d2bf16395ee722363" title="Callback types.">nl_cb_type</a> {<span class="comment"></span> <a name="l00094"></a>00094 <span class="comment"> /** Message is valid */</span> <a name="l00095"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a6e1f371d16186a460f25ea9bb1306c47">00095</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a6e1f371d16186a460f25ea9bb1306c47" title="Message is valid.">NL_CB_VALID</a>,<span class="comment"></span> <a name="l00096"></a>00096 <span class="comment"> /** Last message in a series of multi part messages received */</span> <a name="l00097"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a044400d11ee451b692333a0d95cf3d32">00097</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a044400d11ee451b692333a0d95cf3d32" title="Last message in a series of multi part messages received.">NL_CB_FINISH</a>,<span class="comment"></span> <a name="l00098"></a>00098 <span class="comment"> /** Report received that data was lost */</span> <a name="l00099"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a25c8376dc758b16bcaeb76c329719dae">00099</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a25c8376dc758b16bcaeb76c329719dae" title="Report received that data was lost.">NL_CB_OVERRUN</a>,<span class="comment"></span> <a name="l00100"></a>00100 <span class="comment"> /** Message wants to be skipped */</span> <a name="l00101"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a034ec83d5ba891deb3d3e54f9e15d3a0">00101</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a034ec83d5ba891deb3d3e54f9e15d3a0" title="Message wants to be skipped.">NL_CB_SKIPPED</a>,<span class="comment"></span> <a name="l00102"></a>00102 <span class="comment"> /** Message is an acknowledge */</span> <a name="l00103"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a8295b387c07bd076ccdee45b555f1134">00103</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a8295b387c07bd076ccdee45b555f1134" title="Message is an acknowledge.">NL_CB_ACK</a>,<span class="comment"></span> <a name="l00104"></a>00104 <span class="comment"> /** Called for every message received */</span> <a name="l00105"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a160d69995bab2c325bd25d7ee2d5292d">00105</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a160d69995bab2c325bd25d7ee2d5292d" title="Called for every message received.">NL_CB_MSG_IN</a>,<span class="comment"></span> <a name="l00106"></a>00106 <span class="comment"> /** Called for every message sent out except for nl_sendto() */</span> <a name="l00107"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a0b43ab5eccae67470bb8ed0b09e2f650">00107</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363a0b43ab5eccae67470bb8ed0b09e2f650" title="Called for every message sent out except for nl_sendto()">NL_CB_MSG_OUT</a>,<span class="comment"></span> <a name="l00108"></a>00108 <span class="comment"> /** Message is malformed and invalid */</span> <a name="l00109"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363af5b5448bf122561db88d510e5d153a8a">00109</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363af5b5448bf122561db88d510e5d153a8a" title="Message is malformed and invalid.">NL_CB_INVALID</a>,<span class="comment"></span> <a name="l00110"></a>00110 <span class="comment"> /** Called instead of internal sequence number checking */</span> <a name="l00111"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363ae73e906b997f00e8911b09e0f254364d">00111</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363ae73e906b997f00e8911b09e0f254364d" title="Called instead of internal sequence number checking.">NL_CB_SEQ_CHECK</a>,<span class="comment"></span> <a name="l00112"></a>00112 <span class="comment"> /** Sending of an acknowledge message has been requested */</span> <a name="l00113"></a><a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363af2930b7775d1444c359cd11d7ce2cd02">00113</a> <a class="code" href="group__cb.html#gga3f60f4515ada826d2bf16395ee722363af2930b7775d1444c359cd11d7ce2cd02" title="Sending of an acknowledge message has been requested.">NL_CB_SEND_ACK</a>, <a name="l00114"></a>00114 __NL_CB_TYPE_MAX, <a name="l00115"></a>00115 }; <a name="l00116"></a>00116 <a name="l00117"></a>00117 <span class="preprocessor">#define NL_CB_TYPE_MAX (__NL_CB_TYPE_MAX - 1)</span> <a name="l00118"></a>00118 <span class="preprocessor"></span> <a name="l00119"></a>00119 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cb * <a class="code" href="group__cb.html#gaea2e77b9e3c0c875f44aec236d9a1009" title="Allocate a new callback handle.">nl_cb_alloc</a>(<span class="keyword">enum</span> <a class="code" href="group__cb.html#gaba3fabad0c62db483941101e1a18d14d" title="Callback kinds.">nl_cb_kind</a>); <a name="l00120"></a>00120 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cb * <a class="code" href="group__cb.html#gad438f32bb0f83bd1d15f53e9525f1f65" title="Clone an existing callback handle.">nl_cb_clone</a>(<span class="keyword">struct</span> nl_cb *); <a name="l00121"></a>00121 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cb * nl_cb_get(<span class="keyword">struct</span> nl_cb *); <a name="l00122"></a>00122 <span class="keyword">extern</span> <span class="keywordtype">void</span> nl_cb_put(<span class="keyword">struct</span> nl_cb *); <a name="l00123"></a>00123 <a name="l00124"></a>00124 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__cb.html#gabe7b2516f28fbb8bb9c5b1ea2dfaf1d3" title="Set up a callback.">nl_cb_set</a>(<span class="keyword">struct</span> nl_cb *, <span class="keyword">enum</span> <a class="code" href="group__cb.html#ga3f60f4515ada826d2bf16395ee722363" title="Callback types.">nl_cb_type</a>, <span class="keyword">enum</span> <a class="code" href="group__cb.html#gaba3fabad0c62db483941101e1a18d14d" title="Callback kinds.">nl_cb_kind</a>, <a name="l00125"></a>00125 <a class="code" href="group__cb.html#ga1bf04ce17ab1b5867017556a6b4ba729" title="nl_recvmsgs() callback for message processing customization">nl_recvmsg_msg_cb_t</a>, <span class="keywordtype">void</span> *); <a name="l00126"></a>00126 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__cb.html#gad6be5a06f81ed1a411560732c7f3f698" title="Set up a all callbacks.">nl_cb_set_all</a>(<span class="keyword">struct</span> nl_cb *, <span class="keyword">enum</span> <a class="code" href="group__cb.html#gaba3fabad0c62db483941101e1a18d14d" title="Callback kinds.">nl_cb_kind</a>, <a name="l00127"></a>00127 <a class="code" href="group__cb.html#ga1bf04ce17ab1b5867017556a6b4ba729" title="nl_recvmsgs() callback for message processing customization">nl_recvmsg_msg_cb_t</a>, <span class="keywordtype">void</span> *); <a name="l00128"></a>00128 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__cb.html#gafeb5477254d93d0a8a8c991f3dbacd77" title="Set up an error callback.">nl_cb_err</a>(<span class="keyword">struct</span> nl_cb *, <span class="keyword">enum</span> <a class="code" href="group__cb.html#gaba3fabad0c62db483941101e1a18d14d" title="Callback kinds.">nl_cb_kind</a>, <a class="code" href="group__cb.html#ga2eb817b53fffe9103030c692c73b94df" title="nl_recvmsgs() callback for error message processing customization">nl_recvmsg_err_cb_t</a>, <a name="l00129"></a>00129 <span class="keywordtype">void</span> *); <a name="l00130"></a>00130 <a name="l00131"></a>00131 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="group__cb.html#gaf3ce421f4b00617510d6e565207d147a" title="Overwrite internal calls to nl_recvmsgs()">nl_cb_overwrite_recvmsgs</a>(<span class="keyword">struct</span> nl_cb *, <a name="l00132"></a>00132 <span class="keywordtype">int</span> (*func)(<span class="keyword">struct</span> nl_handle *, <a name="l00133"></a>00133 <span class="keyword">struct</span> nl_cb *)); <a name="l00134"></a>00134 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="group__cb.html#ga0d2f92ed95a6d7a5f915e128d1643e24" title="Overwrite internal calls to nl_recv()">nl_cb_overwrite_recv</a>(<span class="keyword">struct</span> nl_cb *, <a name="l00135"></a>00135 <span class="keywordtype">int</span> (*func)(<span class="keyword">struct</span> nl_handle *, <a name="l00136"></a>00136 <span class="keyword">struct</span> <a class="code" href="structsockaddr__nl.html" title="Netlink socket address.">sockaddr_nl</a> *, <a name="l00137"></a>00137 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **, <a name="l00138"></a>00138 <span class="keyword">struct</span> ucred **)); <a name="l00139"></a>00139 <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="group__cb.html#gaba43d04d5b6419e4e5563c8c64856a39" title="Overwrite internal calls to nl_send()">nl_cb_overwrite_send</a>(<span class="keyword">struct</span> nl_cb *, <a name="l00140"></a>00140 <span class="keywordtype">int</span> (*func)(<span class="keyword">struct</span> nl_handle *, <a name="l00141"></a>00141 <span class="keyword">struct</span> nl_msg *)); <a name="l00142"></a>00142 <a name="l00143"></a>00143 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00144"></a>00144 <span class="preprocessor"></span>} <a name="l00145"></a>00145 <span class="preprocessor">#endif</span> <a name="l00146"></a>00146 <span class="preprocessor"></span> <a name="l00147"></a>00147 <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>