Struct IAppInstall#

Inheritance Relationships#

Derived Type#

Struct Documentation#

struct IAppInstall#

Application installation interface.

Attention

This function is only available for the main application and part of the application config service.

Subclassed by CAppConfig

Public Functions

virtual bool Install(const sdv::u8string &ssInstallName, const sdv::sequence<SFileDesc> &seqFiles) = 0#

Make an installation onto the system.

Make an installation with from component modules and supporting files. At least one component module must be provided for this installation to be successful (component attribute flag must be set). Components are only installed, not activated.

Remark

The system needs to run in configuration mode.

Parameters:

  • ssInstallName – [in] Name of the installation. Must be unique to the system.

  • seqFiles – [in] Files belonging to the installation. This could be component modules as well as supporting files.

Returns:

Returns whether the installation was successful - installation name was unique and at least one loadable component was provided.

virtual bool Update(const sdv::u8string &ssInstallName, const sdv::sequence<SFileDesc> &seqFiles) = 0#

Update an installation.

Stops a component if the component is running, makes an update and if the component was running, starts the component again.

Todo:

: Currently limited to complex services only.

Remark

The system needs to run in configuration mode.

Parameters:

  • ssInstallName – [in] Name of the installation. Must be unique to the system.

  • seqFiles – [in] Files belonging to the installation. This could be component modules as well as supporting files.

Returns:

Returns whether the installation was successful - installation name was unique and at least one loadable component was provided.

virtual bool Uninstall(const sdv::u8string &ssInstallName) = 0#

Uninstall of a previous installation.

Stops a component if the component is running and removes the files and modules.

Todo:

: Currently limited to complex services only.

Remark

The system needs to run in configuration mode.

Parameters:

ssInstallName – [in] Installation name.

Returns:

Returns whether the uninstallation was successful.

virtual sdv::sequence<sdv::u8string> GetInstallations() const = 0#

Get a sequence of installations.

Returns:

The sequence with installations.

virtual sdv::sequence<SFileDesc> GetInstallationFiles(const sdv::u8string &ssInstallName) const = 0#

Get the installed files from the installation.

Parameters:

ssInstallName – [in] The installation to get the files for.

Returns:

Sequence containing the file structures without the binary file content.

boolean Install (in u8string ssInstallName, in sequence< SFileDesc > seqFiles)

Make an installation onto the system.

Make an installation with from component modules and supporting files. At least one component module must be provided for this installation to be successful (component attribute flag must be set). Components are only installed, not activated.

Remark

The system needs to run in configuration mode.

Parameters:

  • ssInstallName – [in] Name of the installation. Must be unique to the system.

  • seqFiles – [in] Files belonging to the installation. This could be component modules as well as supporting files.

Returns:

Returns whether the installation was successful - installation name was unique and at least one loadable component was provided.

boolean Update (in u8string ssInstallName, in sequence< SFileDesc > seqFiles)

Update an installation.

Stops a component if the component is running, makes an update and if the component was running, starts the component again.

Todo:

: Currently limited to complex services only.

Remark

The system needs to run in configuration mode.

Parameters:

  • ssInstallName – [in] Name of the installation. Must be unique to the system.

  • seqFiles – [in] Files belonging to the installation. This could be component modules as well as supporting files.

Returns:

Returns whether the installation was successful - installation name was unique and at least one loadable component was provided.

boolean Uninstall (in u8string ssInstallName)

Uninstall of a previous installation.

Stops a component if the component is running and removes the files and modules.

Todo:

: Currently limited to complex services only.

Remark

The system needs to run in configuration mode.

Parameters:

ssInstallName – [in] Installation name.

Returns:

Returns whether the uninstallation was successful.

sequence<u8string> GetInstallations() const

Get a sequence of installations.

Returns:

The sequence with installations.

sequence< SFileDesc > GetInstallationFiles (in u8string ssInstallName) const

Get the installed files from the installation.

Parameters:

ssInstallName – [in] The installation to get the files for.

Returns:

Sequence containing the file structures without the binary file content.

Public Static Attributes

static ::sdv::interface_id _id = 0x85324A06C3821218#

Interface ID.