0.01.00
netdata.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, 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 
35 #ifndef OPENTHREAD_NETDATA_H_
36 #define OPENTHREAD_NETDATA_H_
37 
38 #include <openthread/types.h>
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
60 OTAPI otError OTCALL otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData,
61  uint8_t *aDataLength);
62 
76  otBorderRouterConfig *aConfig);
77 
91  otExternalRouteConfig *aConfig);
92 
100 OTAPI uint8_t OTCALL otNetDataGetVersion(otInstance *aInstance);
101 
110 
116 #ifdef __cplusplus
117 } // extern "C"
118 #endif
119 
120 #endif // OPENTHREAD_NETDATA_H_
OTAPI uint8_t OTCALL otNetDataGetStableVersion(otInstance *aInstance)
Get the Stable Network Data Version.
Definition: netdata_api.cpp:85
OTAPI otError OTCALL otNetDataGet(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
This method provides a full or stable copy of the Leader&#39;s Thread Network Data.
Definition: netdata_api.cpp:42
This type represents all the static / global variables used by OpenThread allocated in one place...
Definition: openthread-instance.h:59
This file defines the types and structures used in the OpenThread library API.
This structure represents an External Route configuration.
Definition: types.h:771
uint32_t otNetworkDataIterator
Used to iterate through Network Data information.
Definition: types.h:710
OTAPI otError OTCALL otNetDataGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
This function gets the next On Mesh Prefix in the partition&#39;s Network Data.
Definition: netdata_api.cpp:54
otError otNetDataGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
This function gets the next external route in the partition&#39;s Network Data.
Definition: netdata_api.cpp:67
This structure represents a Border Router configuration.
Definition: types.h:715
#define OTCALL
Compiler-specific modifier to export functions in a DLL.
Definition: toolchain.h:217
#define OTAPI
Compiler-specific modifier for public API declarations.
Definition: toolchain.h:216
OTAPI uint8_t OTCALL otNetDataGetVersion(otInstance *aInstance)
Get the Network Data Version.
Definition: netdata_api.cpp:80
otError
This enumeration represents error codes used throughout OpenThread.
Definition: types.h:107