diff options
author | Thomas Graf <tgraf@redhat.com> | 2012-04-22 14:36:01 +0200 |
---|---|---|
committer | Thomas Graf <tgraf@redhat.com> | 2012-04-22 14:36:01 +0200 |
commit | 2e23491c5017e578b34341fe0d0197c7ee1883cc (patch) | |
tree | 145d4c236d4d71ace652bb9d80a42b0cc4353022 | |
parent | 8bbcd2208e366f8d8a708d56974966dd7651ffdf (diff) | |
download | libnl-2e23491c5017e578b34341fe0d0197c7ee1883cc.tar.gz |
cache: improve documentation of co_event_filter
-rw-r--r-- | include/netlink/cache-api.h | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/include/netlink/cache-api.h b/include/netlink/cache-api.h index 1b3d099..c1c3aaa 100644 --- a/include/netlink/cache-api.h +++ b/include/netlink/cache-api.h @@ -202,9 +202,26 @@ struct nl_cache_ops struct nlmsghdr *, struct nl_parser_param *); /** - * Called whenever a notification has been parsed into an object and - * is considered for inclusion into a cache. Must return NL_SKIP if - * the object should not be included in the cache. + * The function registered under this callback is called after a + * netlink notification associated with this cache type has been + * parsed into an object and is being considered for inclusio into + * the specified cache. + * + * The purpose of this function is to filter out notifications + * which should be ignored when updating caches. + * + * The function must return NL_SKIP to prevent the object from + * being included, or NL_OK to include it. + * + * @code + * int my_filter(struct nl_cache *cache, struct nl_object *obj) + * { + * if (reason_to_not_include_obj(obj)) + * return NL_SKIP; + * + * return NL_OK; + * } + * @endcode */ int (*co_event_filter)(struct nl_cache *, struct nl_object *obj); |