0.01.00
openthread.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_H_
36 #define OPENTHREAD_H_
37 
38 #include <openthread/crypto.h>
39 #include <openthread/dataset.h>
40 #include <openthread/instance.h>
41 #include <openthread/ip6.h>
42 #include <openthread/link.h>
43 #include <openthread/message.h>
44 #include <openthread/netdata.h>
45 #include <openthread/tasklet.h>
46 #include <openthread/thread.h>
47 #include <openthread/types.h>
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
158 OTAPI const char *OTCALL otGetVersionString(void);
159 
168 OTAPI const char *OTCALL otThreadErrorToString(otError aError);
169 
170 #ifdef __cplusplus
171 } // extern "C"
172 #endif
173 
174 #endif // OPENTHREAD_H_
OTAPI const char *OTCALL otGetVersionString(void)
Get the OpenThread version string.
Definition: thread_api.cpp:361
This file defines the types and structures used in the OpenThread library API.
This file defines the OpenThread IPv6 API.
This file defines the OpenThread crypto C APIs.
This file defines the top-level OpenThread APIs related to message buffer and queues.
This file defines the OpenThread Thread API (for both FTD and MTD).
This file defines the OpenThread Instance API.
This file defines the OpenThread API for Tasklets.
OTAPI const char *OTCALL otThreadErrorToString(otError aError)
This function converts an otError enum into a string.
Definition: logging.cpp:272
This file defines the OpenThread Network Data API.
#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
This file defines the OpenThread Operational Dataset API (for both FTD and MTD).
otError
This enumeration represents error codes used throughout OpenThread.
Definition: types.h:107