This services represents the RSC-Interface for the AppManager service component More...

#include <IAppManagerService.hpp>

Inheritance diagram for Arp::Services::AppManager::Services::IAppManagerService:

Public Types
using	Ptr = std::shared_ptr< IAppManagerService >

Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IAppManagerService (void)=default
	Constructs an IAppManagerService instance.

virtual AppManagerServiceError	ListInstalledApps (std::vector< AppInfo > &list)=0
	Lists all installed PLCnext applications by their identifier. More...

virtual AppManagerServiceError	InstallApp (const RscString< 512 > &filename, const RscString< 256 > &appIdentifier="")=0
	The method InstallApp installs an app from an app container that is located on the controller and is transferred as the path of the method. This method can also be used to perform an update for an app that has already been installed. More...

virtual AppManagerServiceError	UnInstallApp (const RscString< 256 > &appIdentifier)=0
	Uninstall an app that is specified by the app identifier. More...

virtual AppManagerServiceError	StartApp (const RscString< 256 > &appIdentifier)=0
	Starts the PLCnext application that is specified by the app identifier. The app can also start asynchronously, which can be detected via the AppStatus Arp.Services.AppManager.Services.AppStatus.Starting. The app is considered fully started only when the status is Arp.Services.AppManager.Services.AppStatus.Started. More...

virtual AppManagerServiceError	StopApp (const RscString< 256 > &appIdentifier)=0
	Stops the PLCnext application that is specified by the app identifier. The app can also stop asynchronously, which can be detected via the AppStatus Arp.Services.AppManager.Services.AppStatus.Stopping. The app is considered fully stopped only when the status is Arp.Services.AppManager.Services.AppStatus.Stopped. More...

virtual AppManagerServiceError	GetAppStatus (const RscString< 256 > &appIdentifier, AppStatus &status)=0
	Reads out the app status of an app that is specified by the app identifier. More...

virtual AppManagerServiceError	GetAppsStatus (const std::vector< RscString< 256 > > &appIdentifiers, std::vector< AppStatus > &status)=0
	Reads out the application status of the applications that are specified by the app identifiers. If an identifier no longer exists, an error code is returned and the status for that identifier is Arp.Services.AppManager.Services.AppStatus.None. More...

virtual AppManagerServiceError	GetAppInfo (const RscString< 256 > &appIdentifier, AppInfo &appInfo)=0
	Reads out the app infos of an app that is specified by the app identifier. More...

virtual AppManagerServiceError	GetExtendedAppInfo (const RscString< 256 > &appIdentifier, const RscString< 256 > &extendedInfoKey, RscVariant< 256 > &data)=0
	Retrieves extended information for the specified application based on the provided key. More...

virtual AppManagerStatus	GetAppManagerStatus ()=0
	Reads out the status of the app manager. More...

virtual AppManagerServiceError	EnableInstallationMode (const RscString< 256 > &callerName)=0
	Enabled the installation mode of the AppManager using the specified user name. Only with active installation mode it is possible to call following Methods of IAppManagerService: More...

virtual AppManagerServiceError	DisableInstallationMode (boolean autoRestartDisabled=false)=0
	Disables the installation mode of the appManager If a reboot is required by previous installations, starts or stops the reboot is performed right after this returns. More...

Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.

	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...

	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...

IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...

IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...

virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)

Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

This services represents the RSC-Interface for the AppManager service component

This service provides methods for the PLCnext application management.

This service is defined in library Arp.Services.AppManager.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

◆ DisableInstallationMode()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::DisableInstallationMode ( boolean autoRestartDisabled = false )

pure virtual

Disables the installation mode of the appManager If a reboot is required by previous installations, starts or stops the reboot is performed right after this returns.

Parameters

autoRestartDisabled Disables the auto-restart function.

Returns

AppManagerServiceError with:

AppManagerErrorCode::None: if no reboot is required and performed AppManagerErrorCode::RestartScheduled: if a reboot will be performed AppManagerErrorCode::InstallationModeInactive if the installation mode was not activated

◆ EnableInstallationMode()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::EnableInstallationMode ( const RscString< 256 > & callerName )

pure virtual

Enabled the installation mode of the AppManager using the specified user name. Only with active installation mode it is possible to call following Methods of IAppManagerService:

InstallApp Arp.Services.AppManager.Services.IAppManagerService.InstallApp. UnInstallApp Arp.Services.AppManager.Services.IAppManagerService.UnInstallApp. StartApp Arp.Services.AppManager.Services.IAppManagerService.StartApp. StopApp Arp.Services.AppManager.Services.IAppManagerService.StopApp.

If these methods are called with installation mode disabled they will return errorCode InstallationModeInactive

Parameters

callerName The name of the user enabling the installation mode.

Returns: AppManagerErrorCode::None: if no the installation mode could be activated (mode is not acquired by another component). AppManagerErrorCode::InstallationModeActive if the installation mode is already activated.

◆ GetAppInfo()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::GetAppInfo	(	const RscString< 256 > &	appIdentifier,
		AppInfo &	appInfo
	)

pure virtual

Reads out the app infos of an app that is specified by the app identifier.

Parameters

appIdentifier	The app identifier.
appInfo	After the method call, contains the AppInfo structure AppInfo Arp.Services.AppManager.Services.AppInfo for the app that is specified by the app identifier.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ GetAppManagerStatus()

virtual AppManagerStatus Arp::Services::AppManager::Services::IAppManagerService::GetAppManagerStatus ( )

pure virtual

Reads out the status of the app manager.

Returns: AppManagerStatus Arp.Services.AppManager.Services.AppManagerStatus.

◆ GetAppsStatus()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::GetAppsStatus	(	const std::vector< RscString< 256 > > &	appIdentifiers,
		std::vector< AppStatus > &	status
	)

pure virtual

Reads out the application status of the applications that are specified by the app identifiers. If an identifier no longer exists, an error code is returned and the status for that identifier is Arp.Services.AppManager.Services.AppStatus.None.

Parameters

appIdentifiers	The app identifiers.
status	Status of the applications with the given app identifiers Arp.Services.AppManager.Services.AppStatus.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ GetAppStatus()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::GetAppStatus	(	const RscString< 256 > &	appIdentifier,
		AppStatus &	status
	)

pure virtual

Reads out the app status of an app that is specified by the app identifier.

Parameters

appIdentifier	The app identifier.
status	Status of the app with the given app identifier Arp.Services.AppManager.Services.AppStatus.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ GetExtendedAppInfo()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::GetExtendedAppInfo	(	const RscString< 256 > &	appIdentifier,
		const RscString< 256 > &	extendedInfoKey,
		RscVariant< 256 > &	data
	)

pure virtual

Retrieves extended information for the specified application based on the provided key.

Parameters

appIdentifier	The identifier of the application for which to retrieve information.
extendedInfoKey	The key specifying the type of extended information to retrieve.
data	The output parameter that will contain the retrieved data if successful.

Returns: Returns an AppManagerServiceError indicating the success or failure of the operation.

◆ InstallApp()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::InstallApp	(	const RscString< 512 > &	filename,
		const RscString< 256 > &	appIdentifier = `""`
	)

pure virtual

The method InstallApp installs an app from an app container that is located on the controller and is transferred as the path of the method. This method can also be used to perform an update for an app that has already been installed.

Parameters

filename	The path to the app container on the controller.
appIdentifier	The app identifier. If the optional parameter is specified, it is compared with the app identifier in the app container. If they do not match, an error code is set.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ ListInstalledApps()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::ListInstalledApps ( std::vector< AppInfo > & list )

pure virtual

Lists all installed PLCnext applications by their identifier.

Parameters

list	After the method call, contains a list of the AppInfo structure Arp.Services.AppManager.Services.AppInfo.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ StartApp()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::StartApp ( const RscString< 256 > & appIdentifier )

pure virtual

Starts the PLCnext application that is specified by the app identifier. The app can also start asynchronously, which can be detected via the AppStatus Arp.Services.AppManager.Services.AppStatus.Starting. The app is considered fully started only when the status is Arp.Services.AppManager.Services.AppStatus.Started.

Parameters

appIdentifier The app identifier.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ StopApp()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::StopApp ( const RscString< 256 > & appIdentifier )

pure virtual

Stops the PLCnext application that is specified by the app identifier. The app can also stop asynchronously, which can be detected via the AppStatus Arp.Services.AppManager.Services.AppStatus.Stopping. The app is considered fully stopped only when the status is Arp.Services.AppManager.Services.AppStatus.Stopped.

Parameters

appIdentifier The app identifier.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

◆ UnInstallApp()

virtual AppManagerServiceError Arp::Services::AppManager::Services::IAppManagerService::UnInstallApp ( const RscString< 256 > & appIdentifier )

pure virtual

Uninstall an app that is specified by the app identifier.

Parameters

appIdentifier The app identifier.

Returns

AppManagerServiceError with:

AppManagerServiceError::None: No error has occurred. Otherwise: An Error code with error Text.

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

Arp/Services/AppManager/Services/IAppManagerService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ DisableInstallationMode()

◆ EnableInstallationMode()

◆ GetAppInfo()

◆ GetAppManagerStatus()

◆ GetAppsStatus()

◆ GetAppStatus()

◆ GetExtendedAppInfo()

◆ InstallApp()

◆ ListInstalledApps()

◆ StartApp()

◆ StopApp()

◆ UnInstallApp()