Manages the extensions of the Switchboard SDK.
More...
#include <ExtensionManager.hpp>
|
| void | registerExtension (std::shared_ptr< Extension > extension) |
| | Registers an extension.
|
| Result< void > | initializeExtension (const std::string &extensionName, const SBAnyMap &config) |
| | Initializes an extension with the given configuration.
|
| Result< void > | deinitializeExtension (const std::string &extensionName) |
| | Deinitializes an extension.
|
|
void | deinitializeAllExtensions () |
| | Deinitializes all registered extensions.
|
| std::vector< std::string > | getExtensionNames () const |
| | Returns the names of all currently registered (loaded) extensions, both compiled-in and dynamically loaded, in sorted order.
|
Manages the extensions of the Switchboard SDK.
◆ deinitializeExtension()
| Result< void > switchboard::ExtensionManager::deinitializeExtension |
( |
const std::string & | extensionName | ) |
|
Deinitializes an extension.
- Parameters
-
| extensionName | The name of the extension to deinitialize. |
- Returns
- Result<void> Success if the extension was deinitialized, error otherwise.
◆ getExtensionNames()
| std::vector< std::string > switchboard::ExtensionManager::getExtensionNames |
( |
| ) |
const |
Returns the names of all currently registered (loaded) extensions, both compiled-in and dynamically loaded, in sorted order.
- Returns
- The registered extension names.
◆ initializeExtension()
| Result< void > switchboard::ExtensionManager::initializeExtension |
( |
const std::string & | extensionName, |
|
|
const SBAnyMap & | config ) |
Initializes an extension with the given configuration.
- Parameters
-
| extensionName | The name of the extension to initialize. |
| config | The configuration parameters for the extension. |
- Returns
- Result<void> Success if the extension was initialized, error otherwise.
◆ registerExtension()
| void switchboard::ExtensionManager::registerExtension |
( |
std::shared_ptr< Extension > | extension | ) |
|
Registers an extension.
A dynamically loaded extension is registered under DYNAMIC_EXTENSION_NAME_PREFIX + its name. Its own getName() is unchanged, so the two differ for the rest of its life.
- Parameters
-
| extension | The extension to register. |
The documentation for this class was generated from the following file: