DODAG-related functions for RPL. More...

Detailed Description

DODAG-related functions for RPL.

Header file, which defines all public known DODAG-related functions for RPL.

Author: Eric Engel eric..nosp@m.enge.nosp@m.l@fu-.nosp@m.berl.nosp@m.in.de; Cenk Gündoğan cnkgn.nosp@m.dgn@.nosp@m.gmail.nosp@m..com

Definition in file dodag.h.

#include "net/ipv6/addr.h"
#include "trickle.h"
#include "net/gnrc/rpl.h"
#include "net/gnrc/rpl/structs.h"

Include dependency graph for dodag.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

#define	GNRC_RPL_INSTANCES_NUMOF (1)
	Number of RPL instances.

#define	GNRC_RPL_PARENTS_NUMOF (3)
	Number of RPL parents.

gnrc_rpl_instance_t	gnrc_rpl_instances [GNRC_RPL_INSTANCES_NUMOF]
	RPL instance table.

gnrc_rpl_parent_t	gnrc_rpl_parents [GNRC_RPL_PARENTS_NUMOF]
	RPL parent table.

bool	gnrc_rpl_instance_add (uint8_t instance_id, gnrc_rpl_instance_t **inst)
	Add a new RPL instance with the id `instance_id`.

bool	gnrc_rpl_instance_remove_by_id (uint8_t instance_id)
	Remove a RPL instance with the id `instance_id`.

void	gnrc_rpl_dodag_remove (gnrc_rpl_dodag_t *dodag)
	Remove a RPL DODAG with the pointer `dodag` from its instance.

void	gnrc_rpl_instance_remove (gnrc_rpl_instance_t *inst)
	Remove a RPL instance with the pointer `inst`.

gnrc_rpl_instance_t *	gnrc_rpl_instance_get (uint8_t instance_id)
	Get the RPL instance with the id `instance_id`.

bool	gnrc_rpl_dodag_init (gnrc_rpl_instance_t instance, const ipv6_addr_t dodag_id, kernel_pid_t iface)
	Initialize a new RPL DODAG with the id `dodag_id` for the instance `instance`.

void	gnrc_rpl_dodag_remove_all_parents (gnrc_rpl_dodag_t *dodag)
	Remove all parents from the `dodag`.

bool	gnrc_rpl_parent_add_by_addr (gnrc_rpl_dodag_t dodag, ipv6_addr_t addr, gnrc_rpl_parent_t **parent)
	Add a new parent with the IPv6 address `addr` to the `dodag`.

bool	gnrc_rpl_parent_remove (gnrc_rpl_parent_t *parent)
	Remove the `parent` from its DODAG.

void	gnrc_rpl_parent_update (gnrc_rpl_dodag_t dodag, gnrc_rpl_parent_t parent)
	Update a `parent` of the `dodag`.

void	gnrc_rpl_cleanup_start (gnrc_rpl_dodag_t *dodag)
	Removes the dodag state of `dodag` after CONFIG_GNRC_RPL_CLEANUP_TIME milliseconds.

void	gnrc_rpl_local_repair (gnrc_rpl_dodag_t *dodag)
	Start a local repair.

void	gnrc_rpl_leaf_operation (gnrc_rpl_dodag_t *dodag)
	Operate as leaf.

void	gnrc_rpl_router_operation (gnrc_rpl_dodag_t *dodag)
	Operate as router.

Macro Definition Documentation

◆ GNRC_RPL_INSTANCES_NUMOF

#define GNRC_RPL_INSTANCES_NUMOF (1)

Number of RPL instances.

Definition at line 38 of file dodag.h.

◆ GNRC_RPL_PARENTS_NUMOF

#define GNRC_RPL_PARENTS_NUMOF (3)

Number of RPL parents.

Definition at line 45 of file dodag.h.

Function Documentation

◆ gnrc_rpl_cleanup_start()

void gnrc_rpl_cleanup_start ( gnrc_rpl_dodag_t * dodag )

Removes the dodag state of dodag after CONFIG_GNRC_RPL_CLEANUP_TIME milliseconds.

Parameters

[in] dodag Pointer to the DODAG

◆ gnrc_rpl_dodag_init()

bool gnrc_rpl_dodag_init	(	gnrc_rpl_instance_t *	instance,
		const ipv6_addr_t *	dodag_id,
		kernel_pid_t	iface )

Initialize a new RPL DODAG with the id dodag_id for the instance instance.

Parameters

[in]	instance	Pointer to the instance to add the DODAG to
[in]	dodag_id	The DODAG-ID of the new DODAG
[in]	iface	Interface PID where the DODAG operates

Returns: true, if DODAG could be created.; false, if DODAG could not be created or exists already.

◆ gnrc_rpl_dodag_remove()

void gnrc_rpl_dodag_remove ( gnrc_rpl_dodag_t * dodag )

Remove a RPL DODAG with the pointer dodag from its instance.

Parameters

[in] dodag Pointer to the RPL DODAG to remove.

◆ gnrc_rpl_dodag_remove_all_parents()

void gnrc_rpl_dodag_remove_all_parents ( gnrc_rpl_dodag_t * dodag )

Remove all parents from the dodag.

Parameters

[in] dodag Pointer to the dodag.

◆ gnrc_rpl_instance_add()

bool gnrc_rpl_instance_add	(	uint8_t	instance_id,
		gnrc_rpl_instance_t **	inst )

Add a new RPL instance with the id instance_id.

Parameters

[in]	instance_id	The instance id of the new RPL instance.
[out]	inst	Pointer to an existing or new instance. Otherwise NULL.

Returns: true, if instance could be created.; false, if instance could not be created or exists already.

◆ gnrc_rpl_instance_get()

gnrc_rpl_instance_t * gnrc_rpl_instance_get ( uint8_t instance_id )

Get the RPL instance with the id instance_id.

Parameters

[in] instance_id The instance id of the RPL instance to get.

Returns: Pointer to the RPL instance, on success.; NULL, otherwise.

◆ gnrc_rpl_instance_remove()

void gnrc_rpl_instance_remove ( gnrc_rpl_instance_t * inst )

Remove a RPL instance with the pointer inst.

Parameters

[in] inst Pointer to the RPL instance to remove.

◆ gnrc_rpl_instance_remove_by_id()

bool gnrc_rpl_instance_remove_by_id ( uint8_t instance_id )

Remove a RPL instance with the id instance_id.

Parameters

[in] instance_id The instance id of the RPL instance to remove.

Returns: true, on success.; false, otherwise.

◆ gnrc_rpl_leaf_operation()

void gnrc_rpl_leaf_operation ( gnrc_rpl_dodag_t * dodag )

Operate as leaf.

Parameters

[in] dodag Pointer to the DODAG

◆ gnrc_rpl_local_repair()

void gnrc_rpl_local_repair ( gnrc_rpl_dodag_t * dodag )

Start a local repair.

Parameters

[in] dodag Pointer to the DODAG

◆ gnrc_rpl_parent_add_by_addr()

bool gnrc_rpl_parent_add_by_addr	(	gnrc_rpl_dodag_t *	dodag,
		ipv6_addr_t *	addr,
		gnrc_rpl_parent_t **	parent )

Add a new parent with the IPv6 address addr to the dodag.

Parameters

[in]	dodag	Pointer to the DODAG
[in]	addr	IPV6 address of the parent
[out]	parent	Pointer to an existing or new parent. Otherwise NULL.

Returns: true. if parent could be created.; false, if parent could not be created or exists already.

◆ gnrc_rpl_parent_remove()

bool gnrc_rpl_parent_remove ( gnrc_rpl_parent_t * parent )

Remove the parent from its DODAG.

Parameters

[in] parent Pointer to the parent.

Returns: true, on success.; false, otherwise.

◆ gnrc_rpl_parent_update()

void gnrc_rpl_parent_update	(	gnrc_rpl_dodag_t *	dodag,
		gnrc_rpl_parent_t *	parent )

Update a parent of the dodag.

Parameters

[in]	dodag	Pointer to the DODAG
[in]	parent	Pointer to the parent

◆ gnrc_rpl_router_operation()

void gnrc_rpl_router_operation ( gnrc_rpl_dodag_t * dodag )

Operate as router.

Parameters

[in] dodag Pointer to the DODAG