libnl  3.3.0
object.h
1 /*
2  * netlink/object.c Generic Cacheable Object
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-2012 Thomas Graf <tgraf@suug.ch>
10  */
11 
12 #ifndef NETLINK_OBJECT_H_
13 #define NETLINK_OBJECT_H_
14 
15 #include <netlink/netlink.h>
16 #include <netlink/utils.h>
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 struct nl_cache;
23 struct nl_object;
24 struct nl_object_ops;
25 
26 #define OBJ_CAST(ptr) ((struct nl_object *) (ptr))
27 
28 /* General */
29 extern struct nl_object * nl_object_alloc(struct nl_object_ops *);
30 extern int nl_object_alloc_name(const char *,
31  struct nl_object **);
32 extern void nl_object_free(struct nl_object *);
33 extern struct nl_object * nl_object_clone(struct nl_object *obj);
34 extern int nl_object_update(struct nl_object *dst,
35  struct nl_object *src);
36 extern void nl_object_get(struct nl_object *);
37 extern void nl_object_put(struct nl_object *);
38 extern int nl_object_shared(struct nl_object *);
39 extern void nl_object_dump(struct nl_object *,
40  struct nl_dump_params *);
41 extern void nl_object_dump_buf(struct nl_object *, char *, size_t);
42 extern int nl_object_identical(struct nl_object *,
43  struct nl_object *);
44 extern uint32_t nl_object_diff(struct nl_object *,
45  struct nl_object *);
46 extern uint64_t nl_object_diff64(struct nl_object *,
47  struct nl_object *);
48 extern int nl_object_match_filter(struct nl_object *,
49  struct nl_object *);
50 extern char * nl_object_attrs2str(struct nl_object *,
51  uint32_t attrs, char *buf,
52  size_t);
53 extern char * nl_object_attr_list(struct nl_object *,
54  char *, size_t);
55 extern void nl_object_keygen(struct nl_object *,
56  uint32_t *, uint32_t);
57 
58 /* Marks */
59 extern void nl_object_mark(struct nl_object *);
60 extern void nl_object_unmark(struct nl_object *);
61 extern int nl_object_is_marked(struct nl_object *);
62 
63 /* Access Functions */
64 extern int nl_object_get_refcnt(struct nl_object *);
65 extern struct nl_cache * nl_object_get_cache(struct nl_object *);
66 extern const char * nl_object_get_type(const struct nl_object *);
67 extern int nl_object_get_msgtype(const struct nl_object *);
68 struct nl_object_ops * nl_object_get_ops(const struct nl_object *);
69 uint32_t nl_object_get_id_attrs(struct nl_object *obj);
70 
71 
72 static inline void * nl_object_priv(struct nl_object *obj)
73 {
74  return obj;
75 }
76 
77 
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif
char * nl_object_attr_list(struct nl_object *, char *, size_t)
Return list of attributes present in an object.
Definition: object.c:449
struct nl_object * nl_object_alloc(struct nl_object_ops *)
Allocate a new object of kind specified by the operations handle.
Definition: object.c:54
int nl_object_alloc_name(const char *, struct nl_object **)
Allocate new object of kind specified by the name.
Definition: object.c:84
void nl_object_get(struct nl_object *)
Acquire a reference on a object.
Definition: object.c:204
int nl_object_shared(struct nl_object *)
Check whether this object is used by multiple users.
Definition: object.c:236
void nl_object_unmark(struct nl_object *)
Remove mark from object.
Definition: object.c:261
struct nl_cache * nl_object_get_cache(struct nl_object *)
Return cache the object is associated with.
Definition: object.c:502
const char * nl_object_get_type(const struct nl_object *)
Return the object&#39;s type.
Definition: object.c:515
uint32_t nl_object_get_id_attrs(struct nl_object *obj)
Return object id attribute mask.
Definition: object.c:551
uint64_t nl_object_diff64(struct nl_object *, struct nl_object *)
Compute bitmask representing difference in attribute values.
Definition: object.c:361
void nl_object_free(struct nl_object *)
Free a cacheable object.
Definition: object.c:170
void nl_object_dump(struct nl_object *, struct nl_dump_params *)
Dump this object according to the specified parameters.
Definition: object.c:288
int nl_object_get_msgtype(const struct nl_object *)
Return the netlink message type the object was derived from.
Definition: object.c:529
void nl_object_put(struct nl_object *)
Release a reference from an object.
Definition: object.c:215
struct nl_object_ops * nl_object_get_ops(const struct nl_object *)
Return object operations structure.
Definition: object.c:540
int nl_object_identical(struct nl_object *, struct nl_object *)
Check if the identifiers of two objects are identical.
Definition: object.c:313
Dumping parameters.
Definition: types.h:33
int nl_object_match_filter(struct nl_object *, struct nl_object *)
Match a filter against an object.
Definition: object.c:405
void nl_object_mark(struct nl_object *)
Add mark to object.
Definition: object.c:252
int nl_object_update(struct nl_object *dst, struct nl_object *src)
Merge a cacheable object.
Definition: object.c:154
struct nl_object * nl_object_clone(struct nl_object *obj)
Allocate a new object and copy all data from an existing object.
Definition: object.c:110
int nl_object_is_marked(struct nl_object *)
Return true if object is marked.
Definition: object.c:271
int nl_object_get_refcnt(struct nl_object *)
Return number of references held.
Definition: object.c:488
void nl_object_keygen(struct nl_object *, uint32_t *, uint32_t)
Generate object hash key.
Definition: object.c:462
char * nl_object_attrs2str(struct nl_object *, uint32_t attrs, char *buf, size_t)
Convert bitmask of attributes to a character string.
Definition: object.c:428
uint32_t nl_object_diff(struct nl_object *, struct nl_object *)
Compute 32-bit bitmask representing difference in attribute values.
Definition: object.c:385