-
Notifications
You must be signed in to change notification settings - Fork 239
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[controller] add Thread controller interface for unified APIs
- Loading branch information
Showing
3 changed files
with
84 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
/* | ||
* Copyright (c) 2024, 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 of Thead Controller Interface. | ||
*/ | ||
|
||
#ifndef OTBR_AGENT_THREAD_CONTROLLER_HPP_ | ||
#define OTBR_AGENT_THREAD_CONTROLLER_HPP_ | ||
|
||
#include <functional> | ||
|
||
#include <openthread/error.h> | ||
#include <openthread/thread.h> | ||
|
||
#include "lib/spinel/coprocessor_type.h" | ||
|
||
#include "common/logging.hpp" | ||
|
||
namespace otbr { | ||
namespace Ncp { | ||
|
||
/** | ||
* This class is an interface which provides a set of async APIs to control the | ||
* Thread network. | ||
* | ||
* The APIs are unified for both NCP and RCP cases. | ||
* | ||
*/ | ||
class ThreadController | ||
{ | ||
public: | ||
using DeviceRoleHandler = std::function<void(otError, otDeviceRole)>; | ||
|
||
/** | ||
* This method gets the device role and returns the role through the handler. | ||
* | ||
* @param[in] aHandler A handler to return the role. | ||
* | ||
*/ | ||
virtual void GetDeviceRole(DeviceRoleHandler aHandler) = 0; | ||
}; | ||
|
||
} // namespace Ncp | ||
} // namespace otbr | ||
|
||
#endif // OTBR_AGENT_THREAD_CONTROLLER_HPP_ |