Contiki-NG
rpl-dag-root.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2012-2014, Thingsquare, http://www.thingsquare.com/.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of the copyright holder nor the names of its
14 * contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 */
31
32#ifndef RPL_DAG_ROOT_H_
33#define RPL_DAG_ROOT_H_
34
35/**
36* \addtogroup rpl-lite
37* @{
38*
39* \file
40* DAG root utility functions for RPL.
41*/
42
43/********** Public functions **********/
44
45/**
46 * Set a prefix in case the node is later set as dag root.
47 *
48 * \param prefix The prefix. If NULL, uip_ds6_default_prefix() is used instead
49 * \param iid The IID. If NULL, it will be built from uip_ds6_set_addr_iid.
50*/
51void rpl_dag_root_set_prefix(uip_ipaddr_t *prefix, uip_ipaddr_t *iid);
52
53/**
54 * Set the node as root and start a DAG
55 *
56 * \return 0 in case of success, -1 otherwise
57*/
58int rpl_dag_root_start(void);
59
60/**
61 * Tells whether we are DAG root or not
62 *
63 * \return 1 if we are dag root, 0 otherwise
64*/
65int rpl_dag_root_is_root(void);
66/**
67 * Prints a summary of all routing links
68 *
69 * \param str A descriptive text on the caller
70*/
71void rpl_dag_root_print_links(const char *str);
72
73 /** @} */
74
75#endif /* RPL_DAG_ROOT_H_ */
void rpl_dag_root_print_links(const char *str)
Prints a summary of all routing links.
Definition: rpl-dag-root.c:54
int rpl_dag_root_start(void)
Set the node as root and start a DAG.
Definition: rpl-dag-root.c:100
int rpl_dag_root_is_root(void)
Tells whether we are DAG root or not.
Definition: rpl-dag-root.c:152
void rpl_dag_root_set_prefix(uip_ipaddr_t *prefix, uip_ipaddr_t *iid)
Set a prefix in case the node is later set as dag root.
Definition: rpl-dag-root.c:89