Object
[Cache]

Data Structures
struct	nl_derived_object
Modules
	Object API

---

Function Documentation

struct nl_object* nl_object_alloc

(

struct nl_object_ops *

ops

)

[read]

Parameters:

ops

cache operations handle

Returns:

The new object or NULL

Definition at line 42 of file object.c.

References nl_object_ops::oo_constructor, and nl_object_ops::oo_size.

Referenced by nl_object_alloc_name(), and nl_object_clone().

struct nl_object* nl_object_alloc_name

(

const char *

kind

)

[read]

Parameters:

kind

name of object type

Returns:

The new object or nULL

Definition at line 72 of file object.c.

References nl_cache_ops::co_obj_ops, nl_cache_ops_lookup(), and nl_object_alloc().

struct nl_object* nl_object_clone

(

struct nl_object *

obj

)

[read]

Parameters:

obj

object to inherite data from

Returns:

The new object or NULL.

Definition at line 95 of file object.c.

References nl_object_alloc(), nl_object_free(), nl_object_ops::oo_clone, nl_object_ops::oo_free_data, and nl_object_ops::oo_size.

Referenced by nl_cache_add().

void nl_object_free

(

struct nl_object *

obj

)

Parameters:

obj

object to free

Returns:

0 or a negative error code.

Definition at line 133 of file object.c.

References nl_cache_remove(), and nl_object_ops::oo_free_data.

Referenced by nl_object_clone(), and nl_object_put().

void nl_object_get

(

struct nl_object *

obj

)

Parameters:

obj

object to acquire reference from

Definition at line 162 of file object.c.

Referenced by genl_ctrl_search(), genl_ctrl_search_by_name(), nl_cache_add(), nl_cache_move(), nl_cache_search(), rtnl_link_get(), rtnl_link_get_by_name(), rtnl_neigh_get(), rtnl_neightbl_get(), rtnl_qdisc_get(), and rtnl_qdisc_get_by_parent().

void nl_object_put

(

struct nl_object *

obj

)

Parameters:

obj

object to release reference from

Definition at line 173 of file object.c.

References nl_object_free().

Referenced by nl_cache_remove().

int nl_object_shared

(

struct nl_object *

obj

)

Parameters:

obj

object to check

Returns:

true or false

Definition at line 194 of file object.c.

void nl_object_mark

(

struct nl_object *

obj

)

Parameters:

obj

Object to mark

Definition at line 210 of file object.c.

Referenced by nl_cache_mark_all().

void nl_object_unmark

(

struct nl_object *

obj

)

Parameters:

obj

Object to unmark

Definition at line 219 of file object.c.

int nl_object_is_marked

(

struct nl_object *

obj

)

Parameters:

obj

Object to check

Returns:

true if object is marked, otherwise false

Definition at line 229 of file object.c.

void nl_object_dump	(	struct nl_object *	obj,
		struct nl_dump_params *	params
	)

Parameters:

	obj	object to dump
	params	dumping parameters

Definition at line 246 of file object.c.

int nl_object_identical	(	struct nl_object *	a,
		struct nl_object *	b
	)

Parameters:

	a	an object
	b	another object of same type

Returns:

true if both objects have equal identifiers, otherwise false.

Definition at line 258 of file object.c.

References nl_object_ops::oo_compare, and nl_object_ops::oo_id_attrs.

Referenced by nl_cache_search().

uint32_t nl_object_diff	(	struct nl_object *	a,
		struct nl_object *	b
	)

Parameters:

	a	an object
	b	another object of same type

The bitmask returned is specific to an object type, each bit set represents an attribute which mismatches in either of the two objects. Unavailability of an attribute in one object and presence in the other is regarded a mismatch as well.

Returns:

Bitmask describing differences or 0 if they are completely identical.

Definition at line 294 of file object.c.

References nl_object_ops::oo_compare.

int nl_object_match_filter	(	struct nl_object *	obj,
		struct nl_object *	filter
	)

Parameters:

	obj	object to check
	filter	object of same type acting as filter

Returns:

1 if the object matches the filter or 0 if no filter procedure is available or if the filter does not match.

Definition at line 313 of file object.c.

References nl_object_ops::oo_compare.

Referenced by nl_cache_dump_filter(), nl_cache_foreach_filter(), nl_cache_nitems_filter(), and nl_cache_subset().

char* nl_object_attrs2str	(	struct nl_object *	obj,
		uint32_t	attrs,
		char *	buf,
		size_t	len
	)

Parameters:

	obj	object of same type as attribute bitmask
	attrs	bitmask of attribute types
	buf	destination buffer
	len	length of destination buffer

Converts the bitmask of attribute types into a list of attribute names separated by comas.

Returns:

destination buffer.

Definition at line 336 of file object.c.

References nl_object_ops::oo_attrs2str.

Referenced by nl_object_attr_list().

char* nl_object_attr_list	(	struct nl_object *	obj,
		char *	buf,
		size_t	len
	)

Parameters:

	obj	an object
	buf	destination buffer
	len	length of destination buffer

Returns:

destination buffer.

Definition at line 357 of file object.c.

References nl_object_attrs2str().