This commit was generated by cvs2svn to compensate for changes in r786,

[libnl.git] / include / netlink / msg.h

diff --git a/include/netlink/msg.h b/include/netlink/msg.h
new file mode 100644 (file)
index 0000000..fa96ccb
--- /dev/null
+++ b/include/netlink/msg.h
@@ -0,0 +1,106 @@
+/*
+ * netlink/msg.c               Netlink Messages Interface
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation version 2.1
+ *     of the License.
+ *
+ * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch>
+ */
+
+#ifndef NETLINK_MSG_H_
+#define NETLINK_MSG_H_
+
+#include <netlink/netlink.h>
+#include <netlink/object.h>
+#include <netlink/attr.h>
+
+struct nl_msg;
+struct nl_tree;
+struct ucred;
+
+/* size calculations */
+extern int               nlmsg_msg_size(int);
+extern int               nlmsg_total_size(int);
+extern int               nlmsg_padlen(int);
+
+/* payload access */
+extern void *            nlmsg_data(const struct nlmsghdr *);
+extern int               nlmsg_len(const struct nlmsghdr *);
+extern void *            nlmsg_tail(const struct nlmsghdr *);
+
+/* attribute access */
+extern struct nlattr *   nlmsg_attrdata(const struct nlmsghdr *, int);
+extern int               nlmsg_attrlen(const struct nlmsghdr *, int);
+
+/* message parsing */
+extern int               nlmsg_ok(const struct nlmsghdr *, int);
+extern struct nlmsghdr *  nlmsg_next(struct nlmsghdr *, int *);
+extern int               nlmsg_parse(struct nlmsghdr *, int, struct nlattr **,
+                                     int, struct nla_policy *);
+extern struct nlattr *   nlmsg_find_attr(struct nlmsghdr *, int, int);
+extern int               nlmsg_validate(struct nlmsghdr *, int, int,
+                                        struct nla_policy *);
+
+extern struct nl_msg *   nlmsg_new(void);
+extern struct nl_msg *   nlmsg_build(struct nlmsghdr *);
+extern struct nl_msg *   nlmsg_build_simple(int, int);
+extern struct nl_msg *   nlmsg_build_no_hdr(void);
+extern struct nl_msg *   nlmsg_convert(struct nlmsghdr *);
+extern int               nlmsg_append(struct nl_msg *, void *, size_t, int);
+
+extern struct nlmsghdr *  nlmsg_hdr(struct nl_msg *);
+extern void              nlmsg_free(struct nl_msg *);
+
+/* attribute modification */
+extern void              nlmsg_set_proto(struct nl_msg *, int);
+extern int               nlmsg_get_proto(struct nl_msg *);
+extern void              nlmsg_set_src(struct nl_msg *, struct sockaddr_nl *);
+extern struct sockaddr_nl *nlmsg_get_src(struct nl_msg *);
+extern void              nlmsg_set_dst(struct nl_msg *, struct sockaddr_nl *);
+extern struct sockaddr_nl *nlmsg_get_dst(struct nl_msg *);
+extern void              nlmsg_set_creds(struct nl_msg *, struct ucred *);
+extern struct ucred *    nlmsg_get_creds(struct nl_msg *);
+
+extern char *            nl_nlmsgtype2str(int, char *, size_t);
+extern int               nl_str2nlmsgtype(const char *);
+
+extern char *            nl_nlmsg_flags2str(int, char *, size_t);
+
+extern int               nl_msg_parse(struct nl_msg *,
+                                      void (*cb)(struct nl_object *, void *),
+                                      void *);
+
+/**
+ * @name Iterators
+ * @{
+ */
+
+/**
+ * @ingroup msg
+ * Iterate over a stream of attributes in a message
+ * @arg pos    loop counter, set to current attribute
+ * @arg nlh    netlink message header
+ * @arg hdrlen length of family header
+ * @arg rem    initialized to len, holds bytes currently remaining in stream
+ */
+#define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \
+       nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \
+                         nlmsg_attrlen(nlh, hdrlen), rem)
+
+/**
+ * Iterate over a stream of messages
+ * @arg pos    loop counter, set to current message
+ * @arg head   head of message stream
+ * @arg len    length of message stream
+ * @arg rem    initialized to len, holds bytes currently remaining in stream
+ */
+#define nlmsg_for_each_msg(pos, head, len, rem) \
+       for (pos = head, rem = len; \
+            nlmsg_ok(pos, rem); \
+            pos = nlmsg_next(pos, &(rem)))
+
+/** @} */
+
+#endif