add libnl-tiny as a small replacement for libnl with only genl support included
[openwrt.git] / package / libnl-tiny / src / include / netlink / cache.h
1 /*
2  * netlink/cache.h              Caching Module
3  *
4  *      This library is free software; you can redistribute it and/or
5  *      modify it under the terms of the GNU Lesser General Public
6  *      License as published by the Free Software Foundation version 2.1
7  *      of the License.
8  *
9  * Copyright (c) 2003-2008 Thomas Graf <tgraf@suug.ch>
10  */
11
12 #ifndef NETLINK_CACHE_H_
13 #define NETLINK_CACHE_H_
14
15 #include <netlink/netlink.h>
16 #include <netlink/msg.h>
17 #include <netlink/utils.h>
18 #include <netlink/object.h>
19 #include <netlink/cache-api.h>
20
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24
25 struct nl_cache;
26
27 typedef void (*change_func_t)(struct nl_cache *, struct nl_object *, int);
28
29 /* Access Functions */
30 extern int                      nl_cache_nitems(struct nl_cache *);
31 extern int                      nl_cache_nitems_filter(struct nl_cache *,
32                                                        struct nl_object *);
33 extern struct nl_cache_ops *    nl_cache_get_ops(struct nl_cache *);
34 extern struct nl_object *       nl_cache_get_first(struct nl_cache *);
35 extern struct nl_object *       nl_cache_get_last(struct nl_cache *);
36 extern struct nl_object *       nl_cache_get_next(struct nl_object *);
37 extern struct nl_object *       nl_cache_get_prev(struct nl_object *);
38
39 extern struct nl_cache *        nl_cache_alloc(struct nl_cache_ops *);
40 extern int                      nl_cache_alloc_and_fill(struct nl_cache_ops *,
41                                                         struct nl_sock *,
42                                                         struct nl_cache **);
43 extern int                      nl_cache_alloc_name(const char *,
44                                                     struct nl_cache **);
45 extern struct nl_cache *        nl_cache_subset(struct nl_cache *,
46                                                 struct nl_object *);
47 extern void                     nl_cache_clear(struct nl_cache *);
48 extern void                     nl_cache_free(struct nl_cache *);
49
50 /* Cache modification */
51 extern int                      nl_cache_add(struct nl_cache *,
52                                              struct nl_object *);
53 extern int                      nl_cache_parse_and_add(struct nl_cache *,
54                                                        struct nl_msg *);
55 extern void                     nl_cache_remove(struct nl_object *);
56 extern int                      nl_cache_refill(struct nl_sock *,
57                                                 struct nl_cache *);
58 extern int                      nl_cache_pickup(struct nl_sock *,
59                                                 struct nl_cache *);
60 extern int                      nl_cache_resync(struct nl_sock *,
61                                                 struct nl_cache *,
62                                                 change_func_t);
63 extern int                      nl_cache_include(struct nl_cache *,
64                                                  struct nl_object *,
65                                                  change_func_t);
66
67 /* General */
68 extern int                      nl_cache_is_empty(struct nl_cache *);
69 extern void                     nl_cache_mark_all(struct nl_cache *);
70
71 /* Dumping */
72 extern void                     nl_cache_dump(struct nl_cache *,
73                                               struct nl_dump_params *);
74 extern void                     nl_cache_dump_filter(struct nl_cache *,
75                                                      struct nl_dump_params *,
76                                                      struct nl_object *);
77
78 /* Iterators */
79 extern void                     nl_cache_foreach(struct nl_cache *,
80                                                  void (*cb)(struct nl_object *,
81                                                             void *),
82                                                  void *arg);
83 extern void                     nl_cache_foreach_filter(struct nl_cache *,
84                                                         struct nl_object *,
85                                                         void (*cb)(struct
86                                                                    nl_object *,
87                                                                    void *),
88                                                         void *arg);
89
90 /* --- cache management --- */
91
92 /* Cache type management */
93 extern struct nl_cache_ops *    nl_cache_ops_lookup(const char *);
94 extern struct nl_cache_ops *    nl_cache_ops_associate(int, int);
95 extern struct nl_msgtype *      nl_msgtype_lookup(struct nl_cache_ops *, int);
96 extern void                     nl_cache_ops_foreach(void (*cb)(struct nl_cache_ops *, void *), void *);
97 extern int                      nl_cache_mngt_register(struct nl_cache_ops *);
98 extern int                      nl_cache_mngt_unregister(struct nl_cache_ops *);
99
100 /* Global cache provisioning/requiring */
101 extern void                     nl_cache_mngt_provide(struct nl_cache *);
102 extern void                     nl_cache_mngt_unprovide(struct nl_cache *);
103 extern struct nl_cache *        nl_cache_mngt_require(const char *);
104
105 struct nl_cache_mngr;
106
107 #define NL_AUTO_PROVIDE         1
108
109 extern int                      nl_cache_mngr_alloc(struct nl_sock *,
110                                                     int, int,
111                                                     struct nl_cache_mngr **);
112 extern int                      nl_cache_mngr_add(struct nl_cache_mngr *,
113                                                   const char *,
114                                                   change_func_t,
115                                                   struct nl_cache **);
116 extern int                      nl_cache_mngr_get_fd(struct nl_cache_mngr *);
117 extern int                      nl_cache_mngr_poll(struct nl_cache_mngr *,
118                                                    int);
119 extern int                      nl_cache_mngr_data_ready(struct nl_cache_mngr *);
120 extern void                     nl_cache_mngr_free(struct nl_cache_mngr *);
121
122 #ifdef __cplusplus
123 }
124 #endif
125
126 #endif