1 /*
2  *  Copyright (c) 2016-2017, The OpenThread Authors.
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 are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  * @brief
32  *  This file defines the OpenThread Operational Dataset API (FTD only).
33  */
34 
35 #ifndef OPENTHREAD_DATASET_FTD_H_
36 #define OPENTHREAD_DATASET_FTD_H_
37 
38 #include <openthread/dataset.h>
39 #include <openthread/ip6.h>
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /**
46  * @addtogroup api-operational-dataset
47  *
48  * @{
49  *
50  */
51 
52 /**
53  * This method creates a new Operational Dataset to use when forming a new network.
54  *
55  * @param[in]  aInstance  A pointer to an OpenThread instance.
56  * @param[out] aDataset   The Operational Dataset.
57  *
58  * @retval OT_ERROR_NONE    Successfully created a new Operational Dataset.
59  * @retval OT_ERROR_FAILED  Failed to generate random values for new parameters.
60  *
61  */
62 otError otDatasetCreateNewNetwork(otInstance *aInstance, otOperationalDataset *aDataset);
63 
64 /**
65  * Get minimal delay timer.
66  *
67  * @param[in]  aInstance A pointer to an OpenThread instance.
68  *
69  * @retval the value of minimal delay timer (in ms).
70  *
71  */
72 uint32_t otDatasetGetDelayTimerMinimal(otInstance *aInstance);
73 
74 /**
75  * Set minimal delay timer.
76  *
77  * @note This API is reserved for testing and demo purposes only. Changing settings with
78  * this API will render a production application non-compliant with the Thread Specification.
79  *
80  * @param[in]  aInstance           A pointer to an OpenThread instance.
81  * @param[in]  aDelayTimerMinimal  The value of minimal delay timer (in ms).
82  *
83  * @retval  OT_ERROR_NONE          Successfully set minimal delay timer.
84  * @retval  OT_ERROR_INVALID_ARGS  If @p aDelayTimerMinimal is not valid.
85  *
86  */
87 otError otDatasetSetDelayTimerMinimal(otInstance *aInstance, uint32_t aDelayTimerMinimal);
88 
89 /**
90  * @}
91  *
92  */
93 
94 #ifdef __cplusplus
95 } // extern "C"
96 #endif
97 
98 #endif // OPENTHREAD_DATASET_FTD_H_
99