Keyple C++  0.9.0
Keyple, an Open Source SDK for Ticketing
Public Member Functions | Static Public Member Functions | List of all members
keyple::core::seproxy::SeProxyService Class Referencefinal

#include <SeProxyService.h>

Public Member Functions

std::shared_ptr< ReaderPluginregisterPlugin (std::shared_ptr< PluginFactory > pluginFactory)
 
bool unregisterPlugin (const std::string &pluginName)
 
bool isRegistered (const std::string &pluginName)
 
const std::map< const std::string, std::shared_ptr< ReaderPlugin > > & getPlugins () const
 
std::shared_ptr< ReaderPlugingetPlugin (const std::string &name)
 
std::string getVersion ()
 

Static Public Member Functions

static SeProxyServicegetInstance ()
 

Detailed Description

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.

Member Function Documentation

◆ getInstance()

static SeProxyService& keyple::core::seproxy::SeProxyService::getInstance ( )
inlinestatic

Gets the single instance of SeProxyService.

Returns
single instance of SeProxyService

◆ 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
namethe plugin name
Returns
the plugin
Exceptions
KeyplePluginNotFoundExceptionif 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
KeyplePluginInstantiationExceptionif instantiation failed
Returns
ReaderPlugin : registered reader plugin

◆ unregisterPlugin()

bool keyple::core::seproxy::SeProxyService::unregisterPlugin ( const std::string &  pluginName)

Unregister plugin from platform

Parameters
pluginName: plugin name
Returns
true if the plugin was successfully unregistered

The documentation for this class was generated from the following files: