diff options
author | Thomas Graf <tgraf@suug.ch> | 2011-03-21 23:40:26 (GMT) |
---|---|---|
committer | Thomas Graf <tgraf@suug.ch> | 2011-03-21 23:40:26 (GMT) |
commit | c1073d6172223be9837141da149c8876ce46884b (patch) | |
tree | b1bfcc1f25a97337fd60aa0ef7052132b756be86 /include | |
parent | 55f803c64df6f742a00dd45a24a3d51f87f6365b (diff) | |
download | libnl-c1073d6172223be9837141da149c8876ce46884b.zip libnl-c1073d6172223be9837141da149c8876ce46884b.tar.gz libnl-c1073d6172223be9837141da149c8876ce46884b.tar.bz2 |
Documentation updates
Mostly killing doxygen warnings, some doc updates to caching
Diffstat (limited to 'include')
-rw-r--r-- | include/netlink/cache-api.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/include/netlink/cache-api.h b/include/netlink/cache-api.h index 22fc449..efae2ed 100644 --- a/include/netlink/cache-api.h +++ b/include/netlink/cache-api.h @@ -151,21 +151,40 @@ struct nl_af_group #define END_OF_GROUP_LIST AF_UNSPEC, 0 +/** + * Parser parameters + * + * This structure is used to configure what kind of parser to use + * when parsing netlink messages to create objects. + */ struct nl_parser_param { + /** Function to parse netlink messages into objects */ int (*pp_cb)(struct nl_object *, struct nl_parser_param *); + + /** Arbitary argument to be passed to the parser */ void * pp_arg; }; /** * Cache Operations + * + * This structure defines the characterstics of a cache type. It contains + * pointers to functions which implement the specifics of the object type + * the cache can hold. */ struct nl_cache_ops { + /** Name of cache type (must be unique) */ char * co_name; + /** Size of family specific netlink header */ int co_hdrsize; + + /** Netlink protocol */ int co_protocol; + + /** Group definition */ struct nl_af_group * co_groups; /** @@ -182,11 +201,16 @@ struct nl_cache_ops int (*co_msg_parser)(struct nl_cache_ops *, struct sockaddr_nl *, struct nlmsghdr *, struct nl_parser_param *); + /** Object operations */ struct nl_object_ops * co_obj_ops; + /** Internal, do not touch! */ struct nl_cache_ops *co_next; + struct nl_cache *co_major_cache; struct genl_ops * co_genl; + + /* Message type definition */ struct nl_msgtype co_msgtypes[]; }; |