0.01.00
openthread-single-instance.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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 
35 #ifndef SINGLE_OPENTHREAD_INSTANCE_H_
36 #define SINGLE_OPENTHREAD_INSTANCE_H_
37 
38 #include "openthread-core-config.h"
39 
40 #include <openthread/types.h>
41 
42 
43 #if !OPENTHREAD_ENABLE_MULTIPLE_INSTANCES
44 
45 namespace ot {
46 
47 class ThreadNetif;
48 class MeshForwarder;
49 class TaskletScheduler;
50 namespace Ip6 { class Ip6; }
51 
52 } // namespace ot
53 
61 otInstance *otGetInstance(void);
62 
69 ot::ThreadNetif &otGetThreadNetif(void);
70 
77 ot::MeshForwarder &otGetMeshForwarder(void);
78 
85 ot::TaskletScheduler &otGetTaskletScheduler(void);
86 
93 ot::Ip6::Ip6 &otGetIp6(void);
94 
95 #endif // #if !OPENTHREAD_ENABLE_MULTIPLE_INSTANCES
96 
97 #endif // SINGLE_OPENTHREAD_INSTANCE_H_
otInstance
This type represents all the static / global variables used by OpenThread allocated in one place...
Definition: openthread-instance.h:59
ot
Definition: cli.cpp:90
types.h
This file defines the types and structures used in the OpenThread library API.
otGetMeshForwarder
ot::MeshForwarder & otGetMeshForwarder(void)
This function returns a reference to the single MeshForwarder instance.
Definition: instance_api.cpp:62
ot::MeshForwarder
This class implements mesh forwarding within Thread.
Definition: mesh_forwarder.hpp:74
otGetIp6
ot::Ip6::Ip6 & otGetIp6(void)
This function returns a reference to the single Ip6 instance.
Definition: instance_api.cpp:72
ot::Ip6::Ip6
This class implements the core IPv6 message processing.
Definition: ip6.hpp:101
otGetTaskletScheduler
ot::TaskletScheduler & otGetTaskletScheduler(void)
This function returns a reference to the single TaskletShceduler instance.
Definition: instance_api.cpp:67
otGetThreadNetif
ot::ThreadNetif & otGetThreadNetif(void)
This function returns a reference to the single thread network interface instance.
Definition: instance_api.cpp:57
ot::TaskletScheduler
This class implements the tasklet scheduler.
Definition: tasklet.hpp:104
ot::ThreadNetif
Definition: thread_netif.hpp:98
otGetInstance
otInstance * otGetInstance(void)
This function returns a pointer to the single otInstance (if initialized and ready).
Definition: instance_api.cpp:52
openthread-core-config.h
This file includes compile-time configuration constants for OpenThread.