Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/openthread/openthread/src/core/instance/extension.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
* Copyright (c) 2018, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file includes definitions for OpenThread vendor extension hooks.
*/
#ifndef EXTENSION_HPP_
#define EXTENSION_HPP_
#include "openthread-core-config.h"
#if OPENTHREAD_ENABLE_VENDOR_EXTENSION
#include "common/locator.hpp"
#include "common/non_copyable.hpp"
#include "common/notifier.hpp"
namespace ot {
namespace Ncp {
class NcpBase;
}
namespace Extension {
/**
* @addtogroup core-extension
*
* @brief
* This module includes definitions for OpenThread vendor extension hooks.
*
* @{
*/
/**
* Defines the base class for an OpenThread vendor Extension object.
*
* Is used by OpenThread core to interact with the extension module. Methods in this class are expected
* to be implemented by the vendor extension module.
*
* Support for vendor extension can be enabled using `OPENTHREAD_ENABLE_VENDOR_EXTENSION` configuration option.
*/
class ExtensionBase : public InstanceLocator, private NonCopyable
{
public:
/**
* Initializes and gets a vendor extension instance.
*
* @param[in] aInstance A reference to the OpenThread instance.
*
* @note When this method is called, the @p aInstance itself may not yet be fully initialized. The method
* `SignalInstanceInit()` is called when `aInstance` is fully initialized.
*
* @returns A reference to the object.
*/
static ExtensionBase &Init(Instance &aInstance);
/**
* Notifies the extension object that OpenThread instance has been initialized.
*/
void SignalInstanceInit(void);
/**
* Notifies the extension object that NCP instance has been initialized.
*
* @param[in] aNcpInstance A reference to the NCP object.
*/
void SignalNcpInit(Ncp::NcpBase &aNcpInstance);
/**
* Notifies the extension object of events from OpenThread `Notifier`.
*
* @param[in] aEvents The list of events emitted by `Notifier`.
*/
void HandleNotifierEvents(Events aEvents);
protected:
/**
* Initializes the object.
*
* @param[in] aInstance A reference to the OpenThread instance.
*/
explicit ExtensionBase(Instance &aInstance)
: InstanceLocator(aInstance)
, mIsInitialized(true)
{
}
bool mIsInitialized;
};
/**
* @}
*/
} // namespace Extension
} // namespace ot
#endif // #if OPENTHREAD_ENABLE_VENDOR_EXTENSION
#endif // EXTENSION_HPP_
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.