#include <SeProxyService.h>
The Class SeProxyService. This singleton is the entry point of the SE Proxy Service, its instance has to be called by a ticketing application in order to establish a link with a SE’s application.
◆ getInstance()
static SeProxyService& keyple::core::seproxy::SeProxyService::getInstance |
( |
| ) |
|
|
inlinestatic |
◆ getPlugin()
std::shared_ptr< ReaderPlugin > keyple::core::seproxy::SeProxyService::getPlugin |
( |
const std::string & |
name | ) |
|
Gets the plugin whose name is provided as an argument.
- Parameters
-
- Returns
- the plugin
- Exceptions
-
KeyplePluginNotFoundException | if the wanted plugin is not found |
◆ getPlugins()
const std::map< const std::string, std::shared_ptr< ReaderPlugin > > & keyple::core::seproxy::SeProxyService::getPlugins |
( |
| ) |
const |
Gets the plugins.
- Returns
- the plugin names and plugin instances map of interfaced reader’s plugins.
◆ getVersion()
std::string keyple::core::seproxy::SeProxyService::getVersion |
( |
| ) |
|
Gets the version API, (the version of the sdk).
- Returns
- the version
◆ isRegistered()
bool keyple::core::seproxy::SeProxyService::isRegistered |
( |
const std::string & |
pluginName | ) |
|
Check weither a plugin is already registered to the platform or not
- Parameters
-
pluginName | : name of the plugin to be checked |
- Returns
- true if a plugin with matching name has been registered
◆ registerPlugin()
std::shared_ptr< ReaderPlugin > keyple::core::seproxy::SeProxyService::registerPlugin |
( |
std::shared_ptr< PluginFactory > |
pluginFactory | ) |
|
Register a new plugin to be available in the platform if not registered yet
- Parameters
-
pluginFactory | : plugin factory to instantiate plugin to be added |
- Exceptions
-
KeyplePluginInstantiationException | if instantiation failed |
- Returns
- ReaderPlugin : registered reader plugin
◆ unregisterPlugin()
bool keyple::core::seproxy::SeProxyService::unregisterPlugin |
( |
const std::string & |
pluginName | ) |
|
Unregister plugin from platform
- Parameters
-
- Returns
- true if the plugin was successfully unregistered
The documentation for this class was generated from the following files: