Neighbour Tables
[Routing Netlink]

Allocation/Freeing
struct rtnl_neightbl *	rtnl_neightbl_alloc (void)
void	rtnl_neightbl_put (struct rtnl_neightbl *neightbl)
Neighbour Table Cache Management
struct nl_cache *	rtnl_neightbl_alloc_cache (struct nl_handle *handle)
	Build a neighbour table cache including all neighbour tables currently configured in the kernel.
struct rtnl_neightbl *	rtnl_neightbl_get (struct nl_cache *cache, const char *name, int ifindex)
	Lookup neighbour table by name and optional interface index.
Neighbour Table Modifications
struct nl_msg *	rtnl_neightbl_build_change_request (struct rtnl_neightbl *old, struct rtnl_neightbl *tmpl)
	Builds a netlink change request message to change neighbour table attributes.
int	rtnl_neightbl_change (struct nl_handle *handle, struct rtnl_neightbl *old, struct rtnl_neightbl *tmpl)
	Change neighbour table attributes.
Attribute Modification
void	rtnl_neightbl_set_family (struct rtnl_neightbl *ntbl, int family)
void	rtnl_neightbl_set_gc_interval (struct rtnl_neightbl *ntbl, uint64_t ms)
void	rtnl_neightbl_set_gc_tresh1 (struct rtnl_neightbl *ntbl, int thresh)
void	rtnl_neightbl_set_gc_tresh2 (struct rtnl_neightbl *ntbl, int thresh)
void	rtnl_neightbl_set_gc_tresh3 (struct rtnl_neightbl *ntbl, int thresh)
void	rtnl_neightbl_set_name (struct rtnl_neightbl *ntbl, const char *name)
void	rtnl_neightbl_set_dev (struct rtnl_neightbl *ntbl, int ifindex)
void	rtnl_neightbl_set_queue_len (struct rtnl_neightbl *ntbl, int len)
	Set the queue length for pending requests of a neighbour table to the specified value.
void	rtnl_neightbl_set_proxy_queue_len (struct rtnl_neightbl *ntbl, int len)
	Set the queue length for delay proxy arp requests of a neighbour table to the specified value.
void	rtnl_neightbl_set_app_probes (struct rtnl_neightbl *ntbl, int probes)
	Set the number of application probes of a neighbour table to the specified value.
void	rtnl_neightbl_set_ucast_probes (struct rtnl_neightbl *ntbl, int probes)
	Set the number of unicast probes of a neighbour table to the specified value.
void	rtnl_neightbl_set_mcast_probes (struct rtnl_neightbl *ntbl, int probes)
	Set the number of multicast probes of a neighbour table to the specified value.
void	rtnl_neightbl_set_base_reachable_time (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the base reachable time of a neighbour table to the specified value.
void	rtnl_neightbl_set_retrans_time (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the retransmit time of a neighbour table to the specified value.
void	rtnl_neightbl_set_gc_stale_time (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the gc stale time of a neighbour table to the specified value.
void	rtnl_neightbl_set_delay_probe_time (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the first probe delay time of a neighbour table to the specified value.
void	rtnl_neightbl_set_anycast_delay (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the anycast delay of a neighbour table to the specified value.
void	rtnl_neightbl_set_proxy_delay (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the proxy delay of a neighbour table to the specified value.
void	rtnl_neightbl_set_locktime (struct rtnl_neightbl *ntbl, uint64_t ms)
	Set the locktime of a neighbour table to the specified value.

---

Function Documentation

struct nl_cache* rtnl_neightbl_alloc_cache

(

struct nl_handle *

handle

)

[read]

Parameters:

handle

netlink handle

Allocates a new neighbour table cache, initializes it properly and updates it to include all neighbour tables currently configured in the kernel.

Note:

The caller is responsible for destroying and freeing the cache after using it.

Returns:

The new cache or NULL if an error occured.

Definition at line 407 of file neightbl.c.

References nl_cache_alloc(), nl_cache_free(), and nl_cache_refill().

struct rtnl_neightbl* rtnl_neightbl_get	(	struct nl_cache *	cache,
		const char *	name,
		int	ifindex
	)			[read]

Parameters:

	cache	neighbour table cache
	name	name of table
	ifindex	optional interface index

Looks up the neighbour table matching the specified name and optionally the specified ifindex to retrieve device specific parameter sets.

Returns:

ptr to neighbour table inside the cache or NULL if no match was found.

Definition at line 436 of file neightbl.c.

References nl_object_get().

struct nl_msg* rtnl_neightbl_build_change_request	(	struct rtnl_neightbl *	old,
		struct rtnl_neightbl *	tmpl
	)			[read]

Parameters:

	old	neighbour table to change
	tmpl	template with requested changes

Builds a new netlink message requesting a change of neighbour table attributes. The netlink message header isn't fully equipped with all relevant fields and must be sent out via nl_send_auto_complete() or supplemented as needed. old must point to a neighbour table currently configured in the kernel and tmpl must contain the attributes to be changed set via rtnl_neightbl_set_* functions.

Returns:

New netlink message

Definition at line 478 of file neightbl.c.

References nla_put_nested(), nla_put_string(), nla_put_u32(), nla_put_u64(), nlmsg_alloc(), nlmsg_alloc_simple(), nlmsg_append(), and nlmsg_free().

Referenced by rtnl_neightbl_change().

int rtnl_neightbl_change	(	struct nl_handle *	handle,
		struct rtnl_neightbl *	old,
		struct rtnl_neightbl *	tmpl
	)

Parameters:

	handle	netlink handle
	old	neighbour table to be changed
	tmpl	template with requested changes

Builds a new netlink message by calling rtnl_neightbl_build_change_request(), sends the request to the kernel and waits for the next ACK to be received, i.e. blocks until the request has been processed.

Returns:

0 on success or a negative error code

Definition at line 578 of file neightbl.c.

References nl_send_auto_complete(), nl_wait_for_ack(), nlmsg_free(), and rtnl_neightbl_build_change_request().

void rtnl_neightbl_set_queue_len	(	struct rtnl_neightbl *	ntbl,
		int	len
	)

Parameters:

	ntbl	neighbour table to change
	len	new queue len

Definition at line 648 of file neightbl.c.

void rtnl_neightbl_set_proxy_queue_len	(	struct rtnl_neightbl *	ntbl,
		int	len
	)

Parameters:

	ntbl	neighbour table to change
	len	new queue len

Definition at line 660 of file neightbl.c.

void rtnl_neightbl_set_app_probes	(	struct rtnl_neightbl *	ntbl,
		int	probes
	)

Parameters:

	ntbl	neighbour table to change
	probes	new probes value

Definition at line 672 of file neightbl.c.

void rtnl_neightbl_set_ucast_probes	(	struct rtnl_neightbl *	ntbl,
		int	probes
	)

Parameters:

	ntbl	neighbour table to change
	probes	new probes value

Definition at line 684 of file neightbl.c.

void rtnl_neightbl_set_mcast_probes	(	struct rtnl_neightbl *	ntbl,
		int	probes
	)

Parameters:

	ntbl	neighbour table to change
	probes	new probes value

Definition at line 696 of file neightbl.c.

void rtnl_neightbl_set_base_reachable_time	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new base reachable time in milliseconds

Definition at line 708 of file neightbl.c.

void rtnl_neightbl_set_retrans_time	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new retransmit time

Definition at line 721 of file neightbl.c.

void rtnl_neightbl_set_gc_stale_time	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new gc stale time in milliseconds

Definition at line 733 of file neightbl.c.

void rtnl_neightbl_set_delay_probe_time	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new first probe delay time in milliseconds

Definition at line 745 of file neightbl.c.

void rtnl_neightbl_set_anycast_delay	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new anycast delay in milliseconds

Definition at line 757 of file neightbl.c.

void rtnl_neightbl_set_proxy_delay	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new proxy delay in milliseconds

Definition at line 769 of file neightbl.c.

void rtnl_neightbl_set_locktime	(	struct rtnl_neightbl *	ntbl,
		uint64_t	ms
	)

Parameters:

	ntbl	neighbour table to change
	ms	new locktime in milliseconds

Definition at line 781 of file neightbl.c.